Class ConversationV2<ContentTypes>

constructor

• new ConversationV2<ContentTypes>(client, topic, peerAddress, createdAt, context, consentProof): ConversationV2<ContentTypes>

• Type Parameters

  • ContentTypes

  Parameters

  • client: Client<ContentTypes>
  • topic: string

    A unique identifier for a conversation. Each conversation is stored on the network on one topic
  • peerAddress: string

    The wallet address of the other party in the conversation
  • createdAt: Date

    Timestamp the conversation was created at
  • context: undefined | InvitationContext

    Optional field containing the conversationId and metadata for V2 conversations. Will always be undefined on V1 conversations
  • consentProof: undefined | ConsentProofPayload

    Proof of consent for the conversation, used when a user has pre-consented to a conversation

  Returns ConversationV2<ContentTypes>

client

OptionalconsentProof

Optionalcontext

conversationVersion

createdAt

peerAddress

topic

clientAddress

• get clientAddress(): string

• The wallet address connected to the client

  Returns string

consentProofPayload

• get consentProofPayload(): undefined | ConsentProofPayload

• Returns undefined | ConsentProofPayload

consentState

• get consentState(): ConsentState

• Returns the consent state of the conversation peer address

  Returns ConsentState

ephemeralTopic

• get ephemeralTopic(): string

• A unique identifier for ephemeral envelopes for a conversation.

  Returns string

isAllowed

• get isAllowed(): boolean

• Returns true if conversation peer address is on the allow list

  Returns boolean

isDenied

• get isDenied(): boolean

• Returns true if conversation peer address is on the deny list

  Returns boolean

allow

• allow(): Promise<void>

• Add conversation peer address to allow list

  Returns Promise<void>

createMessage

• createMessage(payload, shouldPush, timestamp?): Promise<MessageV2>

• Parameters

  • payload: Uint8Array
  • shouldPush: boolean
  • Optionaltimestamp: Date

  Returns Promise<MessageV2>

decodeMessage

• decodeMessage(env): Promise<DecodedMessage<ContentTypes>>

• Takes a XMTP envelope as input and will decrypt and decode it returning a DecodedMessage instance.

  Parameters

  • env: Envelope

  Returns Promise<DecodedMessage<ContentTypes>>

deny

• deny(): Promise<void>

• Add conversation peer address to deny list

  Returns Promise<void>

messages

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

• Returns a list of all messages to/from the peerAddress

  Parameters

  • Optionalopts: ListMessagesOptions

  Returns Promise<DecodedMessage<ContentTypes>[]>

messagesPaginated

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

• Parameters

  • Optionalopts: ListMessagesPaginatedOptions

  Returns AsyncGenerator<DecodedMessage<ContentTypes>[], any, unknown>

  Deprecated

prepareMessage

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

• Return a PreparedMessage that has contains the message ID of the message that will be sent.

  Parameters

  • content: any
  • Optionaloptions: SendOptions

  Returns Promise<PreparedMessage>

processEnvelope

• processEnvelope(env): Promise<MessageV2>

• Parameters

  • env: Envelope

  Returns Promise<MessageV2>

send

• send(content, options?): Promise<DecodedMessage<ContentTypes>>

• Send a message into the conversation

  Parameters

  • content: Exclude<ContentTypes, undefined>
  • Optionaloptions: SendOptions

  Returns Promise<DecodedMessage<ContentTypes>>

streamEphemeral

• streamEphemeral(onConnectionLost?): Promise<Stream<DecodedMessage<ContentTypes>, ContentTypes>>

• 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)
  }
  Copy

  Parameters

  • OptionalonConnectionLost: OnConnectionLostCallback

  Returns Promise<Stream<DecodedMessage<ContentTypes>, ContentTypes>>

streamMessages

• streamMessages(onConnectionLost?): Promise<Stream<DecodedMessage<ContentTypes>, ContentTypes>>

• Returns a Stream of any new messages to/from the peerAddress

  Parameters

  • OptionalonConnectionLost: OnConnectionLostCallback

  Returns Promise<Stream<DecodedMessage<ContentTypes>, ContentTypes>>