diff --git a/classes/Client.html b/classes/Client.html index f2d07edc3..cb7c6860b 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

Properties

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

Type declaration

contacts: default
conversations: default<ContentTypes>

Methods

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

    +

Constructors

Properties

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

Type declaration

contacts: default
conversations: default<ContentTypes>

Methods

  • 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.

    -
  • 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://").

    -
  • 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://").

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

    +
  • 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.

    -
  • 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.

    -
  • Sends a prepared message.

    +
  • 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 method to determine if the address is currently in our network.

    +
  • 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>

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

    +

Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

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

Constructors

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

Constructors

Properties

Methods

Constructors

Properties

entryType: "address"
permissionType: ConsentState
value: string

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

entryType: "address"
permissionType: ConsentState
value: string

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Conversation.html b/classes/Conversation.html index 488882bc8..2a7e6341f 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

  • 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<ContentTypes>
conversationID?: string
createdAt: number
peerAddress: string
topic: string
version: string

Accessors

Methods

  • Retrieves the consent state for the current conversation.

    +

Constructors

  • 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<ContentTypes>
conversationID?: string
createdAt: number
peerAddress: string
topic: string
version: string

Accessors

Methods

  • 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."

    -
  • 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.

    -
  • 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.

    -
  • 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.

    -
  • 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.

    -
  • 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.

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

    +
  • 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.

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/DecodedMessage.html b/classes/DecodedMessage.html index c0db83659..2b6ace91a 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

Properties

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

Methods

Constructors

  • 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<ContentTypes>
contentTypeId: string
fallback: undefined | string
id: string
nativeContent: NativeMessageContent
senderAddress: string
sent: number
topic: string

Methods

  • 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>

Generated using TypeDoc

\ No newline at end of file +

Constructors

  • 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<ContentTypes>
contentTypeId: string
fallback: undefined | string
id: string
nativeContent: NativeMessageContent
senderAddress: string
sent: number
topic: string

Methods

  • 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>

Generated using TypeDoc

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

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'reaction'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'reaction'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

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

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'readReceipt'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'readReceipt'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

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

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'remoteAttachment'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'remoteAttachment'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

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

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'reply'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'reply'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/StaticAttachmentCodec.html b/classes/StaticAttachmentCodec.html index 94485551f..59bc64974 100644 --- a/classes/StaticAttachmentCodec.html +++ b/classes/StaticAttachmentCodec.html @@ -1,7 +1,7 @@ -StaticAttachmentCodec | @xmtp/react-native-sdk

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'attachment'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'attachment'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

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

Implements

Constructors

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

Implements

Constructors

Properties

Methods

Constructors

Properties

contentKey: string = 'text'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

contentKey: string = 'text'
contentType: ContentTypeId = ...

Methods

Generated using TypeDoc

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

Constructors

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

Constructors

Methods

Constructors

Methods

  • Parameters

    • server: string
    • token: string

    Returns void

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

  • Parameters

    • server: string
    • token: string

    Returns void

Generated using TypeDoc

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

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/allowContacts.html b/functions/allowContacts.html index a1615be40..3d326c645 100644 --- a/functions/allowContacts.html +++ b/functions/allowContacts.html @@ -1 +1 @@ -allowContacts | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Generated using TypeDoc

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

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/auth.html b/functions/auth.html index 477ec64d9..48ca8d4b9 100644 --- a/functions/auth.html +++ b/functions/auth.html @@ -1 +1 @@ -auth | @xmtp/react-native-sdk
  • Parameters

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

    Returns Promise<any>

Generated using TypeDoc

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

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

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/canMessage.html b/functions/canMessage.html index a4885eb41..4b8a26d3a 100644 --- a/functions/canMessage.html +++ b/functions/canMessage.html @@ -1 +1 @@ -canMessage | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string
    • peerAddress: string

    Returns Promise<boolean>

Generated using TypeDoc

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

    • clientAddress: string
    • peerAddress: string

    Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/consentList.html b/functions/consentList.html index 70118d2e2..9cf6ef6ea 100644 --- a/functions/consentList.html +++ b/functions/consentList.html @@ -1 +1 @@ -consentList | @xmtp/react-native-sdk

