Client

Defined in: sdks/node/dist/runtime/public/client.d.ts:19

An XMTP client. Its inputs and results are public values; the binding Client and the target transport stay private to the package.

Extends

• ClientMembers

Accessors

appVersion

Get Signature

get appVersion(): string | undefined

Defined in: sdks/node/dist/public-values.gen.d.ts:97

Returns

string | undefined

Inherited from

ClientMembers.appVersion

---

archives

Get Signature

get archives(): Archives

Defined in: sdks/node/dist/public-values.gen.d.ts:98

Returns

Archives

Inherited from

ClientMembers.archives

---

attachments

Get Signature

get attachments(): Attachments

Defined in: sdks/node/dist/public-values.gen.d.ts:99

Returns

Attachments

Inherited from

ClientMembers.attachments

---

conversations

Get Signature

get conversations(): Conversations

Defined in: sdks/node/dist/public-values.gen.d.ts:105

Returns

Conversations

Inherited from

ClientMembers.conversations

---

diagnostics

Get Signature

get diagnostics(): Diagnostics

Defined in: sdks/node/dist/public-values.gen.d.ts:107

Returns

Diagnostics

Inherited from

ClientMembers.diagnostics

---

identity

Get Signature

get identity(): PublicIdentity

Defined in: sdks/node/dist/public-values.gen.d.ts:110

Returns

PublicIdentity

Inherited from

ClientMembers.identity

---

inboxId

Get Signature

get inboxId(): string

Defined in: sdks/node/dist/public-values.gen.d.ts:111

Returns

string

Inherited from

ClientMembers.inboxId

---

installationId

Get Signature

get installationId(): string

Defined in: sdks/node/dist/public-values.gen.d.ts:115

Returns

string

Inherited from

ClientMembers.installationId

---

installationIdBytes

Get Signature

get installationIdBytes(): Uint8Array

Defined in: sdks/node/dist/public-values.gen.d.ts:116

Returns

Uint8Array

Inherited from

ClientMembers.installationIdBytes

---

isInMemory

Get Signature

get isInMemory(): boolean

Defined in: sdks/node/dist/public-values.gen.d.ts:117

Returns

boolean

Inherited from

ClientMembers.isInMemory

---

libxmtpVersion

Get Signature

get libxmtpVersion(): string

Defined in: sdks/node/dist/public-values.gen.d.ts:121

Returns

string

Inherited from

ClientMembers.libxmtpVersion

---

options

Get Signature

get options(): ClientOptions

Defined in: sdks/node/dist/public-values.gen.d.ts:123

Returns

ClientOptions

Inherited from

ClientMembers.options

---

preferences

Get Signature

get preferences(): Preferences

Defined in: sdks/node/dist/public-values.gen.d.ts:125

Returns

Preferences

Inherited from

ClientMembers.preferences

---

serverConfiguration

Get Signature

get serverConfiguration(): ServerConfiguration

Defined in: sdks/node/dist/public-values.gen.d.ts:131

Returns

ServerConfiguration

Inherited from

ClientMembers.serverConfiguration

---

storage

Get Signature

get storage(): Storage

Defined in: sdks/node/dist/public-values.gen.d.ts:134

Returns

Storage

Inherited from

ClientMembers.storage

---

storagePath

Get Signature

get storagePath(): string | undefined

Defined in: sdks/node/dist/public-values.gen.d.ts:135

Returns

string | undefined

Inherited from

ClientMembers.storagePath

Methods

availableHandles()

availableHandles(name): Promise<string[]>

Defined in: sdks/node/dist/public-values.gen.d.ts:100

Parameters

name

string

Returns

Promise<string[]>

Inherited from

ClientMembers.availableHandles

---

canMessage()

canMessage(identities): Promise<Map<string, boolean>>

Defined in: sdks/node/dist/public-values.gen.d.ts:101

Parameters

identities

PublicIdentity[]

Returns

Promise<Map<string, boolean>>

Inherited from

ClientMembers.canMessage

---

catchUpToLive()

catchUpToLive(timeoutMs): Promise<CatchUpSummary>

Defined in: sdks/node/dist/public-values.gen.d.ts:102

Parameters

timeoutMs

bigint | undefined

Returns

Promise<CatchUpSummary>

Inherited from

ClientMembers.catchUpToLive

---

changeRecoveryIdentifier()

changeRecoveryIdentifier(signer, identity): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:103

Parameters

signer

Signer

identity

PublicIdentity

Returns

