From c4a045b0f56f1918674259f10ad71ecb42f5d1a2 Mon Sep 17 00:00:00 2001 From: alexrisch Date: Tue, 9 Jan 2024 19:38:29 +0000 Subject: [PATCH] deploy: 5b43135b5bbc19bfa0f50e34a17083f80d22030f --- assets/highlight.css | 35 +++++++++------- classes/Client.html | 24 +++++------ classes/ConsentListEntry.html | 4 +- classes/Conversation.html | 18 ++++---- classes/DecodedMessage.html | 4 +- classes/ReactionCodec.html | 4 +- classes/ReadReceiptCodec.html | 4 +- classes/RemoteAttachmentCodec.html | 4 +- classes/ReplyCodec.html | 4 +- classes/StaticAttachmentCodec.html | 4 +- classes/TextCodec.html | 4 +- classes/XMTPPush.html | 4 +- functions/address.html | 2 +- functions/allowContacts.html | 2 +- functions/auth.html | 2 +- functions/canMessage.html | 2 +- functions/consentList.html | 2 +- functions/conversationConsentState.html | 2 +- functions/createConversation.html | 2 +- functions/createFromKeyBundle.html | 2 +- functions/createRandom.html | 2 +- functions/decodeMessage.html | 2 +- functions/decryptAttachment.html | 2 +- functions/denyContacts.html | 2 +- functions/encryptAttachment.html | 2 +- functions/exportConversationTopicData.html | 2 +- functions/exportKeyBundle.html | 2 +- functions/importConversationTopicData.html | 2 +- functions/isAllowed.html | 2 +- functions/isDenied.html | 2 +- functions/listBatchMessages.html | 2 +- functions/listConversations.html | 2 +- functions/listMessages.html | 2 +- .../preCreateIdentityCallbackCompleted.html | 2 +- .../preEnableIdentityCallbackCompleted.html | 2 +- functions/prepareMessage.html | 2 +- functions/prepareMessageWithContentType.html | 2 +- functions/receiveSignature.html | 2 +- functions/refreshConsentList.html | 2 +- functions/registerPushToken.html | 2 +- functions/sendMessage.html | 2 +- functions/sendPreparedMessage.html | 2 +- functions/sendWithContentType.html | 2 +- functions/staticCanMessage.html | 2 +- functions/subscribePushTopics.html | 2 +- functions/subscribeToAllMessages.html | 2 +- functions/subscribeToConversations.html | 2 +- functions/subscribeToMessages.html | 2 +- functions/unsubscribeFromAllMessages.html | 2 +- functions/unsubscribeFromConversations.html | 2 +- functions/unsubscribeFromMessages.html | 2 +- functions/useClient.html | 2 +- functions/useXmtp.html | 2 +- index.html | 42 +++++++++++-------- interfaces/JSContentCodec.html | 4 +- interfaces/NativeContentCodec.html | 4 +- interfaces/XmtpContextValue.html | 6 +-- modules/XmtpProvider.html | 2 +- types/ContentCodec.html | 2 +- types/ContentTypeId.html | 2 +- types/ConversationContext.html | 2 +- types/DecryptedLocalAttachment.html | 2 +- types/EncodedContent.html | 2 +- types/EncryptedLocalAttachment.html | 2 +- types/NativeMessageContent.html | 2 +- types/PreparedLocalMessage.html | 2 +- types/Query.html | 2 +- types/ReactionContent.html | 2 +- types/ReadReceiptContent.html | 2 +- types/RemoteAttachmentContent.html | 2 +- types/RemoteAttachmentMetadata.html | 2 +- types/ReplyContent.html | 2 +- types/StaticAttachmentContent.html | 2 +- types/UnknownContent.html | 2 +- variables/XmtpContext.html | 2 +- variables/emitter.html | 2 +- 76 files changed, 151 insertions(+), 138 deletions(-) diff --git a/assets/highlight.css b/assets/highlight.css index d35dfd4a4..af166f0fe 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -5,20 +5,22 @@ --dark-hl-1: #D4D4D4; --light-hl-2: #A31515; --dark-hl-2: #CE9178; - --light-hl-3: #AF00DB; - --dark-hl-3: #C586C0; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; - --light-hl-5: #008000; - --dark-hl-5: #6A9955; - --light-hl-6: #0000FF; - --dark-hl-6: #569CD6; - --light-hl-7: #0070C1; - --dark-hl-7: #4FC1FF; - --light-hl-8: #000000FF; - --dark-hl-8: #D4D4D4; - --light-hl-9: #098658; - --dark-hl-9: #B5CEA8; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #267F99; + --dark-hl-4: #4EC9B0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #AF00DB; + --dark-hl-7: #C586C0; + --light-hl-8: #0070C1; + --dark-hl-8: #4FC1FF; + --light-hl-9: #000000FF; + --dark-hl-9: #D4D4D4; + --light-hl-10: #098658; + --dark-hl-10: #B5CEA8; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -34,6 +36,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } } @@ -48,6 +51,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } } @@ -62,6 +66,7 @@ --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); --code-background: var(--light-code-background); } @@ -76,6 +81,7 @@ --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); --code-background: var(--dark-code-background); } @@ -89,4 +95,5 @@ .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } .hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } pre, code { background: var(--code-background); } diff --git a/classes/Client.html b/classes/Client.html index 09bc95c78..b8560cb37 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -1,4 +1,4 @@ -Client | @xmtp/react-native-sdk

Class Client<ContentTypes>

Type Parameters

  • ContentTypes

Constructors

constructor +Client | @xmtp/react-native-sdk

Class Client<ContentTypes>

Type Parameters

  • ContentTypes

Constructors

constructor

Properties

address codecRegistry contacts @@ -14,52 +14,52 @@ create createFromKeyBundle createRandom -

Constructors

constructor

Properties

address

address: string

codecRegistry

codecRegistry: {
    [key: string]: ContentCodec<unknown>;
}

Type declaration

contacts

contacts: default

conversations

conversations: default<ContentTypes>

Methods

canMessage

  • canMessage(peerAddress): Promise<boolean>

  • Determines whether the current user can send messages to a specified peer.

    +

Constructors

constructor

Properties

address

address: string

codecRegistry

codecRegistry: {
    [key: string]: ContentCodec<unknown>;
}

Type declaration

contacts

contacts: default

conversations

conversations: default<ContentTypes>

Methods

canMessage

  • canMessage(peerAddress): Promise<boolean>

  • Determines whether the current user can send messages to a specified peer.

    This method checks if the specified peer has signed up for XMTP and ensures that the message is not addressed to the sender (no self-messaging).

    Parameters

    • peerAddress: string

      The address of the peer to check for messaging eligibility.

    Returns Promise<boolean>

    A Promise resolving to true if messaging is allowed, and false otherwise.

    -

decryptAttachment

decryptAttachment

  • decryptAttachment(encryptedFile): Promise<DecryptedLocalAttachment>

  • Decrypts an encrypted local attachment.

    This asynchronous method takes an encrypted local attachment and decrypts it.

    Parameters

    Returns Promise<DecryptedLocalAttachment>

    A Promise that resolves to the decrypted local attachment.

    Throws

    Throws an error if the attachment is not a local file URI (must start with "file://").

    -

encryptAttachment

encryptAttachment

  • encryptAttachment(file): Promise<EncryptedLocalAttachment>

  • Encrypts a local attachment for secure transmission.

    This asynchronous method takes a file, checks if it's a local file URI, and encrypts the attachment for secure transmission.

    Parameters

    Returns Promise<EncryptedLocalAttachment>

    A Promise that resolves to the encrypted local attachment.

    Throws

    Throws an error if the attachment is not a local file URI (must start with "file://").

    -

exportKeyBundle

  • exportKeyBundle(): Promise<string>

  • Exports the key bundle associated with the current XMTP address.

    +

exportKeyBundle

  • exportKeyBundle(): Promise<string>

  • Exports the key bundle associated with the current XMTP address.

    This method allows you to obtain the unencrypted key bundle for the current XMTP address. Ensure the exported keys are stored securely and encrypted.

    Returns Promise<string>

    A Promise that resolves to the unencrypted key bundle for the current XMTP address.

    -

listBatchMessages

listBatchMessages

  • listBatchMessages(queries): Promise<DecodedMessage<any>[]>

  • Retrieves a list of batch messages based on the provided queries.

    This method pulls messages associated from multiple conversation with the current address and specified queries.

    Parameters

    • queries: Query[]

      An array of queries to filter the batch messages.

    Returns Promise<DecodedMessage<any>[]>

    A Promise that resolves to a list of batch messages.

    Throws

    The error is logged, and the method gracefully returns an empty array.

    -

register

sendPreparedMessage

  • sendPreparedMessage(prepared): Promise<string>

  • Sends a prepared message.

    +

register

sendPreparedMessage

  • sendPreparedMessage(prepared): Promise<string>

  • Sends a prepared message.

    Parameters

    Returns Promise<string>

    A Promise that resolves to a string identifier for the sent message.

    Throws

    Throws an error if there is an issue with sending the prepared message.

    -

Static canMessage

  • canMessage(peerAddress, opts?): Promise<boolean>

  • Static method to determine if the address is currently in our network.

    +

Static canMessage

  • canMessage(peerAddress, opts?): Promise<boolean>

  • Static method to determine if the address is currently in our network.

    This method checks if the specified peer has signed up for XMTP.

    Parameters

    • peerAddress: string

      The address of the peer to check for messaging eligibility.

    • Optional opts: Partial<ClientOptions>

      Optional configuration options for the Client.

      -

    Returns Promise<boolean>

Static create

  • create<ContentCodecs>(signer, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the Client class using the provided signer.

    +

Returns Promise<boolean>

Static create

  • create<ContentCodecs>(signer, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the Client class using the provided signer.

    Type Parameters

    Parameters

    • signer: Signer

      The signer object used for authentication and message signing.

    • Optional opts: Partial<ClientOptions> & {
          codecs?: ContentCodecs;
      }

      Optional configuration options for the Client.

    Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

    A Promise that resolves to a new Client instance.

    See XMTP Docs for more information.

    -

Static createFromKeyBundle

  • createFromKeyBundle<ContentCodecs>(keyBundle, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the Client class from a provided key bundle.

    +

Static createFromKeyBundle

  • createFromKeyBundle<ContentCodecs>(keyBundle, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the Client class from a provided key bundle.

    This method is useful for scenarios where you want to manually handle private key storage, allowing the application to have access to XMTP keys without exposing wallet keys.

    Type Parameters

    Parameters

    • keyBundle: string

      The key bundle used for address generation.

    • Optional opts: Partial<ClientOptions> & {
          codecs?: ContentCodecs;
      }

      Optional configuration options for the Client.

    Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

    A Promise that resolves to a new Client instance based on the provided key bundle.

    -

Static createRandom

  • createRandom<ContentCodecs>(opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the XMTP Client with a randomly generated address.

    +

Static createRandom

  • createRandom<ContentCodecs>(opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

  • Creates a new instance of the XMTP Client with a randomly generated address.

    Type Parameters

    Parameters

    • Optional opts: Partial<ClientOptions> & {
          codecs?: ContentCodecs;
      }

      Optional configuration options for the Client.

    Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

    A Promise that resolves to a new Client instance with a random address.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ConsentListEntry.html b/classes/ConsentListEntry.html index 311a0f40b..78bff90d5 100644 --- a/classes/ConsentListEntry.html +++ b/classes/ConsentListEntry.html @@ -1,6 +1,6 @@ -ConsentListEntry | @xmtp/react-native-sdk

Class ConsentListEntry

Constructors

constructor +ConsentListEntry | @xmtp/react-native-sdk

Class ConsentListEntry

Constructors

constructor

Properties

entryType permissionType value

Methods

from -

Constructors

constructor

Properties

entryType

entryType: "address"

permissionType

permissionType: ConsentState

value

value: string

Methods

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

entryType

entryType: "address"

permissionType

permissionType: ConsentState

value

value: string

Methods

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Conversation.html b/classes/Conversation.html index 2b9533901..6e0246b9c 100644 --- a/classes/Conversation.html +++ b/classes/Conversation.html @@ -1,4 +1,4 @@ -Conversation | @xmtp/react-native-sdk

Class Conversation<ContentTypes>

Type Parameters

  • ContentTypes

Constructors

constructor +Conversation | @xmtp/react-native-sdk

Class Conversation<ContentTypes>

Type Parameters

  • ContentTypes

Constructors

constructor

Properties

client context? conversationID? @@ -15,18 +15,18 @@ send sendPreparedMessage streamMessages -

Constructors

constructor

  • new Conversation<ContentTypes>(client, params): Conversation<ContentTypes>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • params: {
          context?: ConversationContext;
          conversationID?: string;
          createdAt: number;
          peerAddress: string;
          topic: string;
          version: string;
      }
      • Optional context?: ConversationContext
      • Optional conversationID?: string
      • createdAt: number
      • peerAddress: string
      • topic: string
      • version: string

    Returns Conversation<ContentTypes>

Properties

client

client: Client<ContentTypes>

Optional context

context?: ConversationContext

Optional conversationID

conversationID?: string

createdAt

createdAt: number

peerAddress

peerAddress: string

topic

topic: string

version

version: string

Accessors

clientAddress

Methods

consentState

  • consentState(): Promise<"allowed" | "denied" | "unknown">

  • Retrieves the consent state for the current conversation.

    +

Constructors

constructor

  • new Conversation<ContentTypes>(client, params): Conversation<ContentTypes>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • params: {
          context?: ConversationContext;
          conversationID?: string;
          createdAt: number;
          peerAddress: string;
          topic: string;
          version: string;
      }
      • Optional context?: ConversationContext
      • Optional conversationID?: string
      • createdAt: number
      • peerAddress: string
      • topic: string
      • version: string

    Returns Conversation<ContentTypes>

Properties

client

client: Client<ContentTypes>

Optional context

context?: ConversationContext

Optional conversationID

conversationID?: string

createdAt

createdAt: number

peerAddress

peerAddress: string

topic

topic: string

version

version: string

Accessors

clientAddress

Methods

consentState

  • consentState(): Promise<"allowed" | "denied" | "unknown">

  • Retrieves the consent state for the current conversation.

    This asynchronous method determine the consent state for the current conversation, indicating whether the user has allowed, denied, or is yet to provide consent.

    Returns Promise<"allowed" | "denied" | "unknown">

    A Promise that resolves to the consent state, which can be "allowed," "denied," or "unknown."

    -

decodeMessage

decodeMessage

  • decodeMessage(encryptedMessage): Promise<DecodedMessage<any>>

  • Decodes an encrypted message, yielding a DecodedMessage object.

    This asynchronous method takes an encrypted message and decodes it. The result is a DecodedMessage object containing the decoded content and metadata.

    Parameters

    • encryptedMessage: string

      The encrypted message to be decoded.

    Returns Promise<DecodedMessage<any>>

    A Promise that resolves to a DecodedMessage object.

    Throws

    Throws an error if there is an issue with decoding the message.

    -

exportTopicData

messages

exportTopicData

messages

  • messages(limit?, before?, after?, direction?): Promise<DecodedMessage<ContentTypes>[]>

  • Lists messages in a conversation with optional filters.

    Parameters

    • Optional limit: number

      Optional limit to the number of messages to return.

    • Optional before: number | Date

      Optional timestamp to filter messages before.

    • Optional after: number | Date

      Optional timestamp to filter messages after.

      @@ -34,7 +34,7 @@

    Returns Promise<DecodedMessage<ContentTypes>[]>

    A Promise that resolves to an array of decoded messages.

    Throws

    Throws an error if there is an issue with listing messages.

    Todo

    Support pagination and conversation ID in future implementations.

    -

prepareMessage

prepareMessage

  • prepareMessage(content, opts?): Promise<PreparedLocalMessage>

  • Prepares a message to be sent, yielding a PreparedLocalMessage object.

    Instead of immediately sending a message, you can prepare it first using this method. This yields a PreparedLocalMessage object, which you can send later. This is useful to help construct a robust pending-message queue @@ -44,18 +44,18 @@

    Todo

    Support pagination and conversation ID in future implementations

    Parameters

    • content: any

      The content of the message. It can be either a string or a structured MessageContent object.

    • Optional opts: SendOptions

    Returns Promise<PreparedLocalMessage>

    A Promise that resolves to a PreparedLocalMessage object.

    Throws

    Throws an error if there is an issue with preparing the message.

    -

send

send

  • send(content, opts?): Promise<string>

  • Sends a message to the current conversation.

    Parameters

    • content: any

      The content of the message. It can be either a string or a structured MessageContent object.

    • Optional opts: SendOptions

    Returns Promise<string>

    A Promise that resolves to a string identifier for the sent message.

    Throws

    Throws an error if there is an issue with sending the message.

    Todo

    Support specifying a conversation ID in future implementations.

    -

sendPreparedMessage

sendPreparedMessage

  • sendPreparedMessage(prepared): Promise<string>

  • Sends a prepared local message.

    This asynchronous method takes a PreparedLocalMessage and sends it. Prepared messages are created using the prepareMessage method.

    Parameters

    Returns Promise<string>

    A Promise that resolves to a string identifier for the sent message.

    Throws

    Throws an error if there is an issue with sending the prepared message.

    -

streamMessages

  • streamMessages(callback): (() => void)

  • Sets up a real-time message stream for the current conversation.

    +

streamMessages

  • streamMessages(callback): (() => void)

  • Sets up a real-time message stream for the current conversation.

    This method subscribes to incoming messages in real-time and listens for new message events. When a new message is detected, the provided callback function is invoked with the details of the message. Additionally, this method returns a function that can be called to unsubscribe and end the message stream.

    @@ -66,4 +66,4 @@

    Todo

    Support specifying a conversation ID in future implementations.< When a new message is detected, the provided callback function is invoked with the details of the message. Additionally, this method returns a function that can be called to unsubscribe and end the message stream.

    Returns void

    A function that, when called, unsubscribes from the message stream and ends real-time updates.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DecodedMessage.html b/classes/DecodedMessage.html index 9867847d9..7f64f1ad9 100644 --- a/classes/DecodedMessage.html +++ b/classes/DecodedMessage.html @@ -1,4 +1,4 @@ -DecodedMessage | @xmtp/react-native-sdk

Class DecodedMessage<ContentTypes>

Type Parameters

  • ContentTypes = any

Constructors

constructor +DecodedMessage | @xmtp/react-native-sdk

Class DecodedMessage<ContentTypes>

Type Parameters

  • ContentTypes = any

Constructors

constructor

Properties

client contentTypeId fallback @@ -10,4 +10,4 @@

Methods

content from fromObject -

Constructors

constructor

  • new DecodedMessage<ContentTypes>(client, id, topic, contentTypeId, senderAddress, sent, content, fallback): DecodedMessage<ContentTypes>

  • Type Parameters

    • ContentTypes = any

    Parameters

    • client: Client<ContentTypes>
    • id: string
    • topic: string
    • contentTypeId: string
    • senderAddress: string
    • sent: number
    • content: any
    • fallback: undefined | string

    Returns DecodedMessage<ContentTypes>

Properties

client

client: Client<ContentTypes>

contentTypeId

contentTypeId: string

fallback

fallback: undefined | string

id

id: string

nativeContent

nativeContent: NativeMessageContent

senderAddress

senderAddress: string

sent

sent: number

topic

topic: string

Methods

content

Static from

Static fromObject

  • fromObject<ContentTypes>(object, client): DecodedMessage<ContentTypes>

  • Type Parameters

    • ContentTypes

    Parameters

    • object: {
          content: any;
          contentTypeId: string;
          fallback: undefined | string;
          id: string;
          senderAddress: string;
          sent: number;
          topic: string;
      }
      • content: any
      • contentTypeId: string
      • fallback: undefined | string
      • id: string
      • senderAddress: string
      • sent: number
      • topic: string
    • client: Client<ContentTypes>

    Returns DecodedMessage<ContentTypes>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new DecodedMessage<ContentTypes>(client, id, topic, contentTypeId, senderAddress, sent, content, fallback): DecodedMessage<ContentTypes>

  • Type Parameters

    • ContentTypes = any

    Parameters

    • client: Client<ContentTypes>
    • id: string
    • topic: string
    • contentTypeId: string
    • senderAddress: string
    • sent: number
    • content: any
    • fallback: undefined | string

    Returns DecodedMessage<ContentTypes>

Properties

client

client: Client<ContentTypes>

contentTypeId

contentTypeId: string

fallback

fallback: undefined | string

id

id: string

nativeContent

nativeContent: NativeMessageContent

senderAddress

senderAddress: string

sent

sent: number

topic

topic: string

Methods

content

Static from

Static fromObject

  • fromObject<ContentTypes>(object, client): DecodedMessage<ContentTypes>

  • Type Parameters

    • ContentTypes

    Parameters

    • object: {
          content: any;
          contentTypeId: string;
          fallback: undefined | string;
          id: string;
          senderAddress: string;
          sent: number;
          topic: string;
      }
      • content: any
      • contentTypeId: string
      • fallback: undefined | string
      • id: string
      • senderAddress: string
      • sent: number
      • topic: string
    • client: Client<ContentTypes>

    Returns DecodedMessage<ContentTypes>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ReactionCodec.html b/classes/ReactionCodec.html index fb1da6e88..30bf5ad85 100644 --- a/classes/ReactionCodec.html +++ b/classes/ReactionCodec.html @@ -1,7 +1,7 @@ -ReactionCodec | @xmtp/react-native-sdk

Class ReactionCodec

Implements

Constructors

constructor +ReactionCodec | @xmtp/react-native-sdk

Class ReactionCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'reaction'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'reaction'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ReadReceiptCodec.html b/classes/ReadReceiptCodec.html index 2bacda547..2bce50d16 100644 --- a/classes/ReadReceiptCodec.html +++ b/classes/ReadReceiptCodec.html @@ -1,7 +1,7 @@ -ReadReceiptCodec | @xmtp/react-native-sdk

Class ReadReceiptCodec

Implements

Constructors

constructor +ReadReceiptCodec | @xmtp/react-native-sdk

Class ReadReceiptCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'readReceipt'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'readReceipt'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/RemoteAttachmentCodec.html b/classes/RemoteAttachmentCodec.html index 327fadff5..d9ea9e2e9 100644 --- a/classes/RemoteAttachmentCodec.html +++ b/classes/RemoteAttachmentCodec.html @@ -1,7 +1,7 @@ -RemoteAttachmentCodec | @xmtp/react-native-sdk

Class RemoteAttachmentCodec

Implements

Constructors

constructor +RemoteAttachmentCodec | @xmtp/react-native-sdk

Class RemoteAttachmentCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'remoteAttachment'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'remoteAttachment'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/ReplyCodec.html b/classes/ReplyCodec.html index 4a9e6298e..d7b9cfba8 100644 --- a/classes/ReplyCodec.html +++ b/classes/ReplyCodec.html @@ -1,7 +1,7 @@ -ReplyCodec | @xmtp/react-native-sdk

Class ReplyCodec

Implements

Constructors

constructor +ReplyCodec | @xmtp/react-native-sdk

Class ReplyCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'reply'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'reply'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/StaticAttachmentCodec.html b/classes/StaticAttachmentCodec.html index 57225c622..2968bf7eb 100644 --- a/classes/StaticAttachmentCodec.html +++ b/classes/StaticAttachmentCodec.html @@ -1,7 +1,7 @@ -StaticAttachmentCodec | @xmtp/react-native-sdk

Class StaticAttachmentCodec

Implements

Constructors

constructor +StaticAttachmentCodec | @xmtp/react-native-sdk

Class StaticAttachmentCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'attachment'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'attachment'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/TextCodec.html b/classes/TextCodec.html index 6c544f1f2..93180f972 100644 --- a/classes/TextCodec.html +++ b/classes/TextCodec.html @@ -1,7 +1,7 @@ -TextCodec | @xmtp/react-native-sdk

Class TextCodec

Implements

Constructors

constructor +TextCodec | @xmtp/react-native-sdk

Class TextCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: string = 'text'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

contentKey

contentKey: string = 'text'

contentType

contentType: ContentTypeId = ...

Methods

decode

encode

fallback

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/XMTPPush.html b/classes/XMTPPush.html index 7b8334ab7..17223c9d3 100644 --- a/classes/XMTPPush.html +++ b/classes/XMTPPush.html @@ -1,4 +1,4 @@ -XMTPPush | @xmtp/react-native-sdk

Class XMTPPush

Constructors

constructor +XMTPPush | @xmtp/react-native-sdk

Class XMTPPush

Constructors

constructor

Methods

register subscribe -

Constructors

constructor

Methods

Static register

  • register(server, token): void

  • Parameters

    • server: string
    • token: string

    Returns void

Static subscribe

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static register

  • register(server, token): void

  • Parameters

    • server: string
    • token: string

    Returns void

Static subscribe

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/address.html b/functions/address.html index e83e9f8d2..c593da36f 100644 --- a/functions/address.html +++ b/functions/address.html @@ -1 +1 @@ -address | @xmtp/react-native-sdk

Function address

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +address | @xmtp/react-native-sdk

Function address

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/allowContacts.html b/functions/allowContacts.html index 7c41acd83..ffb0749cf 100644 --- a/functions/allowContacts.html +++ b/functions/allowContacts.html @@ -1 +1 @@ -allowContacts | @xmtp/react-native-sdk

Function allowContacts

  • allowContacts(clientAddress, addresses): Promise<void>

  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +allowContacts | @xmtp/react-native-sdk

Function allowContacts

  • allowContacts(clientAddress, addresses): Promise<void>

  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/auth.html b/functions/auth.html index 2ab1991e3..ddd34c5be 100644 --- a/functions/auth.html +++ b/functions/auth.html @@ -1 +1 @@ -auth | @xmtp/react-native-sdk

Function auth

  • auth(address, environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?): Promise<any>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +auth | @xmtp/react-native-sdk

Function auth

  • auth(address, environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?): Promise<any>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/canMessage.html b/functions/canMessage.html index c82cbce89..af3f15e75 100644 --- a/functions/canMessage.html +++ b/functions/canMessage.html @@ -1 +1 @@ -canMessage | @xmtp/react-native-sdk

Function canMessage

  • canMessage(clientAddress, peerAddress): Promise<boolean>

  • Parameters

    • clientAddress: string
    • peerAddress: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +canMessage | @xmtp/react-native-sdk

Function canMessage

  • canMessage(clientAddress, peerAddress): Promise<boolean>

  • Parameters

    • clientAddress: string
    • peerAddress: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/consentList.html b/functions/consentList.html index 82e93e457..f1feb28ae 100644 --- a/functions/consentList.html +++ b/functions/consentList.html @@ -1 +1 @@ -consentList | @xmtp/react-native-sdk

Function consentList

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +consentList | @xmtp/react-native-sdk

Function consentList

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/conversationConsentState.html b/functions/conversationConsentState.html index 16079a4e8..5b786f567 100644 --- a/functions/conversationConsentState.html +++ b/functions/conversationConsentState.html @@ -1 +1 @@ -conversationConsentState | @xmtp/react-native-sdk

Function conversationConsentState

  • conversationConsentState(clientAddress, conversationTopic): Promise<ConsentState>

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<ConsentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +conversationConsentState | @xmtp/react-native-sdk

Function conversationConsentState

  • conversationConsentState(clientAddress, conversationTopic): Promise<ConsentState>

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<ConsentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createConversation.html b/functions/createConversation.html index adab981d8..3fb847930 100644 --- a/functions/createConversation.html +++ b/functions/createConversation.html @@ -1 +1 @@ -createConversation | @xmtp/react-native-sdk

Function createConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createConversation | @xmtp/react-native-sdk

Function createConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createFromKeyBundle.html b/functions/createFromKeyBundle.html index f0068b1d1..94f93b1ac 100644 --- a/functions/createFromKeyBundle.html +++ b/functions/createFromKeyBundle.html @@ -1 +1 @@ -createFromKeyBundle | @xmtp/react-native-sdk

Function createFromKeyBundle

  • createFromKeyBundle(keyBundle, environment, appVersion?): Promise<string>

  • Parameters

    • keyBundle: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createFromKeyBundle | @xmtp/react-native-sdk

Function createFromKeyBundle

  • createFromKeyBundle(keyBundle, environment, appVersion?): Promise<string>

  • Parameters

    • keyBundle: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createRandom.html b/functions/createRandom.html index b0bf2ccc7..2ba6bf616 100644 --- a/functions/createRandom.html +++ b/functions/createRandom.html @@ -1 +1 @@ -createRandom | @xmtp/react-native-sdk

Function createRandom

  • createRandom(environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?): Promise<string>

  • Parameters

    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createRandom | @xmtp/react-native-sdk

Function createRandom

  • createRandom(environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?): Promise<string>

  • Parameters

    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/decodeMessage.html b/functions/decodeMessage.html index 4d17e0b2e..a36eed073 100644 --- a/functions/decodeMessage.html +++ b/functions/decodeMessage.html @@ -1 +1 @@ -decodeMessage | @xmtp/react-native-sdk

Function decodeMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +decodeMessage | @xmtp/react-native-sdk

Function decodeMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/decryptAttachment.html b/functions/decryptAttachment.html index 5f8f5f427..04a648fc6 100644 --- a/functions/decryptAttachment.html +++ b/functions/decryptAttachment.html @@ -1 +1 @@ -decryptAttachment | @xmtp/react-native-sdk

Function decryptAttachment

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +decryptAttachment | @xmtp/react-native-sdk

Function decryptAttachment

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/denyContacts.html b/functions/denyContacts.html index c9a553f69..1fde66c01 100644 --- a/functions/denyContacts.html +++ b/functions/denyContacts.html @@ -1 +1 @@ -denyContacts | @xmtp/react-native-sdk

Function denyContacts

  • denyContacts(clientAddress, addresses): Promise<void>

  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +denyContacts | @xmtp/react-native-sdk

Function denyContacts

  • denyContacts(clientAddress, addresses): Promise<void>

  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/encryptAttachment.html b/functions/encryptAttachment.html index 07d27809a..ae88b2b98 100644 --- a/functions/encryptAttachment.html +++ b/functions/encryptAttachment.html @@ -1 +1 @@ -encryptAttachment | @xmtp/react-native-sdk

Function encryptAttachment

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +encryptAttachment | @xmtp/react-native-sdk

Function encryptAttachment

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/exportConversationTopicData.html b/functions/exportConversationTopicData.html index dc32be708..ad7700e87 100644 --- a/functions/exportConversationTopicData.html +++ b/functions/exportConversationTopicData.html @@ -1 +1 @@ -exportConversationTopicData | @xmtp/react-native-sdk

Function exportConversationTopicData

  • exportConversationTopicData(clientAddress, conversationTopic): Promise<string>

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +exportConversationTopicData | @xmtp/react-native-sdk

Function exportConversationTopicData

  • exportConversationTopicData(clientAddress, conversationTopic): Promise<string>

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/exportKeyBundle.html b/functions/exportKeyBundle.html index 49c3384c2..8bf56d885 100644 --- a/functions/exportKeyBundle.html +++ b/functions/exportKeyBundle.html @@ -1 +1 @@ -exportKeyBundle | @xmtp/react-native-sdk

Function exportKeyBundle

  • exportKeyBundle(clientAddress): Promise<string>

  • Parameters

    • clientAddress: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +exportKeyBundle | @xmtp/react-native-sdk

Function exportKeyBundle

  • exportKeyBundle(clientAddress): Promise<string>

  • Parameters

    • clientAddress: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/importConversationTopicData.html b/functions/importConversationTopicData.html index 83853a1bc..0c9c55c4a 100644 --- a/functions/importConversationTopicData.html +++ b/functions/importConversationTopicData.html @@ -1 +1 @@ -importConversationTopicData | @xmtp/react-native-sdk

Function importConversationTopicData

  • importConversationTopicData<ContentTypes>(client, topicData): Promise<Conversation<ContentTypes>>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • topicData: string

    Returns Promise<Conversation<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +importConversationTopicData | @xmtp/react-native-sdk

Function importConversationTopicData

  • importConversationTopicData<ContentTypes>(client, topicData): Promise<Conversation<ContentTypes>>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • topicData: string

    Returns Promise<Conversation<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isAllowed.html b/functions/isAllowed.html index 61f1ca5e9..70309f357 100644 --- a/functions/isAllowed.html +++ b/functions/isAllowed.html @@ -1 +1 @@ -isAllowed | @xmtp/react-native-sdk

Function isAllowed

  • isAllowed(clientAddress, address): Promise<boolean>

  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +isAllowed | @xmtp/react-native-sdk

Function isAllowed

  • isAllowed(clientAddress, address): Promise<boolean>

  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isDenied.html b/functions/isDenied.html index 64482508e..d040d04c1 100644 --- a/functions/isDenied.html +++ b/functions/isDenied.html @@ -1 +1 @@ -isDenied | @xmtp/react-native-sdk

Function isDenied

  • isDenied(clientAddress, address): Promise<boolean>

  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +isDenied | @xmtp/react-native-sdk

Function isDenied

  • isDenied(clientAddress, address): Promise<boolean>

  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listBatchMessages.html b/functions/listBatchMessages.html index 42ff1c71e..6dceb4e92 100644 --- a/functions/listBatchMessages.html +++ b/functions/listBatchMessages.html @@ -1 +1 @@ -listBatchMessages | @xmtp/react-native-sdk

Function listBatchMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +listBatchMessages | @xmtp/react-native-sdk

Function listBatchMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listConversations.html b/functions/listConversations.html index 33a59caa3..dd5eeec91 100644 --- a/functions/listConversations.html +++ b/functions/listConversations.html @@ -1 +1 @@ -listConversations | @xmtp/react-native-sdk

Function listConversations

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +listConversations | @xmtp/react-native-sdk

Function listConversations

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listMessages.html b/functions/listMessages.html index 1dcc856e8..30217e301 100644 --- a/functions/listMessages.html +++ b/functions/listMessages.html @@ -1 +1 @@ -listMessages | @xmtp/react-native-sdk

Function listMessages

  • listMessages<ContentTypes>(client, conversationTopic, limit?, before?, after?, direction?): Promise<DecodedMessage[]>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • conversationTopic: string
    • Optional limit: number
    • Optional before: number | Date
    • Optional after: number | Date
    • Optional direction: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"

    Returns Promise<DecodedMessage[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +listMessages | @xmtp/react-native-sdk

Function listMessages

  • listMessages<ContentTypes>(client, conversationTopic, limit?, before?, after?, direction?): Promise<DecodedMessage[]>

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • conversationTopic: string
    • Optional limit: number
    • Optional before: number | Date
    • Optional after: number | Date
    • Optional direction: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"

    Returns Promise<DecodedMessage[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/preCreateIdentityCallbackCompleted.html b/functions/preCreateIdentityCallbackCompleted.html index f84845efe..94efc3deb 100644 --- a/functions/preCreateIdentityCallbackCompleted.html +++ b/functions/preCreateIdentityCallbackCompleted.html @@ -1 +1 @@ -preCreateIdentityCallbackCompleted | @xmtp/react-native-sdk

Function preCreateIdentityCallbackCompleted

  • preCreateIdentityCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +preCreateIdentityCallbackCompleted | @xmtp/react-native-sdk

Function preCreateIdentityCallbackCompleted

  • preCreateIdentityCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/preEnableIdentityCallbackCompleted.html b/functions/preEnableIdentityCallbackCompleted.html index eba5c33c7..a406b41bb 100644 --- a/functions/preEnableIdentityCallbackCompleted.html +++ b/functions/preEnableIdentityCallbackCompleted.html @@ -1 +1 @@ -preEnableIdentityCallbackCompleted | @xmtp/react-native-sdk

Function preEnableIdentityCallbackCompleted

  • preEnableIdentityCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +preEnableIdentityCallbackCompleted | @xmtp/react-native-sdk

Function preEnableIdentityCallbackCompleted

  • preEnableIdentityCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareMessage.html b/functions/prepareMessage.html index 581673edb..337c5164e 100644 --- a/functions/prepareMessage.html +++ b/functions/prepareMessage.html @@ -1 +1 @@ -prepareMessage | @xmtp/react-native-sdk

Function prepareMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +prepareMessage | @xmtp/react-native-sdk

Function prepareMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareMessageWithContentType.html b/functions/prepareMessageWithContentType.html index 2eab05edd..34887c6fe 100644 --- a/functions/prepareMessageWithContentType.html +++ b/functions/prepareMessageWithContentType.html @@ -1 +1 @@ -prepareMessageWithContentType | @xmtp/react-native-sdk

Function prepareMessageWithContentType

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +prepareMessageWithContentType | @xmtp/react-native-sdk

Function prepareMessageWithContentType

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/receiveSignature.html b/functions/receiveSignature.html index 1a0aaf8e9..f67a9ed78 100644 --- a/functions/receiveSignature.html +++ b/functions/receiveSignature.html @@ -1 +1 @@ -receiveSignature | @xmtp/react-native-sdk

Function receiveSignature

  • receiveSignature(requestID, signature): Promise<any>

  • Parameters

    • requestID: string
    • signature: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +receiveSignature | @xmtp/react-native-sdk

Function receiveSignature

  • receiveSignature(requestID, signature): Promise<any>

  • Parameters

    • requestID: string
    • signature: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/refreshConsentList.html b/functions/refreshConsentList.html index 9a1878ab4..b2ccdc98a 100644 --- a/functions/refreshConsentList.html +++ b/functions/refreshConsentList.html @@ -1 +1 @@ -refreshConsentList | @xmtp/react-native-sdk

Function refreshConsentList

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +refreshConsentList | @xmtp/react-native-sdk

Function refreshConsentList

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/registerPushToken.html b/functions/registerPushToken.html index 47446c0c1..bd58f1882 100644 --- a/functions/registerPushToken.html +++ b/functions/registerPushToken.html @@ -1 +1 @@ -registerPushToken | @xmtp/react-native-sdk

Function registerPushToken

  • registerPushToken(pushServer, token): any

  • Parameters

    • pushServer: string
    • token: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +registerPushToken | @xmtp/react-native-sdk

Function registerPushToken

  • registerPushToken(pushServer, token): any

  • Parameters

    • pushServer: string
    • token: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendMessage.html b/functions/sendMessage.html index abf4e12bd..4e56869f6 100644 --- a/functions/sendMessage.html +++ b/functions/sendMessage.html @@ -1 +1 @@ -sendMessage | @xmtp/react-native-sdk

Function sendMessage

  • sendMessage(clientAddress, conversationTopic, content): Promise<string>

  • Parameters

    • clientAddress: string
    • conversationTopic: string
    • content: any

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +sendMessage | @xmtp/react-native-sdk

Function sendMessage

  • sendMessage(clientAddress, conversationTopic, content): Promise<string>

  • Parameters

    • clientAddress: string
    • conversationTopic: string
    • content: any

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendPreparedMessage.html b/functions/sendPreparedMessage.html index 06717ffe4..25d4a8cf3 100644 --- a/functions/sendPreparedMessage.html +++ b/functions/sendPreparedMessage.html @@ -1 +1 @@ -sendPreparedMessage | @xmtp/react-native-sdk

Function sendPreparedMessage

  • sendPreparedMessage(clientAddress, preparedLocalMessage): Promise<string>

  • Parameters

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +sendPreparedMessage | @xmtp/react-native-sdk

Function sendPreparedMessage

  • sendPreparedMessage(clientAddress, preparedLocalMessage): Promise<string>

  • Parameters

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendWithContentType.html b/functions/sendWithContentType.html index bd1cb23ef..cde06f4aa 100644 --- a/functions/sendWithContentType.html +++ b/functions/sendWithContentType.html @@ -1 +1 @@ -sendWithContentType | @xmtp/react-native-sdk

Function sendWithContentType

  • sendWithContentType<T>(clientAddress, conversationTopic, content, codec): Promise<string>

  • Type Parameters

    • T

    Parameters

    • clientAddress: string
    • conversationTopic: string
    • content: T
    • codec: ContentCodec<T>

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +sendWithContentType | @xmtp/react-native-sdk

Function sendWithContentType

  • sendWithContentType<T>(clientAddress, conversationTopic, content, codec): Promise<string>

  • Type Parameters

    • T

    Parameters

    • clientAddress: string
    • conversationTopic: string
    • content: T
    • codec: ContentCodec<T>

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/staticCanMessage.html b/functions/staticCanMessage.html index 289bff021..fc82ef923 100644 --- a/functions/staticCanMessage.html +++ b/functions/staticCanMessage.html @@ -1 +1 @@ -staticCanMessage | @xmtp/react-native-sdk

Function staticCanMessage

  • staticCanMessage(peerAddress, environment, appVersion?): Promise<boolean>

  • Parameters

    • peerAddress: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +staticCanMessage | @xmtp/react-native-sdk

Function staticCanMessage

  • staticCanMessage(peerAddress, environment, appVersion?): Promise<boolean>

  • Parameters

    • peerAddress: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribePushTopics.html b/functions/subscribePushTopics.html index 10226c75d..b70e59b22 100644 --- a/functions/subscribePushTopics.html +++ b/functions/subscribePushTopics.html @@ -1 +1 @@ -subscribePushTopics | @xmtp/react-native-sdk

Function subscribePushTopics

  • subscribePushTopics(topics): any

  • Parameters

    • topics: string[]

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +subscribePushTopics | @xmtp/react-native-sdk

Function subscribePushTopics

  • subscribePushTopics(topics): any

  • Parameters

    • topics: string[]

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToAllMessages.html b/functions/subscribeToAllMessages.html index 589e6867c..e4861f2ba 100644 --- a/functions/subscribeToAllMessages.html +++ b/functions/subscribeToAllMessages.html @@ -1 +1 @@ -subscribeToAllMessages | @xmtp/react-native-sdk

Function subscribeToAllMessages

  • subscribeToAllMessages(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +subscribeToAllMessages | @xmtp/react-native-sdk

Function subscribeToAllMessages

  • subscribeToAllMessages(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToConversations.html b/functions/subscribeToConversations.html index 37b06cd1e..e7a1c44d2 100644 --- a/functions/subscribeToConversations.html +++ b/functions/subscribeToConversations.html @@ -1 +1 @@ -subscribeToConversations | @xmtp/react-native-sdk

Function subscribeToConversations

  • subscribeToConversations(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +subscribeToConversations | @xmtp/react-native-sdk

Function subscribeToConversations

  • subscribeToConversations(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToMessages.html b/functions/subscribeToMessages.html index 2a5dfe965..5134bc3e5 100644 --- a/functions/subscribeToMessages.html +++ b/functions/subscribeToMessages.html @@ -1 +1 @@ -subscribeToMessages | @xmtp/react-native-sdk

Function subscribeToMessages

  • subscribeToMessages(clientAddress, topic): Promise<any>

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +subscribeToMessages | @xmtp/react-native-sdk

Function subscribeToMessages

  • subscribeToMessages(clientAddress, topic): Promise<any>

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromAllMessages.html b/functions/unsubscribeFromAllMessages.html index f515f67dd..ecbb5b747 100644 --- a/functions/unsubscribeFromAllMessages.html +++ b/functions/unsubscribeFromAllMessages.html @@ -1 +1 @@ -unsubscribeFromAllMessages | @xmtp/react-native-sdk

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +unsubscribeFromAllMessages | @xmtp/react-native-sdk

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromConversations.html b/functions/unsubscribeFromConversations.html index c835a56e9..152c9792f 100644 --- a/functions/unsubscribeFromConversations.html +++ b/functions/unsubscribeFromConversations.html @@ -1 +1 @@ -unsubscribeFromConversations | @xmtp/react-native-sdk

Function unsubscribeFromConversations

  • unsubscribeFromConversations(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +unsubscribeFromConversations | @xmtp/react-native-sdk

Function unsubscribeFromConversations

  • unsubscribeFromConversations(clientAddress): any

  • Parameters

    • clientAddress: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromMessages.html b/functions/unsubscribeFromMessages.html index bc1ee0e26..79224656a 100644 --- a/functions/unsubscribeFromMessages.html +++ b/functions/unsubscribeFromMessages.html @@ -1 +1 @@ -unsubscribeFromMessages | @xmtp/react-native-sdk

Function unsubscribeFromMessages

  • unsubscribeFromMessages(clientAddress, topic): Promise<any>

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +unsubscribeFromMessages | @xmtp/react-native-sdk

Function unsubscribeFromMessages

  • unsubscribeFromMessages(clientAddress, topic): Promise<any>

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useClient.html b/functions/useClient.html index 2a0c8fbd4..7bb0f3c2b 100644 --- a/functions/useClient.html +++ b/functions/useClient.html @@ -1 +1 @@ -useClient | @xmtp/react-native-sdk

Function useClient

  • useClient(onError?): {
        client: null | Client<any>;
        disconnect: (() => Promise<void>);
        error: null | Error;
        initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>);
        isLoading: boolean;
    }

  • Parameters

    • Optional onError: ((e) => void)
        • (e): void

        • Parameters

          • e: Error

          Returns void

    Returns {
        client: null | Client<any>;
        disconnect: (() => Promise<void>);
        error: null | Error;
        initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>);
        isLoading: boolean;
    }

    • client: null | Client<any>
    • disconnect: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • error: null | Error
    • initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>)
        • (__namedParameters): Promise<undefined | null | Client<any>>

        • Parameters

          • __namedParameters: InitializeClientOptions

          Returns Promise<undefined | null | Client<any>>

    • isLoading: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +useClient | @xmtp/react-native-sdk

Function useClient

  • useClient(onError?): {
        client: null | Client<any>;
        disconnect: (() => Promise<void>);
        error: null | Error;
        initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>);
        isLoading: boolean;
    }

  • Parameters

    • Optional onError: ((e) => void)
        • (e): void

        • Parameters

          • e: Error

          Returns void

    Returns {
        client: null | Client<any>;
        disconnect: (() => Promise<void>);
        error: null | Error;
        initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>);
        isLoading: boolean;
    }

    • client: null | Client<any>
    • disconnect: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • error: null | Error
    • initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>)
        • (__namedParameters): Promise<undefined | null | Client<any>>

        • Parameters

          • __namedParameters: InitializeClientOptions

          Returns Promise<undefined | null | Client<any>>

    • isLoading: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useXmtp.html b/functions/useXmtp.html index 2090c34b3..503ce6a77 100644 --- a/functions/useXmtp.html +++ b/functions/useXmtp.html @@ -1 +1 @@ -useXmtp | @xmtp/react-native-sdk

Function useXmtp

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +useXmtp | @xmtp/react-native-sdk

Function useXmtp

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 78ff2ec70..090932a98 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,13 @@

Install in a managed Expo project

npx expo prebuild

Install in bare React Native project

For bare React Native projects, install and configure the expo package before continuing.

-

Add the package to your yarn dependencies

yarn i @xmtp/react-native-sdk
+
then add the required babel plugin

+
yarn add @babel/plugin-proposal-export-namespace-from -D
+

+
then add the plugin to your babel.config.js

+
module.exports = {
  presets: ['module:@react-native/babel-preset'],
  plugins: [
    '@babel/plugin-proposal-export-namespace-from',
    // ... other plugins
  ],
};
+

+
Add the package to your dependencies
yarn add @xmtp/react-native-sdk
 

 
Configure for iOS
In the ios directory, update your Podfile file as follows:

Configure for Android

Your app must use Android minSdkVersion = 22 to work with the xmtp-react-native SDK.

Usage

The XMTP message API revolves around a network client that allows retrieving and sending messages to other network participants. A client must be connected to a wallet on startup. If this is the very first time the client is created, the client will generate a key bundle that is used to encrypt and authenticate messages. The key bundle persists encrypted in the network using a wallet signature. The public side of the key bundle is also regularly advertised on the network to allow parties to establish shared encryption keys. All this happens transparently, without requiring any additional code.

-
import { Client } from '@xmtp/react-native-sdk'
import { ConnectWallet, useSigner } from "@thirdweb-dev/react-native";

// Create the client with your wallet. This will connect to the XMTP development network by default
const xmtp = await Client.create(useSigner());
// Start a conversation with XMTP
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
// Load all messages in the conversation
const messages = await conversation.messages()
// Send a message
await conversation.send('gm')
// Listen for new messages in the conversation
for await (const message of await conversation.streamMessages()) {
  console.log(`[${message.senderAddress}]: ${message.content}`)
}
+
import { Client } from '@xmtp/react-native-sdk'
import { ConnectWallet, useSigner } from "@thirdweb-dev/react-native";

// Create the client with your wallet. This will connect to the XMTP development network by default
const xmtp = await Client.create(useSigner());
// Start a conversation with XMTP
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
// Load all messages in the conversation
const messages = await conversation.messages()
// Send a message
await conversation.send('gm')
// Listen for new messages in the conversation
for await (const message of await conversation.streamMessages()) {
  console.log(`[${message.senderAddress}]: ${message.content}`)
}
 

 
Currently, network nodes are configured to rate limit high-volume publishing from clients. A rate-limited client can expect to receive a 429 status code response from a node. Rate limits can change at any time in the interest of maintaining network health.

 
Use local storage

@@ -37,7 +43,7 @@
 

 
Important
The client connects to the XMTP dev environment by default. Use ClientOptions to change this and other parameters of the network connection.

 

-
import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
+
import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
 

 
Configure the client
The client's network connection and key storage method can be configured with these optional parameters of Client.create:

 
@@ -65,34 +71,34 @@
 

 

 
Handle conversations
Most of the time, when interacting with the network, you'll want to do it through conversations. Conversations are between two wallets.

-
import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
const conversations = xmtp.conversations
+
import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
const conversations = xmtp.conversations
 

 
List existing conversations
You can get a list of all conversations that have one or more messages.

-
const allConversations = await xmtp.conversations.list()
// Say gm to everyone you've been chatting with
for (const conversation of allConversations) {
  console.log(`Saying GM to ${conversation.peerAddress}`)
  await conversation.send('gm')
}
+
const allConversations = await xmtp.conversations.list()
// Say gm to everyone you've been chatting with
for (const conversation of allConversations) {
  console.log(`Saying GM to ${conversation.peerAddress}`)
  await conversation.send('gm')
}
 

 
These conversations include all conversations for a user regardless of which app created the conversation. This functionality provides the concept of an interoperable inbox, which enables a user to access all of their conversations in any app built with XMTP.

 
Listen for new conversations
You can also listen for new conversations being started in real-time. This will allow applications to display incoming messages from new contacts.

 

 
Warning
This stream will continue infinitely. To end the stream you can call cancelStream().

 

-
const stream = await xmtp.conversations.stream()
for await (const conversation of stream) {
  console.log(`New conversation started with ${conversation.peerAddress}`)
  // Say hello to your new friend
  await conversation.send('Hi there!')
  // Break from the loop to stop listening
  break
}
+
const stream = await xmtp.conversations.stream()
for await (const conversation of stream) {
  console.log(`New conversation started with ${conversation.peerAddress}`)
  // Say hello to your new friend
  await conversation.send('Hi there!')
  // Break from the loop to stop listening
  break
}
 

 
Start a new conversation
You can create a new conversation with any Ethereum address on the XMTP network.

-
const newConversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
+
const newConversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
 

 
Handle messages
To be able to send a message, the recipient must have already started their client at least once and consequently advertised their key bundle on the network. Messages are addressed using wallet addresses. The message payload can be a plain string, but other types of content can be supported through the use of SendOptions. See Handle different types of content for more details.

-
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
await conversation.send('Hello world')
+
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
await conversation.send('Hello world')
 

 
List messages in a conversation
You can receive the complete message history in a conversation by calling conversation.messages()

-
for (const conversation of await xmtp.conversations.list()) {
  const messagesInConversation = await conversation.messages(before: new Date(new Date().setDate(new Date().getDate() - 1)), after: new Date())
}
+
for (const conversation of await xmtp.conversations.list()) {
  const messagesInConversation = await conversation.messages(before: new Date(new Date().setDate(new Date().getDate() - 1)), after: new Date())
}
 

 
List messages in a conversation with pagination
It may be helpful to retrieve and process the messages in a conversation page by page.

-
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)

for await (const page of conversation.messages(limit: 25)) {
  for (const msg of page) {
    // Breaking from the outer loop will stop the client from requesting any further pages
    if (msg.content === 'gm') {
      return
    }
    console.log(msg.content)
  }
}
+
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)

for await (const page of conversation.messages(limit: 25)) {
  for (const msg of page) {
    // Breaking from the outer loop will stop the client from requesting any further pages
    if (msg.content === 'gm') {
      return
    }
    console.log(msg.content)
  }
}
 

 
Listen for new messages in a conversation
You can listen for any new messages (incoming or outgoing) in a conversation by calling conversation.streamMessages().

 
A successfully received message (that makes it through the decoding and decryption without throwing) can be trusted to be authentic, i.e. that it was sent by the owner of the message.senderAddress wallet and that it wasn't modified in transit. The message.sent timestamp can be trusted to have been set by the sender.

 
The Stream returned by the stream methods is an asynchronous iterator and as such usable by a for-await-of loop. Note however that it is by its nature infinite, so any looping construct used with it will not terminate, unless the termination is explicitly initiated by calling cancelStreamMessages().

-
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
for await (const message of await conversation.streamMessages()) {
  if (message.senderAddress === xmtp.address) {
    // This message was sent from me
    continue
  }
  console.log(`New message from ${message.senderAddress}: ${message.content}`)
}
+
const conversation = await xmtp.conversations.newConversation(
  '0x3F11b27F323b62B159D2642964fa27C46C841897'
)
for await (const message of await conversation.streamMessages()) {
  if (message.senderAddress === xmtp.address) {
    // This message was sent from me
    continue
  }
  console.log(`New message from ${message.senderAddress}: ${message.content}`)
}
 

 
Listen for new messages in all conversations
To listen for any new messages from all conversations, use conversations.streamAllMessages().

 

@@ -101,7 +107,7 @@
 

 
Warning
This stream will continue infinitely. To end the stream you can call cancelStreamAllMessages().

 

-
for await (const message of await xmtp.conversations.streamAllMessages()) {
  if (message.senderAddress === xmtp.address) {
    // This message was sent from me
    continue
  }
  console.log(`New message from ${message.senderAddress}: ${message.content}`)
}
+
for await (const message of await xmtp.conversations.streamAllMessages()) {
  if (message.senderAddress === xmtp.address) {
    // This message was sent from me
    continue
  }
  console.log(`New message from ${message.senderAddress}: ${message.content}`)
}
 

 
Request and respect user consent
Feature status

 
The user consent feature enables your app to request and respect user consent preferences. With this feature, another blockchain account address registered on the XMTP network can have one of three consent preference values:

@@ -112,7 +118,7 @@
 
 
To learn more, see Request and respect user consent.

 
Check if an address is on the network
If you would like to check and see if a blockchain address is registered on the network before instantiating a client instance, you can use Client.canMessage.

-
import { Client } from '@xmtp/react-native-sdk'

const isOnProdNetwork = await Client.canMessage(
  '0x3F11b27F323b62B159D2642964fa27C46C841897', { env: 'production' }
)
+
import { Client } from '@xmtp/react-native-sdk'

const isOnProdNetwork = await Client.canMessage(
  '0x3F11b27F323b62B159D2642964fa27C46C841897', { env: 'production' }
)
 

 
Send a broadcast message
You can send a broadcast message (1:many message or announcement) with XMTP. The recipient sees the message as a DM from the sending wallet address.

 
For important information about sending broadcast messages, see Best practices for broadcast messages.

@@ -121,22 +127,22 @@
 
  • Send the message to all of the activated wallet addresses.
    • 
 
 
    For example:
    
-
    const ethers = require('ethers')
    const { Client } = require('@xmtp/react-native-sdk')

    async function main() {
      //Create a random wallet for example purposes. On the frontend you should replace it with the user's wallet (metamask, rainbow, etc)
      //Initialize the xmtp client
      const xmtp = await Client.createRandom({ env: "dev" });

      //In this example we are going to broadcast to the GM_BOT wallet (already activated) and a random wallet (not activated)
      const GM_BOT = '0x937C0d4a6294cdfa575de17382c7076b579DC176'
      const test = ethers.Wallet.createRandom()
      const broadcasts_array = [GM_BOT, test.address]

      //Querying the activation status of the wallets
      const broadcasts_canMessage = await xmtp.canMessage(broadcasts_array)
      for (let i = 0; i < broadcasts_array.length; i++) {
        //Checking the activation status of each wallet
        const wallet = broadcasts_array[i]
        const canMessage = broadcasts_canMessage[i]
        if (broadcasts_canMessage[i]) {
          //If activated, start
          const conversation = await xmtp.conversations.newConversation(wallet)
          // Send a message
          const sent = await conversation.send('gm')
        }
      }
    }
    main()
+
    const ethers = require('ethers')
    const { Client } = require('@xmtp/react-native-sdk')

    async function main() {
      //Create a random wallet for example purposes. On the frontend you should replace it with the user's wallet (metamask, rainbow, etc)
      //Initialize the xmtp client
      const xmtp = await Client.createRandom({ env: "dev" });

      //In this example we are going to broadcast to the GM_BOT wallet (already activated) and a random wallet (not activated)
      const GM_BOT = '0x937C0d4a6294cdfa575de17382c7076b579DC176'
      const test = ethers.Wallet.createRandom()
      const broadcasts_array = [GM_BOT, test.address]

      //Querying the activation status of the wallets
      const broadcasts_canMessage = await xmtp.canMessage(broadcasts_array)
      for (let i = 0; i < broadcasts_array.length; i++) {
        //Checking the activation status of each wallet
        const wallet = broadcasts_array[i]
        const canMessage = broadcasts_canMessage[i]
        if (broadcasts_canMessage[i]) {
          //If activated, start
          const conversation = await xmtp.conversations.newConversation(wallet)
          // Send a message
          const sent = await conversation.send('gm')
        }
      }
    }
    main()
 
    
 
    Handle different types of content
    All send functions support SendOptions as an optional parameter. The contentType option allows specifying different types of content than the default simple string standard content type, which is identified with content type identifier ContentTypeText.
    
 
    To learn more about content types, see Content types with XMTP.
    
 
    Support for other types of content can be added by registering additional ContentCodecs with the Client. Every codec is associated with a content type identifier, ContentTypeId, which is used to signal to the client which codec should be used to process the content that is being sent or received.
 For example, see the Native Codecs available in xmtp-react-native.
    
-
    // Assuming we've loaded a fictional NumberCodec that can be used to encode numbers,
    // and is identified with ContentTypeNumber, we can use it as follows.

    xmtp.register(new NumberCodec())
    conversation.send(3.14, {
      contentType: ContentTypeNumber
    })
+
    // Assuming we've loaded a fictional NumberCodec that can be used to encode numbers,
    // and is identified with ContentTypeNumber, we can use it as follows.

    xmtp.register(new NumberCodec())
    conversation.send(3.14, {
      contentType: ContentTypeNumber
    })
 
    
 
    Additional codecs can be configured through the ClientOptions parameter of Client.create. The codecs option is a list of codec instances that should be added to the default set of codecs (currently only the TextCodec). If a codec is added for a content type that is already in the default set, it will replace the original codec.
    
-
    // Adding support for `xmtp.org/reaction` content type
    import { ReactionCodec } from '@xmtp/react-native-sdk'
    const xmtp = Client.create(wallet, { codecs: [new ReactionCodec()] })

    await conversation.send({
      reaction: {
        reference: otherMessage.id,
        action: "added",
        schema: "unicode",
        content: "💖",
      },
    });
+
    // Adding support for `xmtp.org/reaction` content type
    import { ReactionCodec } from '@xmtp/react-native-sdk'
    const xmtp = Client.create(wallet, { codecs: [new ReactionCodec()] })

    await conversation.send({
      reaction: {
        reference: otherMessage.id,
        action: "added",
        schema: "unicode",
        content: "💖",
      },
    });
 
    
 
    To learn more about how to build a custom content type, see Build a custom content type.
    
 
    Custom codecs and content types may be proposed as interoperable standards through XRCs. To learn about the custom content type proposal process, see XIP-5.
    
 
    Manually handle private key storage
    The SDK will handle key storage for the user by encrypting the private key bundle using a signature generated from the wallet, and storing the encrypted payload on the XMTP network. This can be awkward for some server-side applications, where you may only want to give the application access to the XMTP keys but not your wallet keys. Mobile applications may also want to store keys in a secure enclave rather than rely on decrypting the remote keys on the network each time the application starts up.
    
 
    You can export the unencrypted key bundle using the static method Client.exportKeyBundle, save it somewhere secure, and then provide those keys at a later time to initialize a new client using the exported XMTP identity.
    
-
    import { Client } from '@xmtp/react-native-sdk'
    // Get the keys using a valid Signer. Save them somewhere secure.
    const keys = await Client.exportKeyBundle()
    // Create a client using keys returned from getKeys
    const client = await Client.createFromKeyBundle(keys, { env: "dev" })
+
    import { Client } from '@xmtp/react-native-sdk'
    // Get the keys using a valid Signer. Save them somewhere secure.
    const keys = await Client.exportKeyBundle()
    // Create a client using keys returned from getKeys
    const client = await Client.createFromKeyBundle(keys, { env: "dev" })
 
    
 
    The keys returned by exportKeyBundle should be treated with the utmost care as compromise of these keys will allow an attacker to impersonate the user on the XMTP network. Ensure these keys are stored somewhere secure and encrypted.
    
 
    Enable the example app to send push notifications
    Check out the push-notifications-example branch and follow instructions in the README.
    
@@ -181,4 +187,4 @@
 
 
 
    The production network is configured to store messages indefinitely. XMTP may occasionally delete messages and keys from the dev network, and will provide advance notice in the XMTP Discord community.
    
-
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html
index b1f345b1c..adfe2298f 100644
--- a/interfaces/JSContentCodec.html
+++ b/interfaces/JSContentCodec.html
@@ -1,5 +1,5 @@
-JSContentCodec | @xmtp/react-native-sdk
    Interface JSContentCodec<T>
    interface JSContentCodec { 
        contentType: ContentTypeId; 
        decode(encodedContent): T; 
        encode(content): EncodedContent; 
        fallback(content): undefined | string; 
    }
     
    Type Parameters
    • T
     
    Properties
    contentType
+JSContentCodec | @xmtp/react-native-sdk
    Interface JSContentCodec<T>
    interface JSContentCodec { 
        contentType: ContentTypeId; 
        decode(encodedContent): T; 
        encode(content): EncodedContent; 
        fallback(content): undefined | string; 
    }
     
    Type Parameters
    • T
     
    Properties
    contentType
 
    Methods
    decode
 encode
 fallback
-
    Properties
    contentType
    contentType: ContentTypeId
    Methods
    decode
    encode
    fallback
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Properties
    contentType
    contentType: ContentTypeId
    Methods
    decode
    encode
    fallback
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/NativeContentCodec.html b/interfaces/NativeContentCodec.html
index 7aab0838a..3db3d3208 100644
--- a/interfaces/NativeContentCodec.html
+++ b/interfaces/NativeContentCodec.html
@@ -1,6 +1,6 @@
-NativeContentCodec | @xmtp/react-native-sdk
    Interface NativeContentCodec<T>
    interface NativeContentCodec { 
        contentKey: string; 
        contentType: ContentTypeId; 
        decode(nativeContent): T; 
        encode(content): NativeMessageContent; 
        fallback(content): undefined | string; 
    }
     
    Type Parameters
    • T
     
    Implemented by
    Properties
    contentKey
+NativeContentCodec | @xmtp/react-native-sdk
    Interface NativeContentCodec<T>
    interface NativeContentCodec { 
        contentKey: string; 
        contentType: ContentTypeId; 
        decode(nativeContent): T; 
        encode(content): NativeMessageContent; 
        fallback(content): undefined | string; 
    }
     
    Type Parameters
    • T
     
    Implemented by
    Properties
    contentKey
 contentType
 
    Methods
    decode
 encode
 fallback
-
    Properties
    contentKey
    contentKey: string
    contentType
    contentType: ContentTypeId
    Methods
    decode
    encode
    fallback
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    Properties
    contentKey
    contentKey: string
    contentType
    contentType: ContentTypeId
    Methods
    decode
    encode
    fallback
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/interfaces/XmtpContextValue.html b/interfaces/XmtpContextValue.html
index 4daf14391..3e6388f53 100644
--- a/interfaces/XmtpContextValue.html
+++ b/interfaces/XmtpContextValue.html
@@ -1,5 +1,5 @@
-XmtpContextValue | @xmtp/react-native-sdk
    Interface XmtpContextValue
    interface XmtpContextValue { 
        client: null | Client<any>; 
        setClient: Dispatch<SetStateAction<null | Client<any>>>; 
    }
    Properties
    client
+XmtpContextValue | @xmtp/react-native-sdk
    Interface XmtpContextValue
    interface XmtpContextValue { 
        client: null | Client<any>; 
        setClient: Dispatch<SetStateAction<null | Client<any>>>; 
    }
    Properties
    client
 setClient
 
    Properties
    client
    client: null | Client<any>
    The XMTP client instance
    
-
    setClient
    setClient: Dispatch<SetStateAction<null | Client<any>>>
    Set the XMTP client instance
    
-
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
+
    setClient
    setClient: Dispatch<SetStateAction<null | Client<any>>>
    Set the XMTP client instance
    
+
    Settings
    Member Visibility
    Theme
    On This Page
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/modules/XmtpProvider.html b/modules/XmtpProvider.html
index 1580ca192..cb26a5f29 100644
--- a/modules/XmtpProvider.html
+++ b/modules/XmtpProvider.html
@@ -1 +1 @@
-XmtpProvider | @xmtp/react-native-sdk
    Namespace XmtpProvider
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+XmtpProvider | @xmtp/react-native-sdk
    Namespace XmtpProvider
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ContentCodec.html b/types/ContentCodec.html
index d1c038bbe..a0b0b3c2c 100644
--- a/types/ContentCodec.html
+++ b/types/ContentCodec.html
@@ -1 +1 @@
-ContentCodec | @xmtp/react-native-sdk
    Type alias ContentCodec<T>
    ContentCodec<T>: JSContentCodec<T> | NativeContentCodec<T>
    Type Parameters
    • T
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ContentCodec | @xmtp/react-native-sdk
    Type alias ContentCodec<T>
    ContentCodec<T>: JSContentCodec<T> | NativeContentCodec<T>
    Type Parameters
    • T
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ContentTypeId.html b/types/ContentTypeId.html
index 55bf3fe7a..7eb686500 100644
--- a/types/ContentTypeId.html
+++ b/types/ContentTypeId.html
@@ -1 +1 @@
-ContentTypeId | @xmtp/react-native-sdk
    Type alias ContentTypeId
    ContentTypeId: content.ContentTypeId
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ContentTypeId | @xmtp/react-native-sdk
    Type alias ContentTypeId
    ContentTypeId: content.ContentTypeId
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ConversationContext.html b/types/ConversationContext.html
index 05529fd74..ac9a2076d 100644
--- a/types/ConversationContext.html
+++ b/types/ConversationContext.html
@@ -1 +1 @@
-ConversationContext | @xmtp/react-native-sdk
    Type alias ConversationContext
    ConversationContext: { 
        conversationID: string; 
        metadata: { 
            [key: string]: string; 
        }; 
    }
    Type declaration
    • conversationID: string
    • metadata: { 
          [key: string]: string; 
      }
      • [key: string]: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ConversationContext | @xmtp/react-native-sdk
    Type alias ConversationContext
    ConversationContext: { 
        conversationID: string; 
        metadata: { 
            [key: string]: string; 
        }; 
    }
    Type declaration
    • conversationID: string
    • metadata: { 
          [key: string]: string; 
      }
      • [key: string]: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/DecryptedLocalAttachment.html b/types/DecryptedLocalAttachment.html
index 2919f4b5e..429cab442 100644
--- a/types/DecryptedLocalAttachment.html
+++ b/types/DecryptedLocalAttachment.html
@@ -1 +1 @@
-DecryptedLocalAttachment | @xmtp/react-native-sdk
    Type alias DecryptedLocalAttachment
    DecryptedLocalAttachment: { 
        fileUri: string; 
        filename?: string; 
        mimeType?: string; 
    }
    Type declaration
    • fileUri: string
    • Optional filename?: string
    • Optional mimeType?: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+DecryptedLocalAttachment | @xmtp/react-native-sdk
    Type alias DecryptedLocalAttachment
    DecryptedLocalAttachment: { 
        fileUri: string; 
        filename?: string; 
        mimeType?: string; 
    }
    Type declaration
    • fileUri: string
    • Optional filename?: string
    • Optional mimeType?: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/EncodedContent.html b/types/EncodedContent.html
index d96a289d8..e503c790f 100644
--- a/types/EncodedContent.html
+++ b/types/EncodedContent.html
@@ -1 +1 @@
-EncodedContent | @xmtp/react-native-sdk
    Type alias EncodedContent
    EncodedContent: content.EncodedContent
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+EncodedContent | @xmtp/react-native-sdk
    Type alias EncodedContent
    EncodedContent: content.EncodedContent
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/EncryptedLocalAttachment.html b/types/EncryptedLocalAttachment.html
index 381a73d1c..686859db6 100644
--- a/types/EncryptedLocalAttachment.html
+++ b/types/EncryptedLocalAttachment.html
@@ -1 +1 @@
-EncryptedLocalAttachment | @xmtp/react-native-sdk
    Type alias EncryptedLocalAttachment
    EncryptedLocalAttachment: { 
        encryptedLocalFileUri: string; 
        metadata: RemoteAttachmentMetadata; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+EncryptedLocalAttachment | @xmtp/react-native-sdk
    Type alias EncryptedLocalAttachment
    EncryptedLocalAttachment: { 
        encryptedLocalFileUri: string; 
        metadata: RemoteAttachmentMetadata; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/NativeMessageContent.html b/types/NativeMessageContent.html
index d17062da6..012b2469d 100644
--- a/types/NativeMessageContent.html
+++ b/types/NativeMessageContent.html
@@ -1 +1 @@
-NativeMessageContent | @xmtp/react-native-sdk
    Type alias NativeMessageContent
    NativeMessageContent: { 
        attachment?: StaticAttachmentContent; 
        encoded?: string; 
        reaction?: ReactionContent; 
        readReceipt?: ReadReceiptContent; 
        remoteAttachment?: RemoteAttachmentContent; 
        reply?: ReplyContent; 
        text?: string; 
        unknown?: UnknownContent; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+NativeMessageContent | @xmtp/react-native-sdk
    Type alias NativeMessageContent
    NativeMessageContent: { 
        attachment?: StaticAttachmentContent; 
        encoded?: string; 
        reaction?: ReactionContent; 
        readReceipt?: ReadReceiptContent; 
        remoteAttachment?: RemoteAttachmentContent; 
        reply?: ReplyContent; 
        text?: string; 
        unknown?: UnknownContent; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/PreparedLocalMessage.html b/types/PreparedLocalMessage.html
index c9e090515..cdbe5ce03 100644
--- a/types/PreparedLocalMessage.html
+++ b/types/PreparedLocalMessage.html
@@ -1 +1 @@
-PreparedLocalMessage | @xmtp/react-native-sdk
    Type alias PreparedLocalMessage
    PreparedLocalMessage: { 
        messageId: string; 
        preparedAt: number; 
        preparedFileUri: `file://${string}`; 
    }
    Type declaration
    • messageId: string
    • preparedAt: number
    • preparedFileUri: `file://${string}`
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+PreparedLocalMessage | @xmtp/react-native-sdk
    Type alias PreparedLocalMessage
    PreparedLocalMessage: { 
        messageId: string; 
        preparedAt: number; 
        preparedFileUri: `file://${string}`; 
    }
    Type declaration
    • messageId: string
    • preparedAt: number
    • preparedFileUri: `file://${string}`
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/Query.html b/types/Query.html
index d3055c177..ef46b3369 100644
--- a/types/Query.html
+++ b/types/Query.html
@@ -1 +1 @@
-Query | @xmtp/react-native-sdk
    Type alias Query
    Query: { 
        contentTopic: string; 
        direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"; 
        endTime?: number | Date; 
        pageSize?: number; 
        startTime?: number | Date; 
    }
    Type declaration
    • contentTopic: string
    • Optional direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
    • Optional endTime?: number | Date
    • Optional pageSize?: number
    • Optional startTime?: number | Date
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+Query | @xmtp/react-native-sdk
    Type alias Query
    Query: { 
        contentTopic: string; 
        direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"; 
        endTime?: number | Date; 
        pageSize?: number; 
        startTime?: number | Date; 
    }
    Type declaration
    • contentTopic: string
    • Optional direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
    • Optional endTime?: number | Date
    • Optional pageSize?: number
    • Optional startTime?: number | Date
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ReactionContent.html b/types/ReactionContent.html
index 695e63310..30ab15169 100644
--- a/types/ReactionContent.html
+++ b/types/ReactionContent.html
@@ -1 +1 @@
-ReactionContent | @xmtp/react-native-sdk
    Type alias ReactionContent
    ReactionContent: { 
        action: "added" | "removed" | "unknown"; 
        content: string; 
        reference: string; 
        schema: "unicode" | "shortcode" | "custom" | "unknown"; 
    }
    Type declaration
    • action: "added" | "removed" | "unknown"
    • content: string
    • reference: string
    • schema: "unicode" | "shortcode" | "custom" | "unknown"
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ReactionContent | @xmtp/react-native-sdk
    Type alias ReactionContent
    ReactionContent: { 
        action: "added" | "removed" | "unknown"; 
        content: string; 
        reference: string; 
        schema: "unicode" | "shortcode" | "custom" | "unknown"; 
    }
    Type declaration
    • action: "added" | "removed" | "unknown"
    • content: string
    • reference: string
    • schema: "unicode" | "shortcode" | "custom" | "unknown"
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ReadReceiptContent.html b/types/ReadReceiptContent.html
index 2b088bc93..bd8042d31 100644
--- a/types/ReadReceiptContent.html
+++ b/types/ReadReceiptContent.html
@@ -1 +1 @@
-ReadReceiptContent | @xmtp/react-native-sdk
    Type alias ReadReceiptContent
    ReadReceiptContent: object
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ReadReceiptContent | @xmtp/react-native-sdk
    Type alias ReadReceiptContent
    ReadReceiptContent: object
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/RemoteAttachmentContent.html b/types/RemoteAttachmentContent.html
index 1f373533d..fe96c02f4 100644
--- a/types/RemoteAttachmentContent.html
+++ b/types/RemoteAttachmentContent.html
@@ -1 +1 @@
-RemoteAttachmentContent | @xmtp/react-native-sdk
    Type alias RemoteAttachmentContent
    RemoteAttachmentContent: RemoteAttachmentMetadata & { 
        scheme: "https://"; 
        url: string; 
    }
    Type declaration
    • scheme: "https://"
    • url: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+RemoteAttachmentContent | @xmtp/react-native-sdk
    Type alias RemoteAttachmentContent
    RemoteAttachmentContent: RemoteAttachmentMetadata & { 
        scheme: "https://"; 
        url: string; 
    }
    Type declaration
    • scheme: "https://"
    • url: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/RemoteAttachmentMetadata.html b/types/RemoteAttachmentMetadata.html
index 18b149284..1ae9ebe81 100644
--- a/types/RemoteAttachmentMetadata.html
+++ b/types/RemoteAttachmentMetadata.html
@@ -1 +1 @@
-RemoteAttachmentMetadata | @xmtp/react-native-sdk
    Type alias RemoteAttachmentMetadata
    RemoteAttachmentMetadata: { 
        contentDigest: string; 
        contentLength?: string; 
        filename?: string; 
        nonce: string; 
        salt: string; 
        secret: string; 
    }
    Type declaration
    • contentDigest: string
    • Optional contentLength?: string
    • Optional filename?: string
    • nonce: string
    • salt: string
    • secret: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+RemoteAttachmentMetadata | @xmtp/react-native-sdk
    Type alias RemoteAttachmentMetadata
    RemoteAttachmentMetadata: { 
        contentDigest: string; 
        contentLength?: string; 
        filename?: string; 
        nonce: string; 
        salt: string; 
        secret: string; 
    }
    Type declaration
    • contentDigest: string
    • Optional contentLength?: string
    • Optional filename?: string
    • nonce: string
    • salt: string
    • secret: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/ReplyContent.html b/types/ReplyContent.html
index eb5be3beb..881f919ba 100644
--- a/types/ReplyContent.html
+++ b/types/ReplyContent.html
@@ -1 +1 @@
-ReplyContent | @xmtp/react-native-sdk
    Type alias ReplyContent
    ReplyContent: { 
        content: any; 
        contentType: string; 
        reference: string; 
    }
    Type declaration
    • content: any
    • contentType: string
    • reference: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+ReplyContent | @xmtp/react-native-sdk
    Type alias ReplyContent
    ReplyContent: { 
        content: any; 
        contentType: string; 
        reference: string; 
    }
    Type declaration
    • content: any
    • contentType: string
    • reference: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/StaticAttachmentContent.html b/types/StaticAttachmentContent.html
index 6ec825651..1ea7e6cde 100644
--- a/types/StaticAttachmentContent.html
+++ b/types/StaticAttachmentContent.html
@@ -1 +1 @@
-StaticAttachmentContent | @xmtp/react-native-sdk
    Type alias StaticAttachmentContent
    StaticAttachmentContent: { 
        data: string; 
        filename: string; 
        mimeType: string; 
    }
    Type declaration
    • data: string
    • filename: string
    • mimeType: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+StaticAttachmentContent | @xmtp/react-native-sdk
    Type alias StaticAttachmentContent
    StaticAttachmentContent: { 
        data: string; 
        filename: string; 
        mimeType: string; 
    }
    Type declaration
    • data: string
    • filename: string
    • mimeType: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/types/UnknownContent.html b/types/UnknownContent.html
index 0769c5c64..1ac38f49f 100644
--- a/types/UnknownContent.html
+++ b/types/UnknownContent.html
@@ -1 +1 @@
-UnknownContent | @xmtp/react-native-sdk
    Type alias UnknownContent
    UnknownContent: { 
        contentTypeId: string; 
    }
    Type declaration
    • contentTypeId: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+UnknownContent | @xmtp/react-native-sdk
    Type alias UnknownContent
    UnknownContent: { 
        contentTypeId: string; 
    }
    Type declaration
    • contentTypeId: string
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/variables/XmtpContext.html b/variables/XmtpContext.html
index 5e7464b25..1723ecd69 100644
--- a/variables/XmtpContext.html
+++ b/variables/XmtpContext.html
@@ -1 +1 @@
-XmtpContext | @xmtp/react-native-sdk
    Variable XmtpContextConst 
    XmtpContext: Context<XmtpContextValue> = ...
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+XmtpContext | @xmtp/react-native-sdk
    Variable XmtpContextConst 
    XmtpContext: Context<XmtpContextValue> = ...
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
diff --git a/variables/emitter.html b/variables/emitter.html
index d75c89fe8..2ac8cd3a8 100644
--- a/variables/emitter.html
+++ b/variables/emitter.html
@@ -1 +1 @@
-emitter | @xmtp/react-native-sdk
    Variable emitterConst 
    emitter: EventEmitter = ...
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file
+emitter | @xmtp/react-native-sdk
    Variable emitterConst 
    emitter: EventEmitter = ...
    Settings
    Member Visibility
    Theme
    Generated using TypeDoc
    
\ No newline at end of file