Generated using TypeDoc

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

Generated using TypeDoc

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

Function conversationConsentState

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<ConsentState>

Generated using TypeDoc

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

Function conversationConsentState

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<ConsentState>

Generated using TypeDoc

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

Function createConversation

Generated using TypeDoc

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

Function createConversation

Generated using TypeDoc

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

Function createFromKeyBundle

  • Parameters

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

    Returns Promise<string>

Generated using TypeDoc

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

Function createFromKeyBundle

  • Parameters

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

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createRandom.html b/functions/createRandom.html index 752213627..f083a34e5 100644 --- a/functions/createRandom.html +++ b/functions/createRandom.html @@ -1 +1 @@ -createRandom | @xmtp/react-native-sdk
  • Parameters

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

    Returns Promise<string>

Generated using TypeDoc

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

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

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/decodeMessage.html b/functions/decodeMessage.html index 08d1428e0..9146b50f0 100644 --- a/functions/decodeMessage.html +++ b/functions/decodeMessage.html @@ -1 +1 @@ -decodeMessage | @xmtp/react-native-sdk

Generated using TypeDoc

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

Generated using TypeDoc

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

Function decryptAttachment

Generated using TypeDoc

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

Function decryptAttachment

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/denyContacts.html b/functions/denyContacts.html index 598d1c857..943c134df 100644 --- a/functions/denyContacts.html +++ b/functions/denyContacts.html @@ -1 +1 @@ -denyContacts | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Generated using TypeDoc

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

    • clientAddress: string
    • addresses: string[]

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/encryptAttachment.html b/functions/encryptAttachment.html index 881eaa2d4..6db1875ee 100644 --- a/functions/encryptAttachment.html +++ b/functions/encryptAttachment.html @@ -1 +1 @@ -encryptAttachment | @xmtp/react-native-sdk

Function encryptAttachment

Generated using TypeDoc

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

Function encryptAttachment

Generated using TypeDoc

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

Function exportConversationTopicData

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<string>

Generated using TypeDoc

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

Function exportConversationTopicData

  • Parameters

    • clientAddress: string
    • conversationTopic: string

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/exportKeyBundle.html b/functions/exportKeyBundle.html index 42ce01acc..49752da1c 100644 --- a/functions/exportKeyBundle.html +++ b/functions/exportKeyBundle.html @@ -1 +1 @@ -exportKeyBundle | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string

    Returns Promise<string>

Generated using TypeDoc

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

    • clientAddress: string

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/importConversationTopicData.html b/functions/importConversationTopicData.html index 21f8b2a75..a3d93512e 100644 --- a/functions/importConversationTopicData.html +++ b/functions/importConversationTopicData.html @@ -1 +1 @@ -importConversationTopicData | @xmtp/react-native-sdk

Function importConversationTopicData

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • topicData: string

    Returns Promise<Conversation<ContentTypes>>

Generated using TypeDoc

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

Function importConversationTopicData

  • Type Parameters

    • ContentTypes

    Parameters

    • client: Client<ContentTypes>
    • topicData: string

    Returns Promise<Conversation<ContentTypes>>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isAllowed.html b/functions/isAllowed.html index cfe14a727..34cc033b2 100644 --- a/functions/isAllowed.html +++ b/functions/isAllowed.html @@ -1 +1 @@ -isAllowed | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Generated using TypeDoc

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

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isDenied.html b/functions/isDenied.html index 5814713ad..5ffcb9570 100644 --- a/functions/isDenied.html +++ b/functions/isDenied.html @@ -1 +1 @@ -isDenied | @xmtp/react-native-sdk
  • Parameters

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Generated using TypeDoc

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

    • clientAddress: string
    • address: string

    Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listBatchMessages.html b/functions/listBatchMessages.html index b21448c91..729427faa 100644 --- a/functions/listBatchMessages.html +++ b/functions/listBatchMessages.html @@ -1 +1 @@ -listBatchMessages | @xmtp/react-native-sdk

Function listBatchMessages

Generated using TypeDoc

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

Function listBatchMessages

Generated using TypeDoc

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

Function listConversations