Promise<void>

Inherited from

ClientMembers.changeRecoveryIdentifier

---

claimHandle()

claimHandle(handle): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:104

Parameters

handle

string

Returns

Promise<void>

Inherited from

ClientMembers.claimHandle

---

decodeContent()

decodeContent(encoded): Promise<MessageContent>

Defined in: sdks/node/dist/public-values.gen.d.ts:106

Parameters

encoded

EncodedContent

Returns

Promise<MessageContent>

Inherited from

ClientMembers.decodeContent

---

disableNotifications()

disableNotifications(): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:108

Returns

Promise<void>

Inherited from

ClientMembers.disableNotifications

---

enableNotifications()

enableNotifications(config): Promise<NotificationState>

Defined in: sdks/node/dist/public-values.gen.d.ts:109

Parameters

config

NotificationConfig

Returns

Promise<NotificationState>

Inherited from

ClientMembers.enableNotifications

---

end()

end(): Promise<void>

Defined in: sdks/node/dist/runtime/public/client.d.ts:36

End the client. Messages from it then fail with ClientClosed. Ending a closed client does nothing, also after its browser worker stopped.

Returns

Promise<void>

---

events()

events(filter): Promise<EventStream>

Defined in: sdks/node/dist/runtime/public/client.d.ts:24

A stream of the client events that filter selects.

Parameters

filter

EventFilter

Returns

Promise<EventStream>

---

inboxIdFor()

inboxIdFor(identity): Promise<string | undefined>

Defined in: sdks/node/dist/public-values.gen.d.ts:112

Parameters

identity

PublicIdentity

Returns

Promise<string | undefined>

Inherited from

ClientMembers.inboxIdFor

---

inboxState()

inboxState(refreshFromNetwork): Promise<InboxState>

Defined in: sdks/node/dist/public-values.gen.d.ts:113

Parameters

refreshFromNetwork

boolean

Returns

Promise<InboxState>

Inherited from

ClientMembers.inboxState

---

inboxStates()

inboxStates(ids, refreshFromNetwork): Promise<InboxState[]>

Defined in: sdks/node/dist/public-values.gen.d.ts:114

Parameters

ids

string[]

refreshFromNetwork

boolean

Returns

Promise<InboxState[]>

Inherited from

ClientMembers.inboxStates

---

isRegistered()

isRegistered(): Promise<boolean>

Defined in: sdks/node/dist/public-values.gen.d.ts:118

Returns

Promise<boolean>

Inherited from

ClientMembers.isRegistered

---

keyPackageStatuses()

keyPackageStatuses(ids): Promise<Map<string, KeyPackageStatus>>

Defined in: sdks/node/dist/public-values.gen.d.ts:119

Parameters

ids

string[]

Returns

Promise<Map<string, KeyPackageStatus>>

Inherited from

ClientMembers.keyPackageStatuses

---

latestInboxUpdatesCount()

latestInboxUpdatesCount(ids, refreshFromNetwork): Promise<Map<string, bigint>>

Defined in: sdks/node/dist/public-values.gen.d.ts:120

Parameters

ids

string[]

refreshFromNetwork

boolean

Returns

Promise<Map<string, bigint>>

Inherited from

ClientMembers.latestInboxUpdatesCount

---

notificationState()

notificationState(): NotificationState

Defined in: sdks/node/dist/public-values.gen.d.ts:122

Returns

NotificationState

Inherited from

ClientMembers.notificationState

---

ownInboxUpdatesCount()

ownInboxUpdatesCount(refreshFromNetwork): Promise<bigint>

Defined in: sdks/node/dist/public-values.gen.d.ts:124

Parameters

refreshFromNetwork

boolean

Returns

Promise<bigint>

Inherited from

ClientMembers.ownInboxUpdatesCount

---

refreshServerConfiguration()

refreshServerConfiguration(): Promise<ServerConfiguration>

Defined in: sdks/node/dist/public-values.gen.d.ts:126

Returns

Promise<ServerConfiguration>

Inherited from

ClientMembers.refreshServerConfiguration

---

register()

register(): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:127

Returns

Promise<void>

Inherited from

ClientMembers.register

---

removeAccount()

removeAccount(recoverySigner, identity): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:128

Parameters

recoverySigner

Signer

identity

PublicIdentity

Returns

Promise<void>

Inherited from

ClientMembers.removeAccount

---

revokeAllOtherInstallations()

revokeAllOtherInstallations(signer): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:129

Parameters

signer

