From 29541b91e8449ea91d34d7dc3828f9665007f131 Mon Sep 17 00:00:00 2001 From: nplasterer Date: Thu, 7 Mar 2024 20:32:08 +0000 Subject: [PATCH] deploy: e42c65668aaa9c86c6f75df3da7f2ce0e6d23034 --- classes/Client.html | 24 +++++++++---------- classes/ConsentListEntry.html | 4 ++-- classes/Conversation.html | 20 ++++++++-------- 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/exportPublicKeyBundle.html | 2 +- functions/getHmacKeys.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/sign.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 +- 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 +- 77 files changed, 110 insertions(+), 110 deletions(-) diff --git a/classes/Client.html b/classes/Client.html index 8ac7a0c1..6190205d 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 @@ -16,51 +16,51 @@ 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.

    -

exportPublicKeyBundle

listBatchMessages

exportPublicKeyBundle

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.

    -

sign

  • sign(digest, keyType): Promise<Uint8Array>

  • Parameters

    • digest: Uint8Array
    • keyType: KeyType

    Returns Promise<Uint8Array>

Static canMessage

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

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

    +

sign

  • sign(digest, keyType): Promise<Uint8Array>

  • Parameters

    • digest: Uint8Array
    • keyType: KeyType

    Returns Promise<Uint8Array>

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>(wallet, 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>(wallet, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>

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

    Type Parameters

    Parameters

    • wallet: null | Signer | {}
    • 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 e7a5ae71..7062ec2a 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 d642721a..72802604 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? @@ -16,19 +16,19 @@ 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;
          keyMaterial?: string;
          peerAddress: string;
          topic: string;
          version: string;
      }
      • Optional context?: ConversationContext
      • Optional conversationID?: string
      • createdAt: number
      • Optional keyMaterial?: string
      • 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

Optional keyMaterial

keyMaterial?: string

Base64 encoded key material for the conversation.

-

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;
          keyMaterial?: string;
          peerAddress: string;
          topic: string;
          version: string;
      }
      • Optional context?: ConversationContext
      • Optional conversationID?: string
      • createdAt: number
      • Optional keyMaterial?: string
      • 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

Optional keyMaterial

keyMaterial?: string

Base64 encoded key material for the conversation.

+

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.

      @@ -36,7 +36,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 @@ -46,18 +46,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.

    @@ -68,4 +68,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 e1c64375..319a14a4 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 5bc7ae11..82af2808 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 28c41d61..29cf4d96 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 6f867c2e..38226221 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 00fe6375..b815b752 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 51857e91..dc432e4b 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 b22b927f..a6c49ba8 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 aadf7f43..32da1676 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 868026f6..6e0bce78 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 89493e8b..b0231a5e 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 e064d9cb..83cd046b 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 04373dab..64907e0c 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 e3fb03a4..b255c9ef 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 26a169e3..90bd13d2 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 39232674..be7d40a4 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 f42e3bd8..b326327e 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 2d4f83a5..509b7a51 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 a0a5d5f8..f254e5dd 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 b23e714c..6b35b767 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 c2aaf79a..935ef868 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 3e8a015f..7cfcceeb 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 ce457797..9e7f1945 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 932ee575..6b37e0a3 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/exportPublicKeyBundle.html b/functions/exportPublicKeyBundle.html index f20e0613..140d600b 100644 --- a/functions/exportPublicKeyBundle.html +++ b/functions/exportPublicKeyBundle.html @@ -1 +1 @@ -exportPublicKeyBundle | @xmtp/react-native-sdk

Function exportPublicKeyBundle

  • exportPublicKeyBundle(clientAddress): Promise<Uint8Array>

  • Parameters

    • clientAddress: string

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function exportPublicKeyBundle

  • exportPublicKeyBundle(clientAddress): Promise<Uint8Array>

  • Parameters

    • clientAddress: string

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getHmacKeys.html b/functions/getHmacKeys.html index 25cb65d8..50b99b14 100644 --- a/functions/getHmacKeys.html +++ b/functions/getHmacKeys.html @@ -1 +1 @@ -getHmacKeys | @xmtp/react-native-sdk

Function getHmacKeys

  • getHmacKeys(clientAddress): Promise<keystore.GetConversationHmacKeysResponse>

  • Parameters

    • clientAddress: string

    Returns Promise<keystore.GetConversationHmacKeysResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getHmacKeys

  • getHmacKeys(clientAddress): Promise<keystore.GetConversationHmacKeysResponse>

  • Parameters

    • clientAddress: string

    Returns Promise<keystore.GetConversationHmacKeysResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/importConversationTopicData.html b/functions/importConversationTopicData.html index 18e81852..f1996d18 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 e7c40858..7ae34912 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 4fb2f578..a9c01165 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 e0421f31..acb3e83e 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 c162514e..4788cab6 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 e946ac6a..bab75641 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 26d82574..0cc32ae2 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 dd4b0887..c3a2228b 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 7f35f84d..b9b75e27 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 6bd2d3e5..974caaf6 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 fd3e1234..a970ab98 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 e2ac917c..840f110c 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 2de07fd7..f8ccac6d 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 b92ec333..4d97475b 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 fd485829..82075443 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 f4b3314a..b1d013d5 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/sign.html b/functions/sign.html index a36d6e21..e19ba9ca 100644 --- a/functions/sign.html +++ b/functions/sign.html @@ -1 +1 @@ -sign | @xmtp/react-native-sdk

Function sign

  • sign(clientAddress, digest, keyType, preKeyIndex?): Promise<Uint8Array>

  • Parameters

    • clientAddress: string
    • digest: Uint8Array
    • keyType: string
    • preKeyIndex: number = 0

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function sign

  • sign(clientAddress, digest, keyType, preKeyIndex?): Promise<Uint8Array>

  • Parameters

    • clientAddress: string
    • digest: Uint8Array
    • keyType: string
    • preKeyIndex: number = 0

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/staticCanMessage.html b/functions/staticCanMessage.html index 63afbfa9..d0e83de7 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 2e01b055..d309886b 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 ddf65298..fc35f4fc 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 8174084b..68973231 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 5b5fa5a4..da8f360b 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 5848d6ec..14b928cc 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 6f19d0b2..a10d66bd 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 d707f7e9..88586e14 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 81f54daa..7252044f 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 d5b524e9..80413c43 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/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html index d61a6254..826b88c9 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 7296fe3f..eac2ceab 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 0ef8a66a..984b7eb8 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 0e11d4d5..d8ea27ef 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 31093177..e0799a2f 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 c728b243..b821b393 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 f7f4e7e9..c321fefe 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 c1704efa..2e1b92dc 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 aa5098c4..e8db0b66 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 d766a35d..e0e81e2a 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 85fc15cc..a31f6a3b 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 d1aaf30f..85349252 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 046c0121..a08c221c 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 d6ae3d5a..d59ac073 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 48393351..3ae5bee9 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 0c95b93a..59583ff4 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 2f4eab50..cb88cf08 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 302cd9ed..2129c503 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 5cf63c5f..ce9a8b22 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 7993a328..203b6c30 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 035e110f..ee1aa299 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 3ca4c92e..2ba915de 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