Dm
Defined in: sdks/node/dist/public-values.gen.d.ts:192
Properties
Section titled “Properties”[objectBrand]
Section titled “[objectBrand]”
readonly[objectBrand]:"Dm"
Defined in: sdks/node/dist/public-values.gen.d.ts:193
Accessors
Section titled “Accessors”addedByInboxId
Section titled “addedByInboxId”Get Signature
Section titled “Get Signature”get addedByInboxId():
string|null
Defined in: sdks/node/dist/public-values.gen.d.ts:196
Returns
Section titled “Returns”string | null
createdAt
Section titled “createdAt”Get Signature
Section titled “Get Signature”get createdAt():
Timestamp
Defined in: sdks/node/dist/public-values.gen.d.ts:198
Returns
Section titled “Returns”creatorInboxId
Section titled “creatorInboxId”Get Signature
Section titled “Get Signature”get creatorInboxId():
string|null
Defined in: sdks/node/dist/public-values.gen.d.ts:199
Returns
Section titled “Returns”string | null
Get Signature
Section titled “Get Signature”get id():
string
Defined in: sdks/node/dist/public-values.gen.d.ts:204
Returns
Section titled “Returns”string
isCreator
Section titled “isCreator”Get Signature
Section titled “Get Signature”get isCreator():
boolean
Defined in: sdks/node/dist/public-values.gen.d.ts:205
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get kind():
ConversationKind
Defined in: sdks/node/dist/public-values.gen.d.ts:206
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get topic():
string
Defined in: sdks/node/dist/public-values.gen.d.ts:243
Returns
Section titled “Returns”string
Methods
Section titled “Methods”countMessages()
Section titled “countMessages()”countMessages(
options):Promise<bigint>
Defined in: sdks/node/dist/public-values.gen.d.ts:197
Parameters
Section titled “Parameters”options
Section titled “options”ListMessagesOptions | undefined
Returns
Section titled “Returns”Promise<bigint>
debugInfo()
Section titled “debugInfo()”debugInfo():
Promise<ConversationDebugInfo>
Defined in: sdks/node/dist/public-values.gen.d.ts:200
Returns
Section titled “Returns”Promise<ConversationDebugInfo>
deleteMessage()
Section titled “deleteMessage()”deleteMessage(
id):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:201
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
duplicateDms()
Section titled “duplicateDms()”duplicateDms():
Promise<Dm[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:202
Returns
Section titled “Returns”Promise<Dm[]>
hmacKeys()
Section titled “hmacKeys()”hmacKeys():
Promise<HmacKey[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:203
Returns
Section titled “Returns”Promise<HmacKey[]>
lastActivityAt()
Section titled “lastActivityAt()”lastActivityAt(
contentTypes):Promise<Timestamp>
Defined in: sdks/node/dist/public-values.gen.d.ts:207
Parameters
Section titled “Parameters”contentTypes
Section titled “contentTypes”ContentTypeId[] | undefined
Returns
Section titled “Returns”Promise<Timestamp>
lastMessage()
Section titled “lastMessage()”lastMessage():
Promise<Message|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:208
Returns
Section titled “Returns”Promise<Message | undefined>
lastReadTimes()
Section titled “lastReadTimes()”lastReadTimes():
Promise<Map<string,Timestamp>>
Defined in: sdks/node/dist/public-values.gen.d.ts:209
Returns
Section titled “Returns”Promise<Map<string, Timestamp>>
mapValue()
Section titled “mapValue()”mapValue(
field,key):Promise<FieldValue|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:210
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FieldValue | undefined>
members()
Section titled “members()”members():
Promise<Member[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:211
Returns
Section titled “Returns”Promise<Member[]>
messageHistoryPage()
Section titled “messageHistoryPage()”messageHistoryPage(
options?,before?,after?):Promise<MessageHistoryPage>
Defined in: sdks/node/dist/public-values.gen.d.ts:212
Parameters
Section titled “Parameters”options?
Section titled “options?”before?
Section titled “before?”after?
Section titled “after?”Returns
Section titled “Returns”Promise<MessageHistoryPage>
messageHistorySnapshot()
Section titled “messageHistorySnapshot()”messageHistorySnapshot(
limit):Promise<MessageHistorySnapshot>
Defined in: sdks/node/dist/public-values.gen.d.ts:213
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<MessageHistorySnapshot>
messageReader()
Section titled “messageReader()”messageReader(
options?):Promise<MessageReader>
Defined in: sdks/node/dist/public-values.gen.d.ts:214
Parameters
Section titled “Parameters”options?
Section titled “options?”ConversationMessageReaderOptions
Returns
Section titled “Returns”Promise<MessageReader>
messageRecoveryPage()
Section titled “messageRecoveryPage()”messageRecoveryPage(
options?,before?,after?):Promise<MessageRecoveryPage>
Defined in: sdks/node/dist/public-values.gen.d.ts:215
Parameters
Section titled “Parameters”options?
Section titled “options?”before?
Section titled “before?”after?
Section titled “after?”Returns
Section titled “Returns”Promise<MessageRecoveryPage>
messages()
Section titled “messages()”messages(
options?):Promise<Message[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:216
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Message[]>
metadataField()
Section titled “metadataField()”metadataField(
name):Promise<MetadataFieldDescriptor|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:217
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<MetadataFieldDescriptor | undefined>
metadataFields()
Section titled “metadataFields()”metadataFields():
Promise<MetadataFieldDescriptor[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:218
Returns
Section titled “Returns”Promise<MetadataFieldDescriptor[]>
metadataValue()
Section titled “metadataValue()”metadataValue(
field):Promise<MetadataValue|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:219
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<MetadataValue | undefined>
metadataValues()
Section titled “metadataValues()”metadataValues(
fields):Promise<MetadataFieldValue[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:220
Parameters
Section titled “Parameters”fields
Section titled “fields”Returns
Section titled “Returns”Promise<MetadataFieldValue[]>
peerInboxId()
Section titled “peerInboxId()”peerInboxId():
Promise<string|null>
Defined in: sdks/node/dist/public-values.gen.d.ts:221
Returns
Section titled “Returns”Promise<string | null>
prepareMessage()
Section titled “prepareMessage()”Call Signature
Section titled “Call Signature”prepareMessage(
encoded,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:222
Parameters
Section titled “Parameters”encoded
Section titled “encoded”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
Call Signature
Section titled “Call Signature”prepareMessage<
T>(codec,value,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:223
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ContentCodec<T>
NoInfer<T>
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
publishMessage()
Section titled “publishMessage()”publishMessage(
id):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:224
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
publishMessages()
Section titled “publishMessages()”publishMessages():
Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:225
Returns
Section titled “Returns”Promise<void>
send()
Section titled “send()”Call Signature
Section titled “Call Signature”send(
encoded,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:226
Parameters
Section titled “Parameters”encoded
Section titled “encoded”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
Call Signature
Section titled “Call Signature”send<
T>(codec,value,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:227
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”ContentCodec<T>
NoInfer<T>
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendActions()
Section titled “sendActions()”sendActions(
actions,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:228
Parameters
Section titled “Parameters”actions
Section titled “actions”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendAttachment()
Section titled “sendAttachment()”sendAttachment(
attachment,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:229
Parameters
Section titled “Parameters”attachment
Section titled “attachment”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendIntent()
Section titled “sendIntent()”sendIntent(
intent,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:230
Parameters
Section titled “Parameters”intent
Section titled “intent”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendMarkdown()
Section titled “sendMarkdown()”sendMarkdown(
markdown,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:231
Parameters
Section titled “Parameters”markdown
Section titled “markdown”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendMultiRemoteAttachment()
Section titled “sendMultiRemoteAttachment()”sendMultiRemoteAttachment(
attachment,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:232
Parameters
Section titled “Parameters”attachment
Section titled “attachment”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendReaction()
Section titled “sendReaction()”sendReaction(
reference,referenceInboxId,reaction,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:233
Parameters
Section titled “Parameters”reference
Section titled “reference”string
referenceInboxId
Section titled “referenceInboxId”string | undefined
reaction
Section titled “reaction”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendReadReceipt()
Section titled “sendReadReceipt()”sendReadReceipt(
options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:234
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendRemoteAttachment()
Section titled “sendRemoteAttachment()”sendRemoteAttachment(
attachment,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:235
Parameters
Section titled “Parameters”attachment
Section titled “attachment”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendReply()
Section titled “sendReply()”sendReply(
reference,referenceInboxId,content,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:236
Parameters
Section titled “Parameters”reference
Section titled “reference”string
referenceInboxId
Section titled “referenceInboxId”string | undefined
content
Section titled “content”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendText()
Section titled “sendText()”sendText(
text,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:237
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendTransactionReference()
Section titled “sendTransactionReference()”sendTransactionReference(
reference,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:238
Parameters
Section titled “Parameters”reference
Section titled “reference”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
sendWalletSendCalls()
Section titled “sendWalletSendCalls()”sendWalletSendCalls(
calls,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:239
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
setNotifications()
Section titled “setNotifications()”setNotifications(
value):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:240
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
state()
Section titled “state()”state():
Promise<ConversationState>
Defined in: sdks/node/dist/public-values.gen.d.ts:241
Returns
Section titled “Returns”Promise<ConversationState>
streamMessages()
Section titled “streamMessages()”streamMessages(
options?):MessageStream
Defined in: sdks/node/dist/public-values.gen.d.ts:195
Parameters
Section titled “Parameters”options?
Section titled “options?”ConversationMessageStreamOptions
Returns
Section titled “Returns”sync()
Section titled “sync()”sync():
Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:242
Returns
Section titled “Returns”Promise<void>
updateConsentState()
Section titled “updateConsentState()”updateConsentState(
state):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:244
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
updateDisappearingSettings()
Section titled “updateDisappearingSettings()”updateDisappearingSettings(
settings):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:245
Parameters
Section titled “Parameters”settings
Section titled “settings”DisappearingSettings | undefined
Returns
Section titled “Returns”Promise<void>
updateMetadataField()
Section titled “updateMetadataField()”updateMetadataField(
field,operation):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:246
Parameters
Section titled “Parameters”operation
Section titled “operation”Returns
Section titled “Returns”Promise<void>
updateUserData()
Section titled “updateUserData()”updateUserData(
values):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:247
Parameters
Section titled “Parameters”values
Section titled “values”Returns
Section titled “Returns”Promise<void>
userData()
Section titled “userData()”userData(
fields,inboxIds):Promise<Map<string,UserFieldValue[]>>
Defined in: sdks/node/dist/public-values.gen.d.ts:248
Parameters
Section titled “Parameters”fields
Section titled “fields”MetadataFieldRef[] | undefined
inboxIds
Section titled “inboxIds”string[] | undefined
Returns
Section titled “Returns”Promise<Map<string, UserFieldValue[]>>