Signer

Returns

Promise<void>

Inherited from

ClientMembers.revokeAllOtherInstallations

---

revokeInstallations()

revokeInstallations(signer, ids): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:130

Parameters

signer

Signer

ids

string[]

Returns

Promise<void>

Inherited from

ClientMembers.revokeInstallations

---

setCredential()

setCredential(credential): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:132

Parameters

credential

Credential

Returns

Promise<void>

Inherited from

ClientMembers.setCredential

---

signWithInstallationKey()

signWithInstallationKey(text): Promise<Uint8Array<ArrayBufferLike>>

Defined in: sdks/node/dist/public-values.gen.d.ts:133

Parameters

text

string

Returns

Promise<Uint8Array<ArrayBufferLike>>

Inherited from

ClientMembers.signWithInstallationKey

---

startListener()

startListener(filter, callback): Promise<bigint>

Defined in: sdks/node/dist/runtime/public/client.d.ts:29

Call callback for each client event that filter selects. A callback failure does not stop the listener.

Parameters

filter

EventFilter

callback

(event) => void | Promise<void>

Returns

Promise<bigint>

---

stopListener()

stopListener(id): Promise<void>

Defined in: sdks/node/dist/runtime/public/client.d.ts:31

Stop a listener. Stopping an unknown or stopped listener does nothing.

Parameters

id

bigint

Returns

Promise<void>

---

syncAllDeviceSyncGroups()

syncAllDeviceSyncGroups(): Promise<GroupSyncSummary>

Defined in: sdks/node/dist/public-values.gen.d.ts:136

Returns

Promise<GroupSyncSummary>

Inherited from

ClientMembers.syncAllDeviceSyncGroups

---

unsafeAddAccount()

unsafeAddAccount(signer, allowInboxReassign): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:137

Parameters

signer

Signer

allowInboxReassign

boolean

Returns

Promise<void>

Inherited from

ClientMembers.unsafeAddAccount

---

unsafeAddAccountSignatureRequest()

unsafeAddAccountSignatureRequest(identity, allowInboxReassign): Promise<SignatureRequest>

Defined in: sdks/node/dist/public-values.gen.d.ts:138

Parameters

identity

PublicIdentity

allowInboxReassign

boolean

Returns

Promise<SignatureRequest>

Inherited from

ClientMembers.unsafeAddAccountSignatureRequest

---

unsafeApplySignatureRequest()

unsafeApplySignatureRequest(request): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:139

Parameters

request

SignatureRequest

Returns

Promise<void>

Inherited from

ClientMembers.unsafeApplySignatureRequest

---

unsafeChangeRecoveryIdentifierSignatureRequest()

unsafeChangeRecoveryIdentifierSignatureRequest(identity): Promise<SignatureRequest>

Defined in: sdks/node/dist/public-values.gen.d.ts:140

Parameters

identity

PublicIdentity

Returns

Promise<SignatureRequest>

Inherited from

ClientMembers.unsafeChangeRecoveryIdentifierSignatureRequest

---

unsafeCreateInboxSignatureRequest()

unsafeCreateInboxSignatureRequest(): Promise<SignatureRequest | undefined>

Defined in: sdks/node/dist/public-values.gen.d.ts:141

Returns

Promise<SignatureRequest | undefined>

Inherited from

ClientMembers.unsafeCreateInboxSignatureRequest

---

unsafeRemoveAccountSignatureRequest()

unsafeRemoveAccountSignatureRequest(identity): Promise<SignatureRequest>

Defined in: sdks/node/dist/public-values.gen.d.ts:142

Parameters

identity

PublicIdentity

Returns

Promise<SignatureRequest>

Inherited from

ClientMembers.unsafeRemoveAccountSignatureRequest

---

unsafeRevokeAllOtherInstallationsSignatureRequest()

unsafeRevokeAllOtherInstallationsSignatureRequest(): Promise<SignatureRequest | undefined>

Defined in: sdks/node/dist/public-values.gen.d.ts:143

Returns

Promise<SignatureRequest | undefined>

Inherited from

ClientMembers.unsafeRevokeAllOtherInstallationsSignatureRequest

---

unsafeRevokeInstallationsSignatureRequest()

unsafeRevokeInstallationsSignatureRequest(ids): Promise<SignatureRequest>

Defined in: sdks/node/dist/public-values.gen.d.ts:144

Parameters

ids

string[]

Returns

Promise<SignatureRequest>

Inherited from