Generated using TypeDoc

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

Function listConversations

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listMessages.html b/functions/listMessages.html index f015f1ccb..507d906dd 100644 --- a/functions/listMessages.html +++ b/functions/listMessages.html @@ -1 +1 @@ -listMessages | @xmtp/react-native-sdk
  • 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[]>

Generated using TypeDoc

\ No newline at end of file +listMessages | @xmtp/react-native-sdk
  • 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[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/preCreateIdentityCallbackCompleted.html b/functions/preCreateIdentityCallbackCompleted.html index 49e07ae86..97d955878 100644 --- a/functions/preCreateIdentityCallbackCompleted.html +++ b/functions/preCreateIdentityCallbackCompleted.html @@ -1 +1 @@ -preCreateIdentityCallbackCompleted | @xmtp/react-native-sdk

Function preCreateIdentityCallbackCompleted

  • Returns void

Generated using TypeDoc

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

Function preCreateIdentityCallbackCompleted

  • Returns void

Generated using TypeDoc

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

Function preEnableIdentityCallbackCompleted

  • Returns void

Generated using TypeDoc

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

Function preEnableIdentityCallbackCompleted

  • Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareMessage.html b/functions/prepareMessage.html index 43cfe8b04..3802d0dbc 100644 --- a/functions/prepareMessage.html +++ b/functions/prepareMessage.html @@ -1 +1 @@ -prepareMessage | @xmtp/react-native-sdk

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareMessageWithContentType.html b/functions/prepareMessageWithContentType.html index 851559277..245db2454 100644 --- a/functions/prepareMessageWithContentType.html +++ b/functions/prepareMessageWithContentType.html @@ -1 +1 @@ -prepareMessageWithContentType | @xmtp/react-native-sdk

Function prepareMessageWithContentType

Generated using TypeDoc

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

Function prepareMessageWithContentType

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/receiveSignature.html b/functions/receiveSignature.html index ab3368d43..0f3711700 100644 --- a/functions/receiveSignature.html +++ b/functions/receiveSignature.html @@ -1 +1 @@ -receiveSignature | @xmtp/react-native-sdk
  • Parameters

    • requestID: string
    • signature: string

    Returns Promise<any>

Generated using TypeDoc

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

    • requestID: string
    • signature: string

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/refreshConsentList.html b/functions/refreshConsentList.html index 21ff45a7e..5f0f15f8a 100644 --- a/functions/refreshConsentList.html +++ b/functions/refreshConsentList.html @@ -1 +1 @@ -refreshConsentList | @xmtp/react-native-sdk

Function refreshConsentList

Generated using TypeDoc

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

Function refreshConsentList

Generated using TypeDoc

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

Function registerPushToken

  • Parameters

    • pushServer: string
    • token: string

    Returns any

Generated using TypeDoc

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

Function registerPushToken

  • Parameters

    • pushServer: string
    • token: string

    Returns any

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendMessage.html b/functions/sendMessage.html index 1299f4223..e6463becb 100644 --- a/functions/sendMessage.html +++ b/functions/sendMessage.html @@ -1 +1 @@ -sendMessage | @xmtp/react-native-sdk
  • Parameters

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

    Returns Promise<string>

Generated using TypeDoc

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

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

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendPreparedMessage.html b/functions/sendPreparedMessage.html index 20a13e7cf..cfa1fa8ce 100644 --- a/functions/sendPreparedMessage.html +++ b/functions/sendPreparedMessage.html @@ -1 +1 @@ -sendPreparedMessage | @xmtp/react-native-sdk

Function sendPreparedMessage

  • Parameters

    Returns Promise<string>

Generated using TypeDoc

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

Function sendPreparedMessage

  • Parameters

    Returns Promise<string>

Generated using TypeDoc

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

Function sendWithContentType

  • Type Parameters

    • T

    Parameters

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

    Returns Promise<string>

Generated using TypeDoc

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

Function sendWithContentType

  • Type Parameters

    • T

    Parameters

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

    Returns Promise<string>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/staticCanMessage.html b/functions/staticCanMessage.html index 1f33800e4..840796f50 100644 --- a/functions/staticCanMessage.html +++ b/functions/staticCanMessage.html @@ -1 +1 @@ -staticCanMessage | @xmtp/react-native-sdk
  • Parameters

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

    Returns Promise<boolean>

Generated using TypeDoc

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

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

    Returns Promise<boolean>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribePushTopics.html b/functions/subscribePushTopics.html index 7de048797..83204cb8b 100644 --- a/functions/subscribePushTopics.html +++ b/functions/subscribePushTopics.html @@ -1 +1 @@ -subscribePushTopics | @xmtp/react-native-sdk

Function subscribePushTopics

  • Parameters

    • topics: string[]

    Returns any

Generated using TypeDoc

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

Function subscribePushTopics

  • Parameters

    • topics: string[]

    Returns any

Generated using TypeDoc

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

Function subscribeToAllMessages

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function subscribeToAllMessages

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToConversations.html b/functions/subscribeToConversations.html index 13fdb39b9..9bc64cdf6 100644 --- a/functions/subscribeToConversations.html +++ b/functions/subscribeToConversations.html @@ -1 +1 @@ -subscribeToConversations | @xmtp/react-native-sdk

Function subscribeToConversations

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function subscribeToConversations

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToMessages.html b/functions/subscribeToMessages.html index 5bc7851fe..93329c07c 100644 --- a/functions/subscribeToMessages.html +++ b/functions/subscribeToMessages.html @@ -1 +1 @@ -subscribeToMessages | @xmtp/react-native-sdk

Function subscribeToMessages

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Generated using TypeDoc

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

Function subscribeToMessages

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Generated using TypeDoc

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

Function unsubscribeFromAllMessages

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function unsubscribeFromAllMessages

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function unsubscribeFromConversations

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function unsubscribeFromConversations

  • Parameters

    • clientAddress: string

    Returns any

Generated using TypeDoc

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

Function unsubscribeFromMessages

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Generated using TypeDoc

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

Function unsubscribeFromMessages

  • Parameters

    • clientAddress: string
    • topic: string

    Returns Promise<any>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useClient.html b/functions/useClient.html index ea9d63c73..afcbc75db 100644 --- a/functions/useClient.html +++ b/functions/useClient.html @@ -1 +1 @@ -useClient | @xmtp/react-native-sdk
  • 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

Generated using TypeDoc

\ No newline at end of file +useClient | @xmtp/react-native-sdk
  • 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

Generated using TypeDoc

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

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html index 6e7a0c4f5..dd46e3948 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

Methods

Properties

contentType: ContentTypeId

Methods

Generated using TypeDoc

\ No newline at end of file +

Properties

contentType: ContentTypeId

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/NativeContentCodec.html b/interfaces/NativeContentCodec.html index f1d425bf7..dac99817d 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: string
contentType: ContentTypeId

Methods

Generated using TypeDoc

\ No newline at end of file +

Properties

contentKey: string
contentType: ContentTypeId

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/XmtpContextValue.html b/interfaces/XmtpContextValue.html index 2929341de..e9c5f3fba 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

Properties

client: null | Client<any>

The XMTP client instance

-
setClient: Dispatch<SetStateAction<null | Client<any>>>

Set the XMTP client instance

-

Generated using TypeDoc

\ No newline at end of file +
setClient: Dispatch<SetStateAction<null | Client<any>>>

Set the XMTP client instance

+

Generated using TypeDoc

\ No newline at end of file diff --git a/modules/XmtpProvider.html b/modules/XmtpProvider.html index 8e612213d..aa621b82c 100644 --- a/modules/XmtpProvider.html +++ b/modules/XmtpProvider.html @@ -1 +1 @@ -XmtpProvider | @xmtp/react-native-sdk

Generated using TypeDoc

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentCodec.html b/types/ContentCodec.html index a8e6a844b..925b8bef7 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeId.html b/types/ContentTypeId.html index 227d2a96f..94d468d39 100644 --- a/types/ContentTypeId.html +++ b/types/ContentTypeId.html @@ -1 +1 @@ -ContentTypeId | @xmtp/react-native-sdk

Type alias ContentTypeId

ContentTypeId: content.ContentTypeId

Generated using TypeDoc

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

Type alias ContentTypeId

ContentTypeId: content.ContentTypeId

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ConversationContext.html b/types/ConversationContext.html index 40e3452cb..7fe6687ab 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DecryptedLocalAttachment.html b/types/DecryptedLocalAttachment.html index 7a435df08..cb92ff8e7 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EncodedContent.html b/types/EncodedContent.html index 33699bd2c..32411f5f2 100644 --- a/types/EncodedContent.html +++ b/types/EncodedContent.html @@ -1 +1 @@ -EncodedContent | @xmtp/react-native-sdk

Type alias EncodedContent

EncodedContent: content.EncodedContent

Generated using TypeDoc

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

Type alias EncodedContent

EncodedContent: content.EncodedContent

Generated using TypeDoc

\ No newline at end of file diff --git a/types/EncryptedLocalAttachment.html b/types/EncryptedLocalAttachment.html index 7a7707e80..cfe68bdae 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

Generated using TypeDoc

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

Type alias EncryptedLocalAttachment

EncryptedLocalAttachment: {
    encryptedLocalFileUri: string;
    metadata: RemoteAttachmentMetadata;
}

Type declaration

Generated using TypeDoc

\ No newline at end of file diff --git a/types/NativeMessageContent.html b/types/NativeMessageContent.html index acc44a0e4..892487eb7 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/PreparedLocalMessage.html b/types/PreparedLocalMessage.html index 8dcdf6ae1..f9075534b 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}`

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}`

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Query.html b/types/Query.html index fef049285..1b8870956 100644 --- a/types/Query.html +++ b/types/Query.html @@ -1 +1 @@ -Query | @xmtp/react-native-sdk
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

