Group
Defined in: sdks/node/dist/public-values.gen.d.ts:252
Properties
Section titled “Properties”[objectBrand]
Section titled “[objectBrand]”
readonly[objectBrand]:"Group"
Defined in: sdks/node/dist/public-values.gen.d.ts:253
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:259
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:261
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:262
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:266
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:268
Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get kind():
ConversationKind
Defined in: sdks/node/dist/public-values.gen.d.ts:270
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get topic():
string
Defined in: sdks/node/dist/public-values.gen.d.ts:314
Returns
Section titled “Returns”string
Methods
Section titled “Methods”addAdmin()
Section titled “addAdmin()”addAdmin(
inboxId):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:256
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<void>
addMembers()
Section titled “addMembers()”addMembers(
members):Promise<MembershipResult>
Defined in: sdks/node/dist/public-values.gen.d.ts:257
Parameters
Section titled “Parameters”members
Section titled “members”string[] | PublicIdentity[]
Returns
Section titled “Returns”Promise<MembershipResult>
addSuperAdmin()
Section titled “addSuperAdmin()”addSuperAdmin(
inboxId):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:258
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<void>
countMessages()
Section titled “countMessages()”countMessages(
options):Promise<bigint>
Defined in: sdks/node/dist/public-values.gen.d.ts:260
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:263
Returns
Section titled “Returns”Promise<ConversationDebugInfo>
deleteMessage()
Section titled “deleteMessage()”deleteMessage(
id):Promise<string>
Defined in: sdks/node/dist/public-values.gen.d.ts:264
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string>
hmacKeys()
Section titled “hmacKeys()”hmacKeys():
Promise<HmacKey[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:265
Returns
Section titled “Returns”Promise<HmacKey[]>
isAdmin()
Section titled “isAdmin()”isAdmin(
inboxId):Promise<boolean>
Defined in: sdks/node/dist/public-values.gen.d.ts:267
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<boolean>
isSuperAdmin()
Section titled “isSuperAdmin()”isSuperAdmin(
inboxId):Promise<boolean>
Defined in: sdks/node/dist/public-values.gen.d.ts:269
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<boolean>
lastActivityAt()
Section titled “lastActivityAt()”lastActivityAt(
contentTypes):Promise<Timestamp>
Defined in: sdks/node/dist/public-values.gen.d.ts:271
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:272
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:273
Returns
Section titled “Returns”Promise<Map<string, Timestamp>>
listAdmins()
Section titled “listAdmins()”listAdmins():
Promise<string[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:274
Returns
Section titled “Returns”Promise<string[]>
listSuperAdmins()
Section titled “listSuperAdmins()”listSuperAdmins():
Promise<string[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:275
Returns
Section titled “Returns”Promise<string[]>
mapValue()
Section titled “mapValue()”mapValue(
field,key):Promise<FieldValue|undefined>
Defined in: sdks/node/dist/public-values.gen.d.ts:276
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:277
Returns
Section titled “Returns”Promise<Member[]>
membershipCapabilities()
Section titled “membershipCapabilities()”membershipCapabilities():
Promise<GroupMembershipCapabilities>
Defined in: sdks/node/dist/public-values.gen.d.ts:278
Returns
Section titled “Returns”Promise<GroupMembershipCapabilities>
messageHistoryPage()
Section titled “messageHistoryPage()”messageHistoryPage(
options?,before?,after?):Promise<MessageHistoryPage>
Defined in: sdks/node/dist/public-values.gen.d.ts:279
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:280
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:281
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:282
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:283
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:284
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:285
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:286
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:287
Parameters
Section titled “Parameters”fields
Section titled “fields”Returns
Section titled “Returns”Promise<MetadataFieldValue[]>
peerInboxIds()
Section titled “peerInboxIds()”peerInboxIds():
Promise<string[]>
Defined in: sdks/node/dist/public-values.gen.d.ts:288
Returns
Section titled “Returns”Promise<string[]>
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:289
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:290
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:291
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:292
Returns
Section titled “Returns”Promise<void>
removeAdmin()
Section titled “removeAdmin()”removeAdmin(
inboxId):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:293
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<void>
removeMembers()
Section titled “removeMembers()”removeMembers(
members):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:294
Parameters
Section titled “Parameters”members
Section titled “members”string[] | PublicIdentity[]
Returns
Section titled “Returns”Promise<void>
removeSuperAdmin()
Section titled “removeSuperAdmin()”removeSuperAdmin(
inboxId):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:295
Parameters
Section titled “Parameters”inboxId
Section titled “inboxId”string
Returns
Section titled “Returns”Promise<void>
requestRemoval()
Section titled “requestRemoval()”requestRemoval():
Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:296
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:297
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:298
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:299
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:300
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:301
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:302
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:303
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:304
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:305
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:306
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:307
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:308
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:309
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:310
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:311
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
state()
Section titled “state()”state():
Promise<GroupState>
Defined in: sdks/node/dist/public-values.gen.d.ts:312
Returns
Section titled “Returns”Promise<GroupState>
streamMessages()
Section titled “streamMessages()”streamMessages(
options?):MessageStream
Defined in: sdks/node/dist/public-values.gen.d.ts:255
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:313
Returns
Section titled “Returns”Promise<void>
updateAppData()
Section titled “updateAppData()”updateAppData(
value,expected):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:315
Parameters
Section titled “Parameters”string
expected
Section titled “expected”string | undefined
Returns
Section titled “Returns”Promise<void>
updateConsentState()
Section titled “updateConsentState()”updateConsentState(
state):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:316
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
updateDescription()
Section titled “updateDescription()”updateDescription(
value):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:317
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
updateDisappearingSettings()
Section titled “updateDisappearingSettings()”updateDisappearingSettings(
settings):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:318
Parameters
Section titled “Parameters”settings
Section titled “settings”DisappearingSettings | undefined
Returns
Section titled “Returns”Promise<void>
updateImageUrl()
Section titled “updateImageUrl()”updateImageUrl(
value):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:319
Parameters
Section titled “Parameters”string
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:320
Parameters
Section titled “Parameters”operation
Section titled “operation”Returns
Section titled “Returns”Promise<void>
updateName()
Section titled “updateName()”updateName(
value):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:321
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
updatePermission()
Section titled “updatePermission()”updatePermission(
kind,policy,metadataField):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:322
Parameters
Section titled “Parameters”policy
Section titled “policy”metadataField
Section titled “metadataField”MetadataFieldKind | undefined
Returns
Section titled “Returns”Promise<void>
updateUserData()
Section titled “updateUserData()”updateUserData(
values):Promise<void>
Defined in: sdks/node/dist/public-values.gen.d.ts:323
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:324
Parameters
Section titled “Parameters”fields
Section titled “fields”MetadataFieldRef[] | undefined
inboxIds
Section titled “inboxIds”string[] | undefined
Returns
Section titled “Returns”Promise<Map<string, UserFieldValue[]>>