ClientMembers.unsafeRevokeInstallationsSignatureRequest

---

verifySignedWithInstallationKey()

verifySignedWithInstallationKey(text, signature): Promise<boolean>

Defined in: sdks/node/dist/public-values.gen.d.ts:145

Parameters

text

string

signature

Uint8Array

Returns

Promise<boolean>

Inherited from

ClientMembers.verifySignedWithInstallationKey

---

build()

static build(identity, options, inboxId?): Promise<Client>

Defined in: sdks/node/dist/runtime/public/client.d.ts:22

Parameters

identity

PublicIdentity

options

ClientOptions

inboxId?

string

Returns

Promise<Client>

---

canMessage()

static canMessage(identities, backend): Promise<Map<string, boolean>>

Defined in: sdks/node/dist/public-values.gen.d.ts:146

Parameters

identities

PublicIdentity[]

backend

BackendSource

Returns

Promise<Map<string, boolean>>

Inherited from

ClientMembers.canMessage

---

create()

static create(signer, options): Promise<Client>

Defined in: sdks/node/dist/runtime/public/client.d.ts:21

Parameters

signer

Signer

options

ClientOptions

Returns

Promise<Client>

---

fetchServerConfiguration()

static fetchServerConfiguration(backend): Promise<ServerConfiguration>

Defined in: sdks/node/dist/public-values.gen.d.ts:147

Parameters

backend

BackendSource

Returns

Promise<ServerConfiguration>

Inherited from

ClientMembers.fetchServerConfiguration

---

generateKeys()

static generateKeys(): Promise<LocalSigningKey>

Defined in: sdks/node/dist/public-values.gen.d.ts:148

Returns

Promise<LocalSigningKey>

Inherited from

ClientMembers.generateKeys

---

inboxIdFor()

static inboxIdFor(identity, backend): Promise<string>

Defined in: sdks/node/dist/public-values.gen.d.ts:149

Parameters

identity

PublicIdentity

backend

BackendSource

Returns

Promise<string>

Inherited from

ClientMembers.inboxIdFor

---

inboxStates()

static inboxStates(ids, backend): Promise<InboxState[]>

Defined in: sdks/node/dist/public-values.gen.d.ts:150

Parameters

ids

string[]

backend

BackendSource

Returns

Promise<InboxState[]>

Inherited from

ClientMembers.inboxStates

---

isAddressAuthorized()

static isAddressAuthorized(inboxId, address, backend): Promise<boolean>

Defined in: sdks/node/dist/public-values.gen.d.ts:151

Parameters

inboxId

string

address

string

backend

BackendSource

Returns

Promise<boolean>

Inherited from

ClientMembers.isAddressAuthorized

---

isInstallationAuthorized()

static isInstallationAuthorized(inboxId, installationId, backend): Promise<boolean>

Defined in: sdks/node/dist/public-values.gen.d.ts:152

Parameters

inboxId

string

installationId

string

backend

BackendSource

Returns

Promise<boolean>

Inherited from

ClientMembers.isInstallationAuthorized

---

keyPackageStatuses()

static keyPackageStatuses(ids, backend): Promise<Map<string, KeyPackageStatus>>

Defined in: sdks/node/dist/public-values.gen.d.ts:153

Parameters

ids

string[]

backend

BackendSource

Returns

Promise<Map<string, KeyPackageStatus>>

Inherited from

ClientMembers.keyPackageStatuses

---

newestMessageMetadata()

static newestMessageMetadata(ids, backend): Promise<Map<string, MessageMetadataEntry>>

Defined in: sdks/node/dist/public-values.gen.d.ts:154

Parameters

ids

string[]

backend

BackendSource

Returns

Promise<Map<string, MessageMetadataEntry>>

Inherited from

ClientMembers.newestMessageMetadata

---

revokeInstallations()

static revokeInstallations(signer, inboxId, ids, backend): Promise<void>

Defined in: sdks/node/dist/public-values.gen.d.ts:155

Parameters

signer

Signer

inboxId

string

ids

string[]

backend

BackendSource

Returns

Promise<void>

Inherited from

ClientMembers.revokeInstallations

---

verifySignedWithPublicKey()

static verifySignedWithPublicKey(text, signature, publicKey): Promise<boolean>

Defined in: sdks/node/dist/public-values.gen.d.ts:156

Parameters

text

string

signature

Uint8Array

publicKey

Uint8Array

Returns

Promise<boolean>

Inherited from

ClientMembers.verifySignedWithPublicKey