Conversations
Defined in: sdks/node/dist/public-values.gen.d.ts:163
Properties
Section titled “Properties”[objectBrand]
Section titled “[objectBrand]”
readonly[objectBrand]:"Conversations"
Defined in: sdks/node/dist/public-values.gen.d.ts:164
Methods
Section titled “Methods”beginningDeliveryCursor()
Section titled “beginningDeliveryCursor()”beginningDeliveryCursor():
Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:168
Returns
Section titled “Returns”Promise<string>
conversationReader()
Section titled “conversationReader()”conversationReader(
options):Promise<ConversationReader>
Defined in: sdks/node/dist/public-values.gen.d.ts:169
Parameters
Section titled “Parameters”options
Section titled “options”ConversationReaderOptions | undefined
Returns
Section titled “Returns”Promise<ConversationReader>
createDm()
Section titled “createDm()”createDm(
peer,options?):Promise<Dm>
Defined in: sdks/node/dist/public-values.gen.d.ts:170
Parameters
Section titled “Parameters”string | PublicIdentity
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Dm>
createGroup()
Section titled “createGroup()”createGroup(
members,options?):Promise<Group>
Defined in: sdks/node/dist/public-values.gen.d.ts:171
Parameters
Section titled “Parameters”members
Section titled “members”string[] | PublicIdentity[]
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Group>
createGroupOptimistic()
Section titled “createGroupOptimistic()”createGroupOptimistic(
options?):Promise<Group>
Defined in: sdks/node/dist/public-values.gen.d.ts:172
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Group>
deleteMessage()
Section titled “deleteMessage()”deleteMessage(
id):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:173
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
deleteMessageLocally()
Section titled “deleteMessageLocally()”deleteMessageLocally(
id):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:174
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
getById()
Section titled “getById()”getById(
id):Promise<Conversation|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:175
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Conversation | undefined>
getDmByIdentity()
Section titled “getDmByIdentity()”getDmByIdentity(
identity):Promise<Dm|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:176
Parameters
Section titled “Parameters”identity
Section titled “identity”Returns
Section titled “Returns”Promise<Dm | undefined>
getDmByInboxId()
Section titled “getDmByInboxId()”getDmByInboxId(
peer):Promise<Dm|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:177
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Dm | undefined>
getMessageById()
Section titled “getMessageById()”getMessageById(
id):Promise<Message|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:178
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Message | undefined>
hmacKeys()
Section titled “hmacKeys()”hmacKeys():
Promise<Map<string,HmacKey[]>>
Defined in: sdks/node/dist/public-values.gen.d.ts:179
Returns
Section titled “Returns”Promise<Map<string, HmacKey[]>>
list()
Section titled “list()”list(
options?):Promise<Conversation[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:180
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Conversation[]>
listDms()
Section titled “listDms()”listDms(
options):Promise<Dm[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:181
Parameters
Section titled “Parameters”options
Section titled “options”ListConversationsOptions | undefined
Returns
Section titled “Returns”Promise<Dm[]>
listGroups()
Section titled “listGroups()”listGroups(
options):Promise<Group[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:182
Parameters
Section titled “Parameters”options
Section titled “options”ListConversationsOptions | undefined
Returns
Section titled “Returns”Promise<Group[]>
messageHistorySnapshot()
Section titled “messageHistorySnapshot()”messageHistorySnapshot(
limit,options?):Promise<MessageHistorySnapshot>
Defined in: sdks/node/dist/public-values.gen.d.ts:183
Parameters
Section titled “Parameters”number
options?
Section titled “options?”Returns
Section titled “Returns”Promise<MessageHistorySnapshot>
messageReader()
Section titled “messageReader()”messageReader(
options?):Promise<MessageReader>
Defined in: sdks/node/dist/public-values.gen.d.ts:184
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<MessageReader>
reactToMessage()
Section titled “reactToMessage()”reactToMessage(
id,reaction,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:185
Parameters
Section titled “Parameters”string
reaction
Section titled “reaction”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
replyToMessage()
Section titled “replyToMessage()”replyToMessage(
id,content,options?):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:186
Parameters
Section titled “Parameters”string
content
Section titled “content”options?
Section titled “options?”Returns
Section titled “Returns”Promise<string>
stream()
Section titled “stream()”stream(
options?):ConversationStream
Defined in: sdks/node/dist/public-values.gen.d.ts:166
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”streamAllMessages()
Section titled “streamAllMessages()”streamAllMessages(
options?):MessageStream
Defined in: sdks/node/dist/public-values.gen.d.ts:167
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”sync()
Section titled “sync()”sync():
Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:187
Returns
Section titled “Returns”Promise<void>
syncAll()
Section titled “syncAll()”syncAll(
consentStates):Promise<GroupSyncSummary>
Defined in: sdks/node/dist/public-values.gen.d.ts:188
Parameters
Section titled “Parameters”consentStates
Section titled “consentStates”ConsentState[] | undefined
Returns
Section titled “Returns”Promise<GroupSyncSummary>