Generated using TypeDoc

\ No newline at end of file +Query | @xmtp/react-native-sdk
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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ReactionContent.html b/types/ReactionContent.html index 2a4b36100..7df7a4692 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"

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"

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ReadReceiptContent.html b/types/ReadReceiptContent.html index 9cbfab0d2..39d1c75c6 100644 --- a/types/ReadReceiptContent.html +++ b/types/ReadReceiptContent.html @@ -1 +1 @@ -ReadReceiptContent | @xmtp/react-native-sdk

Type alias ReadReceiptContent

ReadReceiptContent: object

Generated using TypeDoc

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

Type alias ReadReceiptContent

ReadReceiptContent: object

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RemoteAttachmentContent.html b/types/RemoteAttachmentContent.html index 83a7bf67a..59fcd8613 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/RemoteAttachmentMetadata.html b/types/RemoteAttachmentMetadata.html index 51b3f9375..61bb37a5a 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ReplyContent.html b/types/ReplyContent.html index e03ae7d9d..1adaf7157 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/StaticAttachmentContent.html b/types/StaticAttachmentContent.html index f0a5e7e86..ebcb308f8 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

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

Generated using TypeDoc

\ No newline at end of file diff --git a/types/UnknownContent.html b/types/UnknownContent.html index a3f46f4d9..8d22ccf55 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

Generated using TypeDoc

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

Type alias UnknownContent

UnknownContent: {
    contentTypeId: string;
}

Type declaration

  • contentTypeId: string

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/XmtpContext.html b/variables/XmtpContext.html index 309f925e1..0b0aa3a44 100644 --- a/variables/XmtpContext.html +++ b/variables/XmtpContext.html @@ -1 +1 @@ -XmtpContext | @xmtp/react-native-sdk

Variable XmtpContextConst

XmtpContext: Context<XmtpContextValue> = ...

Generated using TypeDoc

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

Variable XmtpContextConst

XmtpContext: Context<XmtpContextValue> = ...

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/emitter.html b/variables/emitter.html index a78fdf0c2..4a8f3124b 100644 --- a/variables/emitter.html +++ b/variables/emitter.html @@ -1 +1 @@ -emitter | @xmtp/react-native-sdk

Variable emitterConst

emitter: EventEmitter = ...

Generated using TypeDoc

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

Variable emitterConst

emitter: EventEmitter = ...

Generated using TypeDoc

\ No newline at end of file