Conversation
Defined in: sdks/js/node-sdk/dist/index.d.ts:469
Represents a conversation
This class is not intended to be initialized directly.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”ContentTypes
Section titled “ContentTypes”ContentTypes = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Conversation<
ContentTypes>(client,codecRegistry,conversation):Conversation<ContentTypes>
Defined in: sdks/js/node-sdk/dist/index.d.ts:478
Creates a new conversation instance
Parameters
Section titled “Parameters”client
Section titled “client”Client<ContentTypes>
The client instance managing the conversation
codecRegistry
Section titled “codecRegistry”The codec registry instance
conversation
Section titled “conversation”Conversation
The underlying conversation instance
Returns
Section titled “Returns”Conversation<ContentTypes>
Accessors
Section titled “Accessors”addedByInboxId
Section titled “addedByInboxId”Get Signature
Section titled “Get Signature”get addedByInboxId():
string
Defined in: sdks/js/node-sdk/dist/index.d.ts:494
Gets the inbox ID that added this client’s inbox to the conversation
Returns
Section titled “Returns”string
createdAt
Section titled “createdAt”Get Signature
Section titled “Get Signature”get createdAt():
Date
Defined in: sdks/js/node-sdk/dist/index.d.ts:502
Gets the date when the conversation was created
Returns
Section titled “Returns”Date
createdAtNs
Section titled “createdAtNs”Get Signature
Section titled “Get Signature”get createdAtNs():
bigint
Defined in: sdks/js/node-sdk/dist/index.d.ts:498
Gets the timestamp when the conversation was created in nanoseconds
Returns
Section titled “Returns”bigint
Get Signature
Section titled “Get Signature”get id():
string
Defined in: sdks/js/node-sdk/dist/index.d.ts:482
Gets the unique identifier for this conversation
Returns
Section titled “Returns”string
isActive
Section titled “isActive”Get Signature
Section titled “Get Signature”get isActive():
boolean
Defined in: sdks/js/node-sdk/dist/index.d.ts:486
Gets whether this conversation is currently active
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get topic():
string
Defined in: sdks/js/node-sdk/dist/index.d.ts:503
Returns
Section titled “Returns”string
Methods
Section titled “Methods”beginningDeliveryCursor()
Section titled “beginningDeliveryCursor()”beginningDeliveryCursor():
DeliveryCursor
Defined in: sdks/js/node-sdk/dist/index.d.ts:545
Returns
Section titled “Returns”consentState()
Section titled “consentState()”consentState():
ConsentState
Defined in: sdks/js/node-sdk/dist/index.d.ts:691
Gets the consent state for this conversation
Returns
Section titled “Returns”countMessages()
Section titled “countMessages()”countMessages(
options?):Promise<number>
Defined in: sdks/js/node-sdk/dist/index.d.ts:681
Counts messages in this conversation
Parameters
Section titled “Parameters”options?
Section titled “options?”Omit<ListMessagesOptions, "limit" | "direction">
Optional filtering options
Returns
Section titled “Returns”Promise<number>
Promise that resolves with the count of messages
debugInfo()
Section titled “debugInfo()”debugInfo():
Promise<ConversationDebugInfo>
Defined in: sdks/js/node-sdk/dist/index.d.ts:729
Retrieves information for this conversation to help with debugging
Returns
Section titled “Returns”Promise<ConversationDebugInfo>
The debug information for this conversation
hmacKeys()
Section titled “hmacKeys()”hmacKeys():
Record<string,HmacKey[]>
Defined in: sdks/js/node-sdk/dist/index.d.ts:510
Gets HMAC keys for this conversation
Returns
Section titled “Returns”Record<string, HmacKey[]>
The HMAC keys for this conversation
isMessageDisappearingEnabled()
Section titled “isMessageDisappearingEnabled()”isMessageDisappearingEnabled():
boolean
Defined in: sdks/js/node-sdk/dist/index.d.ts:723
Checks if message disappearing is enabled for this conversation
Returns
Section titled “Returns”boolean
Whether message disappearing is enabled
lastMessage()
Section titled “lastMessage()”lastMessage():
Promise<DecodedMessage<ContentTypes> |undefined>
Defined in: sdks/js/node-sdk/dist/index.d.ts:687
Gets the last message in this conversation
Returns
Section titled “Returns”Promise<DecodedMessage<ContentTypes> | undefined>
Promise that resolves with the last message or undefined if none exists
lastReadTimes()
Section titled “lastReadTimes()”lastReadTimes():
Promise<Record<string,number>>
Defined in: sdks/js/node-sdk/dist/index.d.ts:736
Retrieves the last read times for this conversation
Returns
Section titled “Returns”Promise<Record<string, number>>
A map keyed by inbox ID with the last read timestamp (nanoseconds since epoch)
members()
Section titled “members()”members():
Promise<GroupMember[]>
Defined in: sdks/js/node-sdk/dist/index.d.ts:525
Gets the members of this conversation
Returns
Section titled “Returns”Promise<GroupMember[]>
Promise that resolves with the conversation members
messageDisappearingSettings()
Section titled “messageDisappearingSettings()”messageDisappearingSettings():
MessageDisappearingSettings|undefined
Defined in: sdks/js/node-sdk/dist/index.d.ts:703
Gets the message disappearing settings for this conversation
Returns
Section titled “Returns”MessageDisappearingSettings | undefined
The current message disappearing settings or undefined if not set
messageHistorySnapshot()
Section titled “messageHistorySnapshot()”messageHistorySnapshot(
limit):MessageHistorySnapshot
Defined in: sdks/js/node-sdk/dist/index.d.ts:544
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”messages()
Section titled “messages()”messages(
options?):Promise<DecodedMessage<ContentTypes>[]>
Defined in: sdks/js/node-sdk/dist/index.d.ts:674
Lists messages in this conversation
Parameters
Section titled “Parameters”options?
Section titled “options?”Optional filtering and pagination options
Returns
Section titled “Returns”Promise<DecodedMessage<ContentTypes>[]>
Promise that resolves with an array of decoded messages
metadata()
Section titled “metadata()”metadata():
Promise<{conversationType:ConversationType;creatorInboxId:string; }>
Defined in: sdks/js/node-sdk/dist/index.d.ts:516
Gets the metadata for this conversation
Returns
Section titled “Returns”Promise<{ conversationType: ConversationType; creatorInboxId: string; }>
Promise that resolves with the conversation metadata
notificationsEnabled()
Section titled “notificationsEnabled()”notificationsEnabled():
Promise<boolean>
Defined in: sdks/js/node-sdk/dist/index.d.ts:490
Read the effective notification value for this conversation.
Returns
Section titled “Returns”Promise<boolean>
pausedForVersion()
Section titled “pausedForVersion()”pausedForVersion():
string|undefined
Defined in: sdks/js/node-sdk/dist/index.d.ts:504
Returns
Section titled “Returns”string | undefined
processStreamedMessage()
Section titled “processStreamedMessage()”processStreamedMessage(
envelopeBytes):Promise<Message[]>
Defined in: sdks/js/node-sdk/dist/index.d.ts:552
Decodes, decrypts, and persists a raw envelope from a group message stream.
Parameters
Section titled “Parameters”envelopeBytes
Section titled “envelopeBytes”Uint8Array
Raw protobuf-encoded envelope bytes from the stream
Returns
Section titled “Returns”Promise<Message[]>
The processed and stored messages
publishMessages()
Section titled “publishMessages()”publishMessages():
Promise<void>
Defined in: sdks/js/node-sdk/dist/index.d.ts:558
Publishes pending messages that were sent optimistically
Returns
Section titled “Returns”Promise<void>
Promise that resolves when publishing is complete
removeMessageDisappearingSettings()
Section titled “removeMessageDisappearingSettings()”removeMessageDisappearingSettings():
Promise<void>
Defined in: sdks/js/node-sdk/dist/index.d.ts:717
Removes message disappearing settings from this conversation
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the settings are removed
send()
Section titled “send()”send(
encodedContent,sendOptions?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:572
Sends a message with configurable delivery behavior
Parameters
Section titled “Parameters”encodedContent
Section titled “encodedContent”EncodedContent
The encoded content to send
sendOptions?
Section titled “sendOptions?”Options for sending the message
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendActions()
Section titled “sendActions()”sendActions(
actions,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:635
Sends a actions message
Parameters
Section titled “Parameters”actions
Section titled “actions”The actions to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendAttachment()
Section titled “sendAttachment()”sendAttachment(
attachment,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:651
Sends an attachment message
Parameters
Section titled “Parameters”attachment
Section titled “attachment”The attachment to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendIntent()
Section titled “sendIntent()”sendIntent(
intent,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:643
Sends a intent message
Parameters
Section titled “Parameters”intent
Section titled “intent”The intent to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendMarkdown()
Section titled “sendMarkdown()”sendMarkdown(
markdown,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:588
Sends a markdown message
Parameters
Section titled “Parameters”markdown
Section titled “markdown”string
The markdown to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendMultiRemoteAttachment()
Section titled “sendMultiRemoteAttachment()”sendMultiRemoteAttachment(
multiRemoteAttachment,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:659
Sends a multi remote attachment message
Parameters
Section titled “Parameters”multiRemoteAttachment
Section titled “multiRemoteAttachment”The multi remote attachment to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendReaction()
Section titled “sendReaction()”sendReaction(
reaction,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:596
Sends a reaction message
Parameters
Section titled “Parameters”reaction
Section titled “reaction”The reaction to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendReadReceipt()
Section titled “sendReadReceipt()”sendReadReceipt(
opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:603
Sends a read receipt message
Parameters
Section titled “Parameters”Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendRemoteAttachment()
Section titled “sendRemoteAttachment()”sendRemoteAttachment(
remoteAttachment,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:667
Sends a remote attachment message
Parameters
Section titled “Parameters”remoteAttachment
Section titled “remoteAttachment”The remote attachment to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendReply()
Section titled “sendReply()”sendReply(
reply,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:611
Sends a reply message
Parameters
Section titled “Parameters”The reply to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendText()
Section titled “sendText()”sendText(
text,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:580
Sends a text message
Parameters
Section titled “Parameters”string
The text to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendTransactionReference()
Section titled “sendTransactionReference()”sendTransactionReference(
transactionReference,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:619
Sends a transaction reference message
Parameters
Section titled “Parameters”transactionReference
Section titled “transactionReference”The transaction reference to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
sendWalletSendCalls()
Section titled “sendWalletSendCalls()”sendWalletSendCalls(
walletSendCalls,opts?):Promise<string>
Defined in: sdks/js/node-sdk/dist/index.d.ts:627
Sends a wallet send calls message
Parameters
Section titled “Parameters”walletSendCalls
Section titled “walletSendCalls”The wallet send calls to send
Send options (optimistic delivery, idempotency key)
Returns
Section titled “Returns”Promise<string>
Promise that resolves with the message ID after it has been sent
setNotifications()
Section titled “setNotifications()”setNotifications(
value):Promise<void>
Defined in: sdks/js/node-sdk/dist/index.d.ts:488
Override notification rules, or reset the override with “default”.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
stream()
Section titled “stream()”stream(
options?):Promise<MessageStream<Message,DecodedMessage<ContentTypes>>>
Defined in: sdks/js/node-sdk/dist/index.d.ts:541
Reads retained messages after the default acknowledgement position.
Set from to replay after a cursor without changing default progress.
Set onValue for callback mode, or request items with the iterator.
Core owns network recovery. Legacy retry options and disableSync do not apply.
Parameters
Section titled “Parameters”options?
Section titled “options?”StreamOptions<Message, DecodedMessage<ContentTypes>> & object
Optional delivery callbacks and replay cursor
Returns
Section titled “Returns”Promise<MessageStream<Message, DecodedMessage<ContentTypes>>>
Stream instance for new messages
sync()
Section titled “sync()”sync():
Promise<void>
Defined in: sdks/js/node-sdk/dist/index.d.ts:531
Synchronizes conversation data from the network
Returns
Section titled “Returns”Promise<void>
Promise that resolves when synchronization is complete
updateConsentState()
Section titled “updateConsentState()”updateConsentState(
consentState):void
Defined in: sdks/js/node-sdk/dist/index.d.ts:697
Updates the consent state for this conversation
Parameters
Section titled “Parameters”consentState
Section titled “consentState”The new consent state to set
Returns
Section titled “Returns”void
updateMessageDisappearingSettings()
Section titled “updateMessageDisappearingSettings()”updateMessageDisappearingSettings(
fromNs,inNs):Promise<void>
Defined in: sdks/js/node-sdk/dist/index.d.ts:711
Updates message disappearing settings for this conversation
Parameters
Section titled “Parameters”fromNs
Section titled “fromNs”bigint
The timestamp from which messages should start disappearing
bigint
The duration after which messages should disappear
Returns
Section titled “Returns”Promise<void>
Promise that resolves when the update is complete