Class Client

Client class initiates connection to the XMTP network. Should be created with await Client.create(options)

Hierarchy

Client

Index

Constructors

constructor

Properties

Accessors

conversations

Methods

Constructors

constructor

new Client(keys: PrivateKeyBundleV1, apiClient: default): Client

- Defined in Client.ts:151
Parameters
- keys: PrivateKeyBundleV1
- apiClient: default
Returns Client

Properties

address

address: string

apiClient

apiClient: default

contacts

contacts: Set<string>

keys

keys: PrivateKeyBundleV2

legacyKeys

legacyKeys: PrivateKeyBundleV1

Accessors

conversations

get conversations(): Conversations

- Defined in Client.ts:169
Returns Conversations

Methods

canMessage

canMessage(peerAddress: string): Promise<boolean>

- Defined in Client.ts:260
Check if @peerAddress can be messaged, specifically it checks that a PublicKeyBundle can be found for the given address

Parameters
- peerAddress: string
Returns Promise<boolean>

close

close(): Promise<void>

- Defined in Client.ts:209
Returns Promise<void>

codecFor

codecFor(contentType: ContentTypeId): undefined | ContentCodec<any>

- Defined in Client.ts:307
Parameters
- contentType: ContentTypeId
Returns undefined | ContentCodec<any>

encodeContent

encodeContent(content: any, options?: SendOptions): Promise<Uint8Array>

- Defined in Client.ts:319
Parameters
- content: any
- Optional options: SendOptions
Returns Promise<Uint8Array>

forgetContact

forgetContact(peerAddress: string): void

- Defined in Client.ts:252
Parameters
- peerAddress: string
Returns void

getUserContact

getUserContact(peerAddress: string): Promise<undefined | PublicKeyBundle | SignedPublicKeyBundle>

- Defined in Client.ts:231
Returns the cached PublicKeyBundle if one is known for the given address or fetches one from the network

Parameters
- peerAddress: string
Returns Promise<undefined | PublicKeyBundle | SignedPublicKeyBundle>

init

init(options: ClientOptions): Promise<void>

- Defined in Client.ts:200
Parameters
- options: ClientOptions
Returns Promise<void>

listEnvelopes

listEnvelopes<Out>(topics: string[], mapper: EnvelopeMapper<Out>, opts?: ListMessagesOptions): Promise<Out[]>

- Defined in Client.ts:349
Type parameters
- Out
Parameters
- topics: string[]
- mapper: EnvelopeMapper<Out>
- Optional opts: ListMessagesOptions
Returns Promise<Out[]>

listEnvelopesPaginated

listEnvelopesPaginated<Out>(contentTopics: string[], mapper: EnvelopeMapper<Out>, opts?: ListMessagesPaginatedOptions): AsyncGenerator<Out[], any, unknown>

- Defined in Client.ts:383
List messages on a given set of content topics, yielding one page at a time

Type parameters
- Out
Parameters
- contentTopics: string[]
- mapper: EnvelopeMapper<Out>
- Optional opts: ListMessagesPaginatedOptions
Returns AsyncGenerator<Out[], any, unknown>

listInvitations

listInvitations(opts?: ListMessagesOptions): Promise<SealedInvitation[]>

- Defined in Client.ts:340
Parameters
- Optional opts: ListMessagesOptions
Returns Promise<SealedInvitation[]>

publishEnvelopes

publishEnvelopes(envelopes: PublishParams[]): Promise<void>

- Defined in Client.ts:288
Parameters
- envelopes: PublishParams[]
Returns Promise<void>

publishUserContact

publishUserContact(legacy?: boolean): Promise<void>

- Defined in Client.ts:216
Parameters
- legacy: boolean = true
Returns Promise<void>

registerCodec

registerCodec(codec: ContentCodec<any>): void

- Defined in Client.ts:300
Parameters
- codec: ContentCodec<any>
Returns void

Static canMessage

canMessage(peerAddress: string, opts?: Partial<NetworkOptions>): Promise<boolean>

- Defined in Client.ts:265
Parameters
- peerAddress: string
- Optional opts: Partial<NetworkOptions>
Returns Promise<boolean>

Static create

create(wallet: null | Signer, opts?: Partial<ClientOptions>): Promise<Client>

- Defined in Client.ts:179
Create and start a client associated with given wallet.

Parameters
- wallet: null | Signer
  
  the wallet as a Signer instance
- Optional opts: Partial<ClientOptions>
  
  specify how to to connect to the network
Returns Promise<Client>

Static getKeys

getKeys(wallet: null | Signer, opts?: Partial<ClientOptions>): Promise<Uint8Array>

- Defined in Client.ts:192
Parameters
- wallet: null | Signer
- Optional opts: Partial<ClientOptions>
Returns Promise<Uint8Array>

Generated using TypeDoc