Class ConversationV2

ConversationV2

Hierarchy

ConversationV2

Implements

Conversation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ConversationV2(client: Client, topic: string, peerAddress: string, createdAt: Date, context: undefined | InvitationContext): ConversationV2

- Defined in conversations/Conversation.ts:440
Parameters
- client: Client
- topic: string
- peerAddress: string
- createdAt: Date
- context: undefined | InvitationContext
Returns ConversationV2

Properties

client

client: Client

Optional context

context?: InvitationContext

Optional field containing the conversationId and metadata for V2 conversations. Will always be undefined on V1 conversations

conversationVersion

conversationVersion: "v2" = ...

createdAt

createdAt: Date

Timestamp the conversation was created at

peerAddress

peerAddress: string

The wallet address of the other party in the conversation

topic

topic: string

A unique identifier for a conversation. Each conversation is stored on the network on one topic

Accessors

clientAddress

get clientAddress(): string

Implementation of Conversation.clientAddress
- Defined in conversations/Conversation.ts:454
The wallet address connected to the client

Returns string

ephemeralTopic

get ephemeralTopic(): string

Implementation of Conversation.ephemeralTopic
- Defined in conversations/Conversation.ts:481
A unique identifier for ephemeral envelopes for a conversation.

Returns string

Methods

createMessage

createMessage(payload: Uint8Array, timestamp?: Date): Promise<MessageV2>

- Defined in conversations/Conversation.ts:549
Parameters
- payload: Uint8Array
- Optional timestamp: Date
Returns Promise<MessageV2>

decodeMessage

decodeMessage(env: Envelope): Promise<DecodedMessage>

Implementation of Conversation.decodeMessage
- Defined in conversations/Conversation.ts:735
Takes a XMTP envelope as input and will decrypt and decode it returning a DecodedMessage instance.

Parameters
- env: Envelope
Returns Promise<DecodedMessage>

messages

messages(opts?: ListMessagesOptions): Promise<DecodedMessage[]>

Implementation of Conversation.messages
- Defined in conversations/Conversation.ts:461
Returns a list of all messages to/from the peerAddress

Parameters
- Optional opts: ListMessagesOptions
Returns Promise<DecodedMessage[]>

messagesPaginated

messagesPaginated(opts?: ListMessagesPaginatedOptions): AsyncGenerator<DecodedMessage[], any, unknown>

Implementation of Conversation.messagesPaginated
- Defined in conversations/Conversation.ts:471
Parameters
- Optional opts: ListMessagesPaginatedOptions
Returns AsyncGenerator<DecodedMessage[], any, unknown>

prepareMessage

prepareMessage(content: any, options?: SendOptions): Promise<PreparedMessage>

Implementation of Conversation.prepareMessage
- Defined in conversations/Conversation.ts:690
Return a PreparedMessage that has contains the message ID of the message that will be sent.

Parameters
- content: any
- Optional options: SendOptions
Returns Promise<PreparedMessage>

processEnvelope

processEnvelope(env: Envelope): Promise<MessageV2>

- Defined in conversations/Conversation.ts:716
Parameters
- env: Envelope
Returns Promise<MessageV2>

send

send(content: any, options?: SendOptions): Promise<DecodedMessage>

Implementation of Conversation.send
- Defined in conversations/Conversation.ts:515
Send a message into the conversation

Parameters
- content: any
- Optional options: SendOptions
Returns Promise<DecodedMessage>

streamEphemeral

streamEphemeral(onConnectionLost?: OnConnectionLostCallback): Promise<Stream<DecodedMessage>>

Implementation of Conversation.streamEphemeral
- Defined in conversations/Conversation.ts:485
Return a Stream of new ephemeral messages from this conversation's ephemeral topic.
Stream instances are async generators and can be used in for await statements.
```
for await (const message of await conversation.streamEphemeral()) {
   console.log(message.content)
}
```
Parameters
- Optional onConnectionLost: OnConnectionLostCallback
Returns Promise<Stream<DecodedMessage>>

streamMessages

streamMessages(onConnectionLost?: OnConnectionLostCallback): Promise<Stream<DecodedMessage>>

Implementation of Conversation.streamMessages
- Defined in conversations/Conversation.ts:500
Returns a Stream of any new messages to/from the peerAddress

Parameters
- Optional onConnectionLost: OnConnectionLostCallback
Returns Promise<Stream<DecodedMessage>>

Generated using TypeDoc