diff --git a/classes/Client.html b/classes/Client.html index bcf11e81..40cc3cd9 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -1,4 +1,4 @@ -Client | @xmtp/react-native-sdk

Class Client<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Constructors

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

Class Client<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Constructors

constructor

Properties

address codecRegistry contacts @@ -30,66 +30,66 @@ dropClient exportNativeLogs getOrCreateInboxId -

Constructors

constructor

Properties

address

address: string

codecRegistry

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

Type declaration

contacts

contacts: default

conversations

conversations: default<ContentTypes>

dbPath

dbPath: string

inboxId

inboxId: InboxId

installationId

installationId: string

Methods

canGroupMessage

  • canGroupMessage(addresses): Promise<{
        [key: string]: boolean;
    }>

  • Determines whether the current user can send messages to the specified peers over groups.

    +

Constructors

constructor

Properties

address

address: string

codecRegistry

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

Type declaration

contacts

contacts: default

conversations

conversations: default<ContentTypes>

dbPath

dbPath: string

inboxId

inboxId: InboxId

installationId

installationId: string

Methods

canGroupMessage

  • canGroupMessage(addresses): Promise<{
        [key: string]: boolean;
    }>

  • Determines whether the current user can send messages to the specified peers over groups.

    This method checks if the specified peers are using clients that support group messaging.

    Parameters

    • addresses: string[]

      The addresses of the peers to check for messaging eligibility.

    Returns Promise<{
        [key: string]: boolean;
    }>

    A Promise resolving to a hash of addresses and booleans if they can message on the V3 network.

    -

canMessage

  • canMessage(peerAddress): Promise<boolean>

  • Determines whether the current user can send messages to a specified peer over 1:1 conversations.

    +

canMessage

  • canMessage(peerAddress): Promise<boolean>

  • Determines whether the current user can send messages to a specified peer over 1:1 conversations.

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

    -

deleteLocalDatabase

  • deleteLocalDatabase(): Promise<any>

  • Deletes the local database. This cannot be undone and these stored messages will not be refetched from the network.

    -

    Returns Promise<any>

dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(): Promise<any>

  • Drop the local database connection. This function is delicate and should be used with caution. App will error if database not properly reconnected. See: reconnectLocalDatabase()

    -

    Returns Promise<any>

encryptAttachment

deleteLocalDatabase

  • deleteLocalDatabase(): Promise<any>

  • Deletes the local database. This cannot be undone and these stored messages will not be refetched from the network.

    +

    Returns Promise<any>

dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(): Promise<any>

  • Drop the local database connection. This function is delicate and should be used with caution. App will error if database not properly reconnected. See: reconnectLocalDatabase()

    +

    Returns Promise<any>

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

findInboxIdFromAddress

  • findInboxIdFromAddress(peerAddress): Promise<undefined | InboxId>

  • Find the inboxId associated with this address

    +

exportPublicKeyBundle

findInboxIdFromAddress

  • findInboxIdFromAddress(peerAddress): Promise<undefined | InboxId>

  • Find the inboxId associated with this address

    Parameters

    • peerAddress: string

      The address of the peer to check for inboxId.

    Returns Promise<undefined | InboxId>

    A Promise resolving to the InboxId.

    -

inboxState

  • inboxState(refreshFromNetwork): Promise<InboxState>

  • Make a request for a inboxs state.

    +

inboxState

  • inboxState(refreshFromNetwork): Promise<InboxState>

  • Make a request for a inboxs state.

    Parameters

    • refreshFromNetwork: boolean

      If you want to refresh the current state of in the inbox from the network or not.

    Returns Promise<InboxState>

    A Promise resolving to a InboxState.

    -

listBatchMessages

listBatchMessages

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

  • 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<ContentTypes>[]>

    A Promise that resolves to a list of batch messages.

    Throws

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

    -

reconnectLocalDatabase

  • reconnectLocalDatabase(): Promise<any>

  • Reconnects the local database after being dropped.

    -

    Returns Promise<any>

register

requestMessageHistorySync

  • requestMessageHistorySync(): Promise<any>

  • Make a request for a message history sync.

    -

    Returns Promise<any>

revokeAllOtherInstallations

  • revokeAllOtherInstallations(wallet): Promise<void>

  • Revoke all other installations but the current one.

    -

    Parameters

    Returns Promise<void>

sendPreparedMessage

  • sendPreparedMessage(prepared): Promise<string>

  • Sends a prepared message.

    +

reconnectLocalDatabase

  • reconnectLocalDatabase(): Promise<any>

  • Reconnects the local database after being dropped.

    +

    Returns Promise<any>

register

requestMessageHistorySync

  • requestMessageHistorySync(): Promise<any>

  • Make a request for a message history sync.

    +

    Returns Promise<any>

revokeAllOtherInstallations

  • revokeAllOtherInstallations(wallet): Promise<void>

  • Revoke all other installations but the current one.

    +

    Parameters

    Returns Promise<void>

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

Returns Promise<boolean>

Static create

Static createFromKeyBundle

Static createFromKeyBundle

Static createRandom

Static createRandom

Static dropClient

Static exportNativeLogs

Static getOrCreateInboxId

Static dropClient

Static exportNativeLogs

Static getOrCreateInboxId

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<InboxId>

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 f8e99a33..af98bf51 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: ConsentListEntryType

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: ConsentListEntryType

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 af0a5397..6365d26e 100644 --- a/classes/Conversation.html +++ b/classes/Conversation.html @@ -1,4 +1,4 @@ -Conversation | @xmtp/react-native-sdk

Class Conversation<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes

Implements

Constructors

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

Class Conversation<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes

Implements

Constructors

constructor

Properties

client consentProof? context? @@ -16,20 +16,20 @@ send sendPreparedMessage streamMessages -

Constructors

constructor

Properties

client

client: Client<ContentTypes>

Optional consentProof

consentProof?: ConsentProofPayload

Proof of consent for the conversation, used when a user is subscribing to broadcasts.

-

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: ConversationVersion = ConversationVersion.DIRECT

Methods

consentState

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

  • Retrieves the consent state for the current conversation.

    +

Constructors

constructor

Properties

client

client: Client<ContentTypes>

Optional consentProof

consentProof?: ConsentProofPayload

Proof of consent for the conversation, used when a user is subscribing to broadcasts.

+

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: ConversationVersion = ConversationVersion.DIRECT

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

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

    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.

      @@ -37,7 +37,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<PrepareContentTypes>(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 @@ -47,21 +47,21 @@

    Todo

    Support pagination and conversation ID in future implementations

    Type Parameters

    • PrepareContentTypes extends DefaultContentTypes = ContentTypes

    Parameters

    • content: ConversationSendPayload<PrepareContentTypes>

      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<SendContentTypes>(content, opts?): Promise<string>

  • Sends a message to the current conversation.

    Type Parameters

    Parameters

    • content: ConversationSendPayload<SendContentTypes>

      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): Promise<(() => void)>

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

    +

streamMessages

  • streamMessages(callback): Promise<(() => 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.

    Parameters

    • callback: ((message) => Promise<void>)

      A callback function that will be invoked with the new DecodedMessage when a message is received.

    Returns Promise<(() => 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 bbdb6816..1aa84bc9 100644 --- a/classes/DecodedMessage.html +++ b/classes/DecodedMessage.html @@ -1,4 +1,4 @@ -DecodedMessage | @xmtp/react-native-sdk

Class DecodedMessage<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Constructors

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

Class DecodedMessage<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Constructors

constructor

Properties

client contentTypeId deliveryStatus @@ -11,4 +11,4 @@

Methods

content from fromObject -

Constructors

constructor

Properties

client

client: Client<ContentTypes>

contentTypeId

contentTypeId: string

deliveryStatus

deliveryStatus: MessageDeliveryStatus = MessageDeliveryStatus.PUBLISHED

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

client

client: Client<ContentTypes>

contentTypeId

contentTypeId: string

deliveryStatus

deliveryStatus: MessageDeliveryStatus = MessageDeliveryStatus.PUBLISHED

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Group.html b/classes/Group.html index 2e1bde7e..5a324cfa 100644 --- a/classes/Group.html +++ b/classes/Group.html @@ -1,4 +1,4 @@ -Group | @xmtp/react-native-sdk

Class Group<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Implements

Constructors

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

Class Group<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Implements

Constructors

constructor

Properties

addedByInboxId client createdAt @@ -53,96 +53,96 @@ updateGroupPinnedFrameUrlPermission updateRemoveAdminPermission updateRemoveMemberPermission -

Constructors

constructor

Properties

addedByInboxId

addedByInboxId: InboxId

client

client: Client<ContentTypes>

createdAt

createdAt: number

creatorInboxId

creatorInboxId: InboxId

description

description: string

id

id: string

imageUrlSquare

imageUrlSquare: string

isGroupActive

isGroupActive: boolean

members

members: Member[]

name

name: string

topic

topic: string

version

version: ConversationVersion = ConversationVersion.GROUP

Methods

addAdmin

  • addAdmin(inboxId): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the inboxId is added to the group admins. +

Constructors

constructor

Properties

addedByInboxId

addedByInboxId: InboxId

client

client: Client<ContentTypes>

createdAt

createdAt: number

creatorInboxId

creatorInboxId: InboxId

description

description: string

id

id: string

imageUrlSquare

imageUrlSquare: string

isGroupActive

isGroupActive: boolean

members

members: Member[]

name

name: string

topic

topic: string

version

version: ConversationVersion = ConversationVersion.GROUP

Methods

addAdmin

  • addAdmin(inboxId): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the inboxId is added to the group admins. Will throw if the user does not have the required permissions.

    -

addMembers

  • addMembers(addresses): Promise<void>

  • Parameters

    • addresses: string[]

      addresses to add to the group

      -

    Returns Promise<void>

addMembersByInboxId

  • addMembersByInboxId(inboxIds): Promise<void>

  • Parameters

    • inboxIds: InboxId[]

      inboxIds to add to the group

      -

    Returns Promise<void>

addSuperAdmin

  • addSuperAdmin(inboxId): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the inboxId is added to the group super admins. +

addMembers

  • addMembers(addresses): Promise<void>

  • Parameters

    • addresses: string[]

      addresses to add to the group

      +

    Returns Promise<void>

addMembersByInboxId

  • addMembersByInboxId(inboxIds): Promise<void>

  • Parameters

    • inboxIds: InboxId[]

      inboxIds to add to the group

      +

    Returns Promise<void>

addSuperAdmin

  • addSuperAdmin(inboxId): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the inboxId is added to the group super admins. Will throw if the user does not have the required permissions.

    -

consentState

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

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

groupDescription

consentState

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

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

groupDescription

  • groupDescription(): Promise<string>

  • Returns the group description. To get the latest group description from the network, call sync() first.

    Returns Promise<string>

    A Promise that resolves to the group description.

    -

groupImageUrlSquare

  • groupImageUrlSquare(): Promise<string>

  • Returns the group image url square. +

groupImageUrlSquare

  • groupImageUrlSquare(): Promise<string>

  • Returns the group image url square. To get the latest group image url square from the network, call sync() first.

    Returns Promise<string>

    A Promise that resolves to the group name.

    -

groupName

groupName

  • groupName(): Promise<string>

  • Returns the group name. To get the latest group name from the network, call sync() first.

    Returns Promise<string>

    A Promise that resolves to the group name.

    -

groupPinnedFrameUrl

  • groupPinnedFrameUrl(): Promise<string>

  • Returns the group pinned frame. +

groupPinnedFrameUrl

  • groupPinnedFrameUrl(): Promise<string>

  • Returns the group pinned frame. To get the latest group pinned frame url from the network, call sync() first.

    Returns Promise<string>

    A Promise that resolves to the group pinned frame url.

    -

isActive

isActive

  • isActive(): Promise<boolean>

  • Returns whether the group is active. To get the latest active status from the network, call sync() first

    Returns Promise<boolean>

    A Promise that resolves if the group is active or not

    -

isAdmin

  • isAdmin(inboxId): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

    whether a given inboxId is an admin of the group. +

isAdmin

  • isAdmin(inboxId): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

    whether a given inboxId is an admin of the group. To get the latest admin status from the network, call sync() first.

    -

isAllowed

  • isAllowed(): Promise<boolean>

  • Returns Promise<boolean>

    a boolean indicating whether the group is allowed by the user.

    -

isDenied

  • isDenied(): Promise<boolean>

  • Returns Promise<boolean>

    a boolean indicating whether the group is denied by the user.

    -

isSuperAdmin

  • isSuperAdmin(inboxId): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

    whether a given inboxId is a super admin of the group. +

isAllowed

  • isAllowed(): Promise<boolean>

  • Returns Promise<boolean>

    a boolean indicating whether the group is allowed by the user.

    +

isDenied

  • isDenied(): Promise<boolean>

  • Returns Promise<boolean>

    a boolean indicating whether the group is denied by the user.

    +

isSuperAdmin

  • isSuperAdmin(inboxId): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

    whether a given inboxId is a super admin of the group. To get the latest super admin status from the network, call sync() first.

    -

listAdmins

listAdmins

  • listAdmins(): Promise<InboxId[]>

  • Returns Promise<InboxId[]>

    A Promise that resolves to an array of inboxIds that are admins of the group. To get the latest admin list from the network, call sync() first.

    -

listSuperAdmins

  • listSuperAdmins(): Promise<InboxId[]>

  • Returns Promise<InboxId[]>

    A Promise that resolves to an array of inboxIds that are super admins of the group. +

listSuperAdmins

  • listSuperAdmins(): Promise<InboxId[]>

  • Returns Promise<InboxId[]>

    A Promise that resolves to an array of inboxIds that are super admins of the group. To get the latest super admin list from the network, call sync() first.

    -

memberInboxIds

  • memberInboxIds(): Promise<InboxId[]>

  • This method returns an array of inbox ids associated with the group. +

memberInboxIds

  • memberInboxIds(): Promise<InboxId[]>

  • This method returns an array of inbox ids associated with the group. To get the latest member inbox ids from the network, call sync() first.

    Returns Promise<InboxId[]>

    A Promise that resolves to an array of DecodedMessage objects.

    -

membersList

membersList

  • membersList(): Promise<Member[]>

  • Returns Promise<Member[]>

    A Promise that resolves to an array of Member objects. To get the latest member list from the network, call sync() first.

    -

messages

messages

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

  • This method returns an array of messages associated with the group. To get the latest messages from the network, call sync() first.

    Parameters

    • Optional opts: MessagesOptions

    Returns Promise<DecodedMessage<ContentTypes>[]>

    A Promise that resolves to an array of DecodedMessage objects.

    -

permissionPolicySet

  • permissionPolicySet(): Promise<PermissionPolicySet>

  • Returns Promise<PermissionPolicySet>

    A {PermissionPolicySet} object representing the group's permission policy set.

    -

prepareMessage

permissionPolicySet

  • permissionPolicySet(): Promise<PermissionPolicySet>

  • Returns Promise<PermissionPolicySet>

    A {PermissionPolicySet} object representing the group's permission policy set.

    +

prepareMessage

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

  • Prepare a group message to be sent.

    Type Parameters

    Parameters

    • content: ConversationSendPayload<SendContentTypes>

      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 prepared message to be sent.

    Throws

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

    -

processMessage

publishPreparedMessages

  • publishPreparedMessages(): Promise<any>

  • Publish all prepared messages.

    +

processMessage

publishPreparedMessages

  • publishPreparedMessages(): Promise<any>

  • Publish all prepared messages.

    Returns Promise<any>

    Throws

    Throws an error if there is an issue finding the unpublished message

    -

removeAdmin

  • removeAdmin(inboxId): Promise<void>

  • Parameters

    Returns Promise<void>

    A Promise that resolves when the inboxId is removed from the group admins. +

removeAdmin

removeMembers

removeMembersByInboxId

removeSuperAdmin

removeMembers

removeMembersByInboxId

removeSuperAdmin

send

send

streamGroupMessages

streamGroupMessages

sync

sync

updateAddAdminPermission

Returns Promise<void>

updateAddAdminPermission

updateAddMemberPermission

updateAddMemberPermission

updateGroupDescription

updateGroupDescription

updateGroupDescriptionPermission

Returns Promise<void>

updateGroupDescriptionPermission

updateGroupImageUrlSquare

updateGroupImageUrlSquare

updateGroupImageUrlSquarePermission

Returns Promise<void>

updateGroupImageUrlSquarePermission

updateGroupName

updateGroupName

updateGroupNamePermission

Returns Promise<void>

updateGroupNamePermission

updateGroupPinnedFrameUrl

updateGroupPinnedFrameUrl

updateGroupPinnedFrameUrlPermission

Returns Promise<void>

updateGroupPinnedFrameUrlPermission

updateRemoveAdminPermission

updateRemoveAdminPermission

updateRemoveMemberPermission

updateRemoveMemberPermission

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/GroupUpdatedCodec.html b/classes/GroupUpdatedCodec.html index cc30ee68..38cc4030 100644 --- a/classes/GroupUpdatedCodec.html +++ b/classes/GroupUpdatedCodec.html @@ -1,7 +1,7 @@ -GroupUpdatedCodec | @xmtp/react-native-sdk

Class GroupUpdatedCodec

Implements

Constructors

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

Class GroupUpdatedCodec

Implements

Constructors

constructor

Properties

contentKey contentType

Methods

decode encode fallback -

Constructors

constructor

Properties

contentKey

contentKey: "groupUpdated" = 'groupUpdated'

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: "groupUpdated" = 'groupUpdated'

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/Member.html b/classes/Member.html index 7cd1b2e8..095f5a85 100644 --- a/classes/Member.html +++ b/classes/Member.html @@ -1,6 +1,6 @@ -Member | @xmtp/react-native-sdk

Class Member

Constructors

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

Class Member

Constructors

constructor

Properties

addresses inboxId permissionLevel

Methods

from -

Constructors

constructor

  • new Member(inboxId, addresses, permissionLevel): Member

  • Parameters

    • inboxId: InboxId
    • addresses: string[]
    • permissionLevel: "member" | "admin" | "super_admin"

    Returns Member

Properties

addresses

addresses: string[]

inboxId

inboxId: InboxId

permissionLevel

permissionLevel: "member" | "admin" | "super_admin"

Methods

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

  • new Member(inboxId, addresses, permissionLevel): Member

  • Parameters

    • inboxId: InboxId
    • addresses: string[]
    • permissionLevel: "member" | "admin" | "super_admin"

    Returns Member

Properties

addresses

addresses: string[]

inboxId

inboxId: InboxId

permissionLevel

permissionLevel: "member" | "admin" | "super_admin"

Methods

Static from

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 e48dcf9e..fa244298 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: "reaction" = '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: "reaction" = '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 3c95e093..3a9077ff 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 b5b04537..60272896 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: "remoteAttachment" = '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: "remoteAttachment" = '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 15785cd3..1b7685f7 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: "reply" = '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: "reply" = '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 57385bac..f91f2dc5 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: "attachment" = '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: "attachment" = '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 98670521..05d7aaaa 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: "text" = '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: "text" = '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 ff595c73..ab9c960e 100644 --- a/classes/XMTPPush.html +++ b/classes/XMTPPush.html @@ -1,5 +1,5 @@ -XMTPPush | @xmtp/react-native-sdk

Class XMTPPush

Constructors

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

Class XMTPPush

Constructors

constructor

Properties

client

Methods

subscribe register -

Constructors

constructor

Properties

client

client: Client<any>

Methods

subscribe

Static register

  • register(server, token): void

  • Parameters

    • server: string
    • token: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

client

client: Client<any>

Methods

subscribe

Static register

  • register(server, token): void

  • Parameters

    • server: string
    • token: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/ConversationVersion.html b/enums/ConversationVersion.html index 85ca5e9b..f30347ad 100644 --- a/enums/ConversationVersion.html +++ b/enums/ConversationVersion.html @@ -1,3 +1,3 @@ -ConversationVersion | @xmtp/react-native-sdk

Enumeration ConversationVersion

Enumeration Members

DIRECT +ConversationVersion | @xmtp/react-native-sdk

Enumeration ConversationVersion

Enumeration Members

DIRECT GROUP -

Enumeration Members

DIRECT

DIRECT: "DIRECT"

GROUP

GROUP: "GROUP"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DIRECT

DIRECT: "DIRECT"

GROUP

GROUP: "GROUP"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/MessageDeliveryStatus.html b/enums/MessageDeliveryStatus.html index ecd5f822..a17c6e23 100644 --- a/enums/MessageDeliveryStatus.html +++ b/enums/MessageDeliveryStatus.html @@ -1,5 +1,5 @@ -MessageDeliveryStatus | @xmtp/react-native-sdk

Enumeration MessageDeliveryStatus

Enumeration Members

ALL +MessageDeliveryStatus | @xmtp/react-native-sdk

Enumeration MessageDeliveryStatus

Enumeration Members

ALL FAILED PUBLISHED UNPUBLISHED -

Enumeration Members

ALL

ALL: "ALL"

FAILED

FAILED: "FAILED"

PUBLISHED

PUBLISHED: "PUBLISHED"

UNPUBLISHED

UNPUBLISHED: "UNPUBLISHED"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

ALL

ALL: "ALL"

FAILED

FAILED: "FAILED"

PUBLISHED

PUBLISHED: "PUBLISHED"

UNPUBLISHED

UNPUBLISHED: "UNPUBLISHED"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/XmtpProvider.html b/functions/XmtpProvider.html index 838b22e3..3ee8ad6a 100644 --- a/functions/XmtpProvider.html +++ b/functions/XmtpProvider.html @@ -1 +1 @@ -XmtpProvider | @xmtp/react-native-sdk

Function XmtpProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function XmtpProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addAdmin

  • addAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addAdmin

  • addAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addGroupMembers

  • addGroupMembers(inboxId, id, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addGroupMembers

  • addGroupMembers(inboxId, id, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/addGroupMembersByInboxId.html b/functions/addGroupMembersByInboxId.html index 706d60c9..3c068f11 100644 --- a/functions/addGroupMembersByInboxId.html +++ b/functions/addGroupMembersByInboxId.html @@ -1 +1 @@ -addGroupMembersByInboxId | @xmtp/react-native-sdk

Function addGroupMembersByInboxId

  • addGroupMembersByInboxId(inboxId, id, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addGroupMembersByInboxId

  • addGroupMembersByInboxId(inboxId, id, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/addSuperAdmin.html b/functions/addSuperAdmin.html index 3068ed5a..2c7c27a6 100644 --- a/functions/addSuperAdmin.html +++ b/functions/addSuperAdmin.html @@ -1 +1 @@ -addSuperAdmin | @xmtp/react-native-sdk

Function addSuperAdmin

  • addSuperAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addSuperAdmin

  • addSuperAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/addedByInboxId.html b/functions/addedByInboxId.html index 6d65a5a5..5210cea8 100644 --- a/functions/addedByInboxId.html +++ b/functions/addedByInboxId.html @@ -1 +1 @@ -addedByInboxId | @xmtp/react-native-sdk

Function addedByInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addedByInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/address.html b/functions/address.html index f3a5eb85..695b904a 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 6a3b5524..8b085f6d 100644 --- a/functions/allowContacts.html +++ b/functions/allowContacts.html @@ -1 +1 @@ -allowContacts | @xmtp/react-native-sdk

Function allowContacts

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

  • Parameters

    • inboxId: 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(inboxId, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function allowGroups

  • allowGroups(inboxId, groupIds): Promise<void>

  • Parameters

    • inboxId: string
    • groupIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function allowGroups

  • allowGroups(inboxId, groupIds): Promise<void>

  • Parameters

    • inboxId: string
    • groupIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/allowInboxes.html b/functions/allowInboxes.html index 68c0b2a7..68a7c35d 100644 --- a/functions/allowInboxes.html +++ b/functions/allowInboxes.html @@ -1 +1 @@ -allowInboxes | @xmtp/react-native-sdk

Function allowInboxes

  • allowInboxes(inboxId, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function allowInboxes

  • allowInboxes(inboxId, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • inboxIds: 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 a2361b57..5104fa48 100644 --- a/functions/auth.html +++ b/functions/auth.html @@ -1 +1 @@ -auth | @xmtp/react-native-sdk

Function auth

  • auth(address, environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?, hasPreAuthenticateToInboxCallback?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<any>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: string

    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?, hasPreAuthenticateToInboxCallback?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<any>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function canGroupMessage

  • canGroupMessage(inboxId, peerAddresses): Promise<{
        [key: string]: boolean;
    }>

  • Parameters

    • inboxId: string
    • peerAddresses: string[]

    Returns Promise<{
        [key: string]: boolean;
    }>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function canGroupMessage

  • canGroupMessage(inboxId, peerAddresses): Promise<{
        [key: string]: boolean;
    }>

  • Parameters

    • inboxId: string
    • peerAddresses: string[]

    Returns Promise<{
        [key: string]: boolean;
    }>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function canMessage

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

  • Parameters

    • inboxId: 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(inboxId, peerAddress): Promise<boolean>

  • Parameters

    • inboxId: 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 ea447b5d..dee5d3ab 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 7ab6f896..d82f1a69 100644 --- a/functions/conversationConsentState.html +++ b/functions/conversationConsentState.html @@ -1 +1 @@ -conversationConsentState | @xmtp/react-native-sdk

Function conversationConsentState

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

  • Parameters

    • inboxId: 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(inboxId, conversationTopic): Promise<ConsentState>

  • Parameters

    • inboxId: string
    • conversationTopic: string

    Returns Promise<ConsentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/convertWalletClientToSigner.html b/functions/convertWalletClientToSigner.html index 3df894b9..20935f5f 100644 --- a/functions/convertWalletClientToSigner.html +++ b/functions/convertWalletClientToSigner.html @@ -1 +1 @@ -convertWalletClientToSigner | @xmtp/react-native-sdk

Function convertWalletClientToSigner

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function convertWalletClientToSigner

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createConversation.html b/functions/createConversation.html index 104de23f..4e9d5065 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 a7dd04ef..c4df2d69 100644 --- a/functions/createFromKeyBundle.html +++ b/functions/createFromKeyBundle.html @@ -1 +1 @@ -createFromKeyBundle | @xmtp/react-native-sdk

Function createFromKeyBundle

  • createFromKeyBundle(keyBundle, environment, appVersion?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<string>

  • Parameters

    • keyBundle: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: 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?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<string>

  • Parameters

    • keyBundle: string
    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function createGroup

  • createGroup<ContentTypes>(client, peerAddresses, permissionLevel?, name?, imageUrlSquare?, description?, pinnedFrameUrl?): Promise<Group<ContentTypes>>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • client: Client<ContentTypes>
    • peerAddresses: string[]
    • permissionLevel: "all_members" | "admin_only" = 'all_members'
    • name: string = ''
    • imageUrlSquare: string = ''
    • description: string = ''
    • pinnedFrameUrl: string = ''

    Returns Promise<Group<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function createGroup

  • createGroup<ContentTypes>(client, peerAddresses, permissionLevel?, name?, imageUrlSquare?, description?, pinnedFrameUrl?): Promise<Group<ContentTypes>>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • client: Client<ContentTypes>
    • peerAddresses: string[]
    • permissionLevel: "all_members" | "admin_only" = 'all_members'
    • name: string = ''
    • imageUrlSquare: string = ''
    • description: string = ''
    • pinnedFrameUrl: string = ''

    Returns Promise<Group<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createGroupCustomPermissions.html b/functions/createGroupCustomPermissions.html index d26a9d64..0ee94506 100644 --- a/functions/createGroupCustomPermissions.html +++ b/functions/createGroupCustomPermissions.html @@ -1 +1 @@ -createGroupCustomPermissions | @xmtp/react-native-sdk

Function createGroupCustomPermissions

  • createGroupCustomPermissions<ContentTypes>(client, peerAddresses, permissionPolicySet, name?, imageUrlSquare?, description?, pinnedFrameUrl?): Promise<Group<ContentTypes>>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • client: Client<ContentTypes>
    • peerAddresses: string[]
    • permissionPolicySet: PermissionPolicySet
    • name: string = ''
    • imageUrlSquare: string = ''
    • description: string = ''
    • pinnedFrameUrl: string = ''

    Returns Promise<Group<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function createGroupCustomPermissions

  • createGroupCustomPermissions<ContentTypes>(client, peerAddresses, permissionPolicySet, name?, imageUrlSquare?, description?, pinnedFrameUrl?): Promise<Group<ContentTypes>>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • client: Client<ContentTypes>
    • peerAddresses: string[]
    • permissionPolicySet: PermissionPolicySet
    • name: string = ''
    • imageUrlSquare: string = ''
    • description: string = ''
    • pinnedFrameUrl: string = ''

    Returns Promise<Group<ContentTypes>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/createRandom.html b/functions/createRandom.html index 38e6adac..60b5ecfb 100644 --- a/functions/createRandom.html +++ b/functions/createRandom.html @@ -1 +1 @@ -createRandom | @xmtp/react-native-sdk

Function createRandom

  • createRandom(environment, appVersion?, hasCreateIdentityCallback?, hasEnableIdentityCallback?, hasPreAuthenticateToInboxCallback?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<string>

  • Parameters

    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: string

    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?, hasPreAuthenticateToInboxCallback?, enableV3?, dbEncryptionKey?, dbDirectory?, historySyncUrl?): Promise<string>

  • Parameters

    • environment: "local" | "dev" | "production"
    • Optional appVersion: string
    • Optional hasCreateIdentityCallback: boolean
    • Optional hasEnableIdentityCallback: boolean
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional enableV3: boolean
    • Optional dbEncryptionKey: Uint8Array
    • Optional dbDirectory: string
    • Optional historySyncUrl: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/creatorInboxId.html b/functions/creatorInboxId.html index 8859847b..557acdfb 100644 --- a/functions/creatorInboxId.html +++ b/functions/creatorInboxId.html @@ -1 +1 @@ -creatorInboxId | @xmtp/react-native-sdk

Function creatorInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function creatorInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/decodeMessage.html b/functions/decodeMessage.html index e98a3098..c5f6fd72 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 b7b50e6a..190f2730 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/deleteLocalDatabase.html b/functions/deleteLocalDatabase.html index f615265c..e9144b95 100644 --- a/functions/deleteLocalDatabase.html +++ b/functions/deleteLocalDatabase.html @@ -1 +1 @@ -deleteLocalDatabase | @xmtp/react-native-sdk

Function deleteLocalDatabase

  • deleteLocalDatabase(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function deleteLocalDatabase

  • deleteLocalDatabase(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function denyContacts

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

  • Parameters

    • inboxId: 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(inboxId, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function denyGroups

  • denyGroups(inboxId, groupIds): Promise<void>

  • Parameters

    • inboxId: string
    • groupIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function denyGroups

  • denyGroups(inboxId, groupIds): Promise<void>

  • Parameters

    • inboxId: string
    • groupIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/denyInboxes.html b/functions/denyInboxes.html index 4b869a27..498bc6bd 100644 --- a/functions/denyInboxes.html +++ b/functions/denyInboxes.html @@ -1 +1 @@ -denyInboxes | @xmtp/react-native-sdk

Function denyInboxes

  • denyInboxes(inboxId, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function denyInboxes

  • denyInboxes(inboxId, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/dropClient.html b/functions/dropClient.html index 68c22aa4..9520b02a 100644 --- a/functions/dropClient.html +++ b/functions/dropClient.html @@ -1 +1 @@ -dropClient | @xmtp/react-native-sdk

Function dropClient

  • dropClient(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function dropClient

  • dropClient(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/dropLocalDatabaseConnection.html b/functions/dropLocalDatabaseConnection.html index 5d142564..353f81a3 100644 --- a/functions/dropLocalDatabaseConnection.html +++ b/functions/dropLocalDatabaseConnection.html @@ -1 +1 @@ -dropLocalDatabaseConnection | @xmtp/react-native-sdk

Function dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/encryptAttachment.html b/functions/encryptAttachment.html index 5d1c34d3..a409ecf1 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 51012fd4..2179777b 100644 --- a/functions/exportConversationTopicData.html +++ b/functions/exportConversationTopicData.html @@ -1 +1 @@ -exportConversationTopicData | @xmtp/react-native-sdk

Function exportConversationTopicData

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

  • Parameters

    • inboxId: 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(inboxId, conversationTopic): Promise<string>

  • Parameters

    • inboxId: 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 e7fd4ac2..75a93d9f 100644 --- a/functions/exportKeyBundle.html +++ b/functions/exportKeyBundle.html @@ -1 +1 @@ -exportKeyBundle | @xmtp/react-native-sdk

Function exportKeyBundle

  • exportKeyBundle(inboxId): Promise<string>

  • Parameters

    • inboxId: 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(inboxId): Promise<string>

  • Parameters

    • inboxId: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/exportNativeLogs.html b/functions/exportNativeLogs.html index 972bc3f5..f8de2269 100644 --- a/functions/exportNativeLogs.html +++ b/functions/exportNativeLogs.html @@ -1 +1 @@ -exportNativeLogs | @xmtp/react-native-sdk

Function exportNativeLogs

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function exportNativeLogs

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/exportPublicKeyBundle.html b/functions/exportPublicKeyBundle.html index 8aed6185..884418d0 100644 --- a/functions/exportPublicKeyBundle.html +++ b/functions/exportPublicKeyBundle.html @@ -1 +1 @@ -exportPublicKeyBundle | @xmtp/react-native-sdk

Function exportPublicKeyBundle

  • exportPublicKeyBundle(inboxId): Promise<Uint8Array>

  • Parameters

    • inboxId: 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(inboxId): Promise<Uint8Array>

  • Parameters

    • inboxId: string

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/findGroup.html b/functions/findGroup.html index 79f10911..ae0d52ad 100644 --- a/functions/findGroup.html +++ b/functions/findGroup.html @@ -1 +1 @@ -findGroup | @xmtp/react-native-sdk

Function findGroup

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findGroup

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findInboxIdFromAddress

  • findInboxIdFromAddress(inboxId, address): Promise<InboxId | undefined>

  • Parameters

    • inboxId: string
    • address: string

    Returns Promise<InboxId | undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findInboxIdFromAddress

  • findInboxIdFromAddress(inboxId, address): Promise<InboxId | undefined>

  • Parameters

    • inboxId: string
    • address: string

    Returns Promise<InboxId | undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findV3Message

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findV3Message

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getHmacKeys

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

  • Parameters

    • inboxId: 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(inboxId): Promise<keystore.GetConversationHmacKeysResponse>

  • Parameters

    • inboxId: string

    Returns Promise<keystore.GetConversationHmacKeysResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getInboxState.html b/functions/getInboxState.html index bbd9dc2b..61f872eb 100644 --- a/functions/getInboxState.html +++ b/functions/getInboxState.html @@ -1 +1 @@ -getInboxState | @xmtp/react-native-sdk

Function getInboxState

  • getInboxState(inboxId, refreshFromNetwork): Promise<InboxState>

  • Parameters

    • inboxId: string
    • refreshFromNetwork: boolean

    Returns Promise<InboxState>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getInboxState

  • getInboxState(inboxId, refreshFromNetwork): Promise<InboxState>

  • Parameters

    • inboxId: string
    • refreshFromNetwork: boolean

    Returns Promise<InboxState>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getOrCreateInboxId

  • getOrCreateInboxId(address, environment): Promise<InboxId>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"

    Returns Promise<InboxId>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getOrCreateInboxId

  • getOrCreateInboxId(address, environment): Promise<InboxId>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"

    Returns Promise<InboxId>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getSigner

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getSigner

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/groupConsentState.html b/functions/groupConsentState.html index 9a7eb9a2..5fa440e8 100644 --- a/functions/groupConsentState.html +++ b/functions/groupConsentState.html @@ -1 +1 @@ -groupConsentState | @xmtp/react-native-sdk

Function groupConsentState

  • groupConsentState(inboxId, groupId): Promise<ConsentState>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<ConsentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupConsentState

  • groupConsentState(inboxId, groupId): Promise<ConsentState>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<ConsentState>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupDescription

  • groupDescription(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupDescription

  • groupDescription(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupImageUrlSquare

  • groupImageUrlSquare(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupImageUrlSquare

  • groupImageUrlSquare(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/groupName.html b/functions/groupName.html index 30a9a4f5..3bc5bfe5 100644 --- a/functions/groupName.html +++ b/functions/groupName.html @@ -1 +1 @@ -groupName | @xmtp/react-native-sdk

Function groupName

  • groupName(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupName

  • groupName(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/groupPinnedFrameUrl.html b/functions/groupPinnedFrameUrl.html index 5bc4d918..91ec83f4 100644 --- a/functions/groupPinnedFrameUrl.html +++ b/functions/groupPinnedFrameUrl.html @@ -1 +1 @@ -groupPinnedFrameUrl | @xmtp/react-native-sdk

Function groupPinnedFrameUrl

  • groupPinnedFrameUrl(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function groupPinnedFrameUrl

  • groupPinnedFrameUrl(inboxId, id): string | PromiseLike<string>

  • Parameters

    • inboxId: string
    • id: string

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function importConversationTopicData

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function importConversationTopicData

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function inboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function inboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isAdmin.html b/functions/isAdmin.html index 5a5bd336..8c68f7d1 100644 --- a/functions/isAdmin.html +++ b/functions/isAdmin.html @@ -1 +1 @@ -isAdmin | @xmtp/react-native-sdk

Function isAdmin

  • isAdmin(clientInboxId, id, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isAdmin

  • isAdmin(clientInboxId, id, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isAllowed

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

  • Parameters

    • inboxId: 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(inboxId, address): Promise<boolean>

  • Parameters

    • inboxId: 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 6390755b..ab141cef 100644 --- a/functions/isDenied.html +++ b/functions/isDenied.html @@ -1 +1 @@ -isDenied | @xmtp/react-native-sdk

Function isDenied

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

  • Parameters

    • inboxId: 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(inboxId, address): Promise<boolean>

  • Parameters

    • inboxId: string
    • address: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isGroupActive.html b/functions/isGroupActive.html index 7b883ea1..70fc0173 100644 --- a/functions/isGroupActive.html +++ b/functions/isGroupActive.html @@ -1 +1 @@ -isGroupActive | @xmtp/react-native-sdk

Function isGroupActive

  • isGroupActive(inboxId, id): Promise<boolean>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isGroupActive

  • isGroupActive(inboxId, id): Promise<boolean>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isGroupAllowed

  • isGroupAllowed(inboxId, groupId): Promise<boolean>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isGroupAllowed

  • isGroupAllowed(inboxId, groupId): Promise<boolean>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isGroupDenied.html b/functions/isGroupDenied.html index 4f732c40..65022e74 100644 --- a/functions/isGroupDenied.html +++ b/functions/isGroupDenied.html @@ -1 +1 @@ -isGroupDenied | @xmtp/react-native-sdk

Function isGroupDenied

  • isGroupDenied(inboxId, groupId): Promise<boolean>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isGroupDenied

  • isGroupDenied(inboxId, groupId): Promise<boolean>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isInboxAllowed

  • isInboxAllowed(clientInboxId, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isInboxAllowed

  • isInboxAllowed(clientInboxId, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isInboxDenied.html b/functions/isInboxDenied.html index 10651f94..4913453b 100644 --- a/functions/isInboxDenied.html +++ b/functions/isInboxDenied.html @@ -1 +1 @@ -isInboxDenied | @xmtp/react-native-sdk

Function isInboxDenied

  • isInboxDenied(clientInboxId, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isInboxDenied

  • isInboxDenied(clientInboxId, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isSuperAdmin

  • isSuperAdmin(clientInboxId, id, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isSuperAdmin

  • isSuperAdmin(clientInboxId, id, inboxId): Promise<boolean>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listAdmins

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listAdmins

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listAll.html b/functions/listAll.html index 0d8eb57c..c966a2e8 100644 --- a/functions/listAll.html +++ b/functions/listAll.html @@ -1 +1 @@ -listAll | @xmtp/react-native-sdk

Function listAll

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listAll

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listBatchMessages.html b/functions/listBatchMessages.html index 710ba886..1c04bad8 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 cfc0e2bb..d60d0bd5 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/listGroupMembers.html b/functions/listGroupMembers.html index f53dcc5b..2b629b05 100644 --- a/functions/listGroupMembers.html +++ b/functions/listGroupMembers.html @@ -1 +1 @@ -listGroupMembers | @xmtp/react-native-sdk

Function listGroupMembers

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listGroupMembers

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listGroups.html b/functions/listGroups.html index 0aeec073..224651ed 100644 --- a/functions/listGroups.html +++ b/functions/listGroups.html @@ -1 +1 @@ -listGroups | @xmtp/react-native-sdk

Function listGroups

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listGroups

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listMemberInboxIds.html b/functions/listMemberInboxIds.html index 3dcd1a0f..3941ed67 100644 --- a/functions/listMemberInboxIds.html +++ b/functions/listMemberInboxIds.html @@ -1 +1 @@ -listMemberInboxIds | @xmtp/react-native-sdk

Function listMemberInboxIds

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listMemberInboxIds

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listMessages.html b/functions/listMessages.html index 841aadc4..0a1f686d 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<ContentTypes>[]>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    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<ContentTypes>[]>

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<ContentTypes>[]>

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    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<ContentTypes>[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listSuperAdmins.html b/functions/listSuperAdmins.html index 24930d3a..b9e5d7ec 100644 --- a/functions/listSuperAdmins.html +++ b/functions/listSuperAdmins.html @@ -1 +1 @@ -listSuperAdmins | @xmtp/react-native-sdk

Function listSuperAdmins

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listSuperAdmins

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function permissionPolicySet

  • permissionPolicySet(clientInboxId, id): Promise<PermissionPolicySet>

  • Parameters

    • clientInboxId: string
    • id: string

    Returns Promise<PermissionPolicySet>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function permissionPolicySet

  • permissionPolicySet(clientInboxId, id): Promise<PermissionPolicySet>

  • Parameters

    • clientInboxId: string
    • id: string

    Returns Promise<PermissionPolicySet>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/preAuthenticateToInboxCallbackCompleted.html b/functions/preAuthenticateToInboxCallbackCompleted.html index 25d2031a..21f3fbed 100644 --- a/functions/preAuthenticateToInboxCallbackCompleted.html +++ b/functions/preAuthenticateToInboxCallbackCompleted.html @@ -1 +1 @@ -preAuthenticateToInboxCallbackCompleted | @xmtp/react-native-sdk

Function preAuthenticateToInboxCallbackCompleted

  • preAuthenticateToInboxCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function preAuthenticateToInboxCallbackCompleted

  • preAuthenticateToInboxCallbackCompleted(): void

  • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/preCreateIdentityCallbackCompleted.html b/functions/preCreateIdentityCallbackCompleted.html index af9b89dd..3a8b8790 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 70bc233b..2d87c379 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/prepareGroupMessage.html b/functions/prepareGroupMessage.html index cd282f1a..d585f20e 100644 --- a/functions/prepareGroupMessage.html +++ b/functions/prepareGroupMessage.html @@ -1 +1 @@ -prepareGroupMessage | @xmtp/react-native-sdk

Function prepareGroupMessage

  • prepareGroupMessage(inboxId, groupId, content): Promise<string>

  • Parameters

    • inboxId: string
    • groupId: string
    • content: any

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function prepareGroupMessage

  • prepareGroupMessage(inboxId, groupId, content): Promise<string>

  • Parameters

    • inboxId: string
    • groupId: string
    • content: any

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/prepareMessage.html b/functions/prepareMessage.html index a676f97f..468550af 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 389f2803..8c40351b 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/processGroupMessage.html b/functions/processGroupMessage.html index e0a81e57..f4311429 100644 --- a/functions/processGroupMessage.html +++ b/functions/processGroupMessage.html @@ -1 +1 @@ -processGroupMessage | @xmtp/react-native-sdk

Function processGroupMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function processGroupMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/processWelcomeMessage.html b/functions/processWelcomeMessage.html index 41ae9ad3..1c06e5e2 100644 --- a/functions/processWelcomeMessage.html +++ b/functions/processWelcomeMessage.html @@ -1 +1 @@ -processWelcomeMessage | @xmtp/react-native-sdk

Function processWelcomeMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function processWelcomeMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/publishPreparedGroupMessages.html b/functions/publishPreparedGroupMessages.html index 405990cb..4661988f 100644 --- a/functions/publishPreparedGroupMessages.html +++ b/functions/publishPreparedGroupMessages.html @@ -1 +1 @@ -publishPreparedGroupMessages | @xmtp/react-native-sdk

Function publishPreparedGroupMessages

  • publishPreparedGroupMessages(inboxId, groupId): Promise<any>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function publishPreparedGroupMessages

  • publishPreparedGroupMessages(inboxId, groupId): Promise<any>

  • Parameters

    • inboxId: string
    • groupId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/receiveSignature.html b/functions/receiveSignature.html index 7150f0c4..9b7c916f 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/reconnectLocalDatabase.html b/functions/reconnectLocalDatabase.html index 1a1c0ea4..8e805abf 100644 --- a/functions/reconnectLocalDatabase.html +++ b/functions/reconnectLocalDatabase.html @@ -1 +1 @@ -reconnectLocalDatabase | @xmtp/react-native-sdk

Function reconnectLocalDatabase

  • reconnectLocalDatabase(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function reconnectLocalDatabase

  • reconnectLocalDatabase(inboxId): Promise<any>

  • Parameters

    • inboxId: 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 901b1905..1716635a 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 7fa3cfa4..634196cf 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/removeAdmin.html b/functions/removeAdmin.html index 0c6b5ebc..07155156 100644 --- a/functions/removeAdmin.html +++ b/functions/removeAdmin.html @@ -1 +1 @@ -removeAdmin | @xmtp/react-native-sdk

Function removeAdmin

  • removeAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeAdmin

  • removeAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/removeGroupMembers.html b/functions/removeGroupMembers.html index 7b59de53..2512ab41 100644 --- a/functions/removeGroupMembers.html +++ b/functions/removeGroupMembers.html @@ -1 +1 @@ -removeGroupMembers | @xmtp/react-native-sdk

Function removeGroupMembers

  • removeGroupMembers(inboxId, id, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeGroupMembers

  • removeGroupMembers(inboxId, id, addresses): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • addresses: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/removeGroupMembersByInboxId.html b/functions/removeGroupMembersByInboxId.html index ade82bbe..55ff94c9 100644 --- a/functions/removeGroupMembersByInboxId.html +++ b/functions/removeGroupMembersByInboxId.html @@ -1 +1 @@ -removeGroupMembersByInboxId | @xmtp/react-native-sdk

Function removeGroupMembersByInboxId

  • removeGroupMembersByInboxId(inboxId, id, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeGroupMembersByInboxId

  • removeGroupMembersByInboxId(inboxId, id, inboxIds): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • inboxIds: string[]

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/removeSuperAdmin.html b/functions/removeSuperAdmin.html index 81188de0..6927d80f 100644 --- a/functions/removeSuperAdmin.html +++ b/functions/removeSuperAdmin.html @@ -1 +1 @@ -removeSuperAdmin | @xmtp/react-native-sdk

Function removeSuperAdmin

  • removeSuperAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeSuperAdmin

  • removeSuperAdmin(clientInboxId, id, inboxId): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/requestMessageHistorySync.html b/functions/requestMessageHistorySync.html index 860c5129..a101d198 100644 --- a/functions/requestMessageHistorySync.html +++ b/functions/requestMessageHistorySync.html @@ -1 +1 @@ -requestMessageHistorySync | @xmtp/react-native-sdk

Function requestMessageHistorySync

  • requestMessageHistorySync(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function requestMessageHistorySync

  • requestMessageHistorySync(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function revokeAllOtherInstallations

  • revokeAllOtherInstallations(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function revokeAllOtherInstallations

  • revokeAllOtherInstallations(inboxId): Promise<any>

  • Parameters

    • inboxId: string

    Returns Promise<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 4b9b4dff..c64ce47e 100644 --- a/functions/sendMessage.html +++ b/functions/sendMessage.html @@ -1 +1 @@ -sendMessage | @xmtp/react-native-sdk

Function sendMessage

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

  • Type Parameters

    • SendContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • inboxId: string
    • conversationTopic: string
    • content: ConversationSendPayload<SendContentTypes>

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function sendMessage

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

  • Type Parameters

    • SendContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

    • inboxId: string
    • conversationTopic: string
    • content: ConversationSendPayload<SendContentTypes>

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/sendMessageToGroup.html b/functions/sendMessageToGroup.html index f986f2a4..2193dc9a 100644 --- a/functions/sendMessageToGroup.html +++ b/functions/sendMessageToGroup.html @@ -1 +1 @@ -sendMessageToGroup | @xmtp/react-native-sdk

Function sendMessageToGroup

  • sendMessageToGroup(inboxId, groupId, content): Promise<string>

  • Parameters

    • inboxId: string
    • groupId: string
    • content: any

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function sendMessageToGroup

  • sendMessageToGroup(inboxId, groupId, content): Promise<string>

  • Parameters

    • inboxId: string
    • groupId: 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 50002ef6..8d942d08 100644 --- a/functions/sendPreparedMessage.html +++ b/functions/sendPreparedMessage.html @@ -1 +1 @@ -sendPreparedMessage | @xmtp/react-native-sdk

Function sendPreparedMessage

  • sendPreparedMessage(inboxId, 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(inboxId, 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 06bfdcb4..4783b877 100644 --- a/functions/sendWithContentType.html +++ b/functions/sendWithContentType.html @@ -1 +1 @@ -sendWithContentType | @xmtp/react-native-sdk

Function sendWithContentType

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

  • Type Parameters

    • T

    Parameters

    • inboxId: 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>(inboxId, conversationTopic, content, codec): Promise<string>

  • Type Parameters

    • T

    Parameters

    • inboxId: 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 1dd5e603..dd4f9cba 100644 --- a/functions/sign.html +++ b/functions/sign.html @@ -1 +1 @@ -sign | @xmtp/react-native-sdk

Function sign

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

  • Parameters

    • inboxId: 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(inboxId, digest, keyType, preKeyIndex?): Promise<Uint8Array>

  • Parameters

    • inboxId: 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 590109c5..ba629f1f 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 696aa315..e8293eac 100644 --- a/functions/subscribePushTopics.html +++ b/functions/subscribePushTopics.html @@ -1 +1 @@ -subscribePushTopics | @xmtp/react-native-sdk

Function subscribePushTopics

  • subscribePushTopics(inboxId, topics): any

  • Parameters

    • inboxId: string
    • 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(inboxId, topics): any

  • Parameters

    • inboxId: string
    • topics: string[]

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToAll.html b/functions/subscribeToAll.html index c5317a9c..77d16dc7 100644 --- a/functions/subscribeToAll.html +++ b/functions/subscribeToAll.html @@ -1 +1 @@ -subscribeToAll | @xmtp/react-native-sdk

Function subscribeToAll

  • subscribeToAll(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToAll

  • subscribeToAll(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToAllGroupMessages.html b/functions/subscribeToAllGroupMessages.html index 4a8393fa..8826d529 100644 --- a/functions/subscribeToAllGroupMessages.html +++ b/functions/subscribeToAllGroupMessages.html @@ -1 +1 @@ -subscribeToAllGroupMessages | @xmtp/react-native-sdk

Function subscribeToAllGroupMessages

  • subscribeToAllGroupMessages(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToAllGroupMessages

  • subscribeToAllGroupMessages(inboxId): any

  • Parameters

    • inboxId: 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 d594c281..9a6051a9 100644 --- a/functions/subscribeToAllMessages.html +++ b/functions/subscribeToAllMessages.html @@ -1 +1 @@ -subscribeToAllMessages | @xmtp/react-native-sdk

Function subscribeToAllMessages

  • subscribeToAllMessages(inboxId, includeGroups): any

  • Parameters

    • inboxId: string
    • includeGroups: boolean

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToAllMessages

  • subscribeToAllMessages(inboxId, includeGroups): any

  • Parameters

    • inboxId: string
    • includeGroups: boolean

    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 1a58ac77..6d4d9373 100644 --- a/functions/subscribeToConversations.html +++ b/functions/subscribeToConversations.html @@ -1 +1 @@ -subscribeToConversations | @xmtp/react-native-sdk

Function subscribeToConversations

  • subscribeToConversations(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToConversations

  • subscribeToConversations(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/subscribeToGroupMessages.html b/functions/subscribeToGroupMessages.html index 79e8be8a..2d891437 100644 --- a/functions/subscribeToGroupMessages.html +++ b/functions/subscribeToGroupMessages.html @@ -1 +1 @@ -subscribeToGroupMessages | @xmtp/react-native-sdk

Function subscribeToGroupMessages

  • subscribeToGroupMessages(inboxId, id): Promise<any>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToGroupMessages

  • subscribeToGroupMessages(inboxId, id): Promise<any>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToGroups

  • subscribeToGroups(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToGroups

  • subscribeToGroups(inboxId): any

  • Parameters

    • inboxId: 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 2976a4fd..b2de7c43 100644 --- a/functions/subscribeToMessages.html +++ b/functions/subscribeToMessages.html @@ -1 +1 @@ -subscribeToMessages | @xmtp/react-native-sdk

Function subscribeToMessages

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

  • Parameters

    • inboxId: 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(inboxId, topic): Promise<any>

  • Parameters

    • inboxId: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncAllGroups.html b/functions/syncAllGroups.html index 4de66be0..05a0fc7c 100644 --- a/functions/syncAllGroups.html +++ b/functions/syncAllGroups.html @@ -1 +1 @@ -syncAllGroups | @xmtp/react-native-sdk

Function syncAllGroups

  • syncAllGroups(inboxId): Promise<number>

  • Parameters

    • inboxId: string

    Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncAllGroups

  • syncAllGroups(inboxId): Promise<number>

  • Parameters

    • inboxId: string

    Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncGroup.html b/functions/syncGroup.html index 2539949c..4c28e89c 100644 --- a/functions/syncGroup.html +++ b/functions/syncGroup.html @@ -1 +1 @@ -syncGroup | @xmtp/react-native-sdk

Function syncGroup

  • syncGroup(inboxId, id): Promise<void>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncGroup

  • syncGroup(inboxId, id): Promise<void>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncGroups.html b/functions/syncGroups.html index 6b930671..d7f9c454 100644 --- a/functions/syncGroups.html +++ b/functions/syncGroups.html @@ -1 +1 @@ -syncGroups | @xmtp/react-native-sdk

Function syncGroups

  • syncGroups(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncGroups

  • syncGroups(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromAllGroupMessages

  • unsubscribeFromAllGroupMessages(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromAllGroupMessages

  • unsubscribeFromAllGroupMessages(inboxId): any

  • Parameters

    • inboxId: string

    Returns 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 ed2c4971..da29c6fc 100644 --- a/functions/unsubscribeFromAllMessages.html +++ b/functions/unsubscribeFromAllMessages.html @@ -1 +1 @@ -unsubscribeFromAllMessages | @xmtp/react-native-sdk

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(inboxId): any

  • Parameters

    • inboxId: 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 395e49fe..e0cf4aa4 100644 --- a/functions/unsubscribeFromConversations.html +++ b/functions/unsubscribeFromConversations.html @@ -1 +1 @@ -unsubscribeFromConversations | @xmtp/react-native-sdk

Function unsubscribeFromConversations

  • unsubscribeFromConversations(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromConversations

  • unsubscribeFromConversations(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromGroupMessages.html b/functions/unsubscribeFromGroupMessages.html index c4fbfeef..15290f0a 100644 --- a/functions/unsubscribeFromGroupMessages.html +++ b/functions/unsubscribeFromGroupMessages.html @@ -1 +1 @@ -unsubscribeFromGroupMessages | @xmtp/react-native-sdk

Function unsubscribeFromGroupMessages

  • unsubscribeFromGroupMessages(inboxId, id): Promise<any>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromGroupMessages

  • unsubscribeFromGroupMessages(inboxId, id): Promise<any>

  • Parameters

    • inboxId: string
    • id: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromGroups.html b/functions/unsubscribeFromGroups.html index 3a8c4ca6..72e3c55b 100644 --- a/functions/unsubscribeFromGroups.html +++ b/functions/unsubscribeFromGroups.html @@ -1 +1 @@ -unsubscribeFromGroups | @xmtp/react-native-sdk

Function unsubscribeFromGroups

  • unsubscribeFromGroups(inboxId): any

  • Parameters

    • inboxId: string

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromGroups

  • unsubscribeFromGroups(inboxId): any

  • Parameters

    • inboxId: 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 d60faaac..b523218b 100644 --- a/functions/unsubscribeFromMessages.html +++ b/functions/unsubscribeFromMessages.html @@ -1 +1 @@ -unsubscribeFromMessages | @xmtp/react-native-sdk

Function unsubscribeFromMessages

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

  • Parameters

    • inboxId: 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(inboxId, topic): Promise<any>

  • Parameters

    • inboxId: string
    • topic: string

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateAddAdminPermission

  • updateAddAdminPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateAddAdminPermission

  • updateAddAdminPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateAddMemberPermission

  • updateAddMemberPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateAddMemberPermission

  • updateAddMemberPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupDescription.html b/functions/updateGroupDescription.html index c4ed39ed..650d342b 100644 --- a/functions/updateGroupDescription.html +++ b/functions/updateGroupDescription.html @@ -1 +1 @@ -updateGroupDescription | @xmtp/react-native-sdk

Function updateGroupDescription

  • updateGroupDescription(inboxId, id, description): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • description: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupDescription

  • updateGroupDescription(inboxId, id, description): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • description: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupDescriptionPermission.html b/functions/updateGroupDescriptionPermission.html index 4442d1a0..010c56d1 100644 --- a/functions/updateGroupDescriptionPermission.html +++ b/functions/updateGroupDescriptionPermission.html @@ -1 +1 @@ -updateGroupDescriptionPermission | @xmtp/react-native-sdk

Function updateGroupDescriptionPermission

  • updateGroupDescriptionPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupDescriptionPermission

  • updateGroupDescriptionPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupImageUrlSquare.html b/functions/updateGroupImageUrlSquare.html index 0cd7f5e7..092d44ec 100644 --- a/functions/updateGroupImageUrlSquare.html +++ b/functions/updateGroupImageUrlSquare.html @@ -1 +1 @@ -updateGroupImageUrlSquare | @xmtp/react-native-sdk

Function updateGroupImageUrlSquare

  • updateGroupImageUrlSquare(inboxId, id, imageUrlSquare): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • imageUrlSquare: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupImageUrlSquare

  • updateGroupImageUrlSquare(inboxId, id, imageUrlSquare): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • imageUrlSquare: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupImageUrlSquarePermission.html b/functions/updateGroupImageUrlSquarePermission.html index 916dda2b..d867c98f 100644 --- a/functions/updateGroupImageUrlSquarePermission.html +++ b/functions/updateGroupImageUrlSquarePermission.html @@ -1 +1 @@ -updateGroupImageUrlSquarePermission | @xmtp/react-native-sdk

Function updateGroupImageUrlSquarePermission

  • updateGroupImageUrlSquarePermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupImageUrlSquarePermission

  • updateGroupImageUrlSquarePermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupName.html b/functions/updateGroupName.html index 7b4c90a5..42f737b2 100644 --- a/functions/updateGroupName.html +++ b/functions/updateGroupName.html @@ -1 +1 @@ -updateGroupName | @xmtp/react-native-sdk

Function updateGroupName

  • updateGroupName(inboxId, id, groupName): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • groupName: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupName

  • updateGroupName(inboxId, id, groupName): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • groupName: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupNamePermission.html b/functions/updateGroupNamePermission.html index 4713c7e9..816e8288 100644 --- a/functions/updateGroupNamePermission.html +++ b/functions/updateGroupNamePermission.html @@ -1 +1 @@ -updateGroupNamePermission | @xmtp/react-native-sdk

Function updateGroupNamePermission

  • updateGroupNamePermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupNamePermission

  • updateGroupNamePermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupPinnedFrameUrl.html b/functions/updateGroupPinnedFrameUrl.html index 485df41e..48d13379 100644 --- a/functions/updateGroupPinnedFrameUrl.html +++ b/functions/updateGroupPinnedFrameUrl.html @@ -1 +1 @@ -updateGroupPinnedFrameUrl | @xmtp/react-native-sdk

Function updateGroupPinnedFrameUrl

  • updateGroupPinnedFrameUrl(inboxId, id, pinnedFrameUrl): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • pinnedFrameUrl: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupPinnedFrameUrl

  • updateGroupPinnedFrameUrl(inboxId, id, pinnedFrameUrl): Promise<void>

  • Parameters

    • inboxId: string
    • id: string
    • pinnedFrameUrl: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateGroupPinnedFrameUrlPermission.html b/functions/updateGroupPinnedFrameUrlPermission.html index 81f2435c..a68d20b3 100644 --- a/functions/updateGroupPinnedFrameUrlPermission.html +++ b/functions/updateGroupPinnedFrameUrlPermission.html @@ -1 +1 @@ -updateGroupPinnedFrameUrlPermission | @xmtp/react-native-sdk

Function updateGroupPinnedFrameUrlPermission

  • updateGroupPinnedFrameUrlPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupPinnedFrameUrlPermission

  • updateGroupPinnedFrameUrlPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateRemoveAdminPermission.html b/functions/updateRemoveAdminPermission.html index 79abec0e..2d439b7b 100644 --- a/functions/updateRemoveAdminPermission.html +++ b/functions/updateRemoveAdminPermission.html @@ -1 +1 @@ -updateRemoveAdminPermission | @xmtp/react-native-sdk

Function updateRemoveAdminPermission

  • updateRemoveAdminPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateRemoveAdminPermission

  • updateRemoveAdminPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateRemoveMemberPermission

  • updateRemoveMemberPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateRemoveMemberPermission

  • updateRemoveMemberPermission(clientInboxId, id, permissionOption): Promise<void>

  • Parameters

    • clientInboxId: string
    • id: string
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function useClient

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

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

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

        • Parameters

          • e: Error

          Returns void

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

    • client: null | Client<ContentTypes>
    • 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<ContentTypes>(onError?): {
        client: null | Client<ContentTypes>;
        disconnect: (() => Promise<void>);
        error: null | Error;
        initialize: ((__namedParameters) => Promise<undefined | null | Client<any>>);
        isLoading: boolean;
    }

  • Type Parameters

    • ContentTypes extends DefaultContentTypes = DefaultContentTypes

    Parameters

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

        • Parameters

          • e: Error

          Returns void

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

    • client: null | Client<ContentTypes>
    • 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 213c73c4..59d7ae3d 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/ConversationContainer.html b/interfaces/ConversationContainer.html index 14ced8c5..45072b73 100644 --- a/interfaces/ConversationContainer.html +++ b/interfaces/ConversationContainer.html @@ -1,5 +1,5 @@ -ConversationContainer | @xmtp/react-native-sdk

Interface ConversationContainer<ContentTypes>

interface ConversationContainer<ContentTypes> {
    client: Client<ContentTypes>;
    createdAt: number;
    topic: string;
    version: ConversationVersion;
}

Type Parameters

  • ContentTypes extends DefaultContentTypes

Implemented by

Properties

client +ConversationContainer | @xmtp/react-native-sdk

Interface ConversationContainer<ContentTypes>

interface ConversationContainer<ContentTypes> {
    client: Client<ContentTypes>;
    createdAt: number;
    topic: string;
    version: ConversationVersion;
}

Type Parameters

  • ContentTypes extends DefaultContentTypes

Implemented by

Properties

client createdAt topic version -

Properties

client

client: Client<ContentTypes>

createdAt

createdAt: number

topic

topic: string

version

version: ConversationVersion

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

client

client: Client<ContentTypes>

createdAt

createdAt: number

topic

topic: string

version

version: ConversationVersion

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html index e9efaee8..86181c60 100644 --- a/interfaces/JSContentCodec.html +++ b/interfaces/JSContentCodec.html @@ -1,5 +1,5 @@ -JSContentCodec | @xmtp/react-native-sdk

Interface JSContentCodec<T>

interface JSContentCodec<T> {
    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<T> {
    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 c39a5051..1562e723 100644 --- a/interfaces/NativeContentCodec.html +++ b/interfaces/NativeContentCodec.html @@ -1,6 +1,6 @@ -NativeContentCodec | @xmtp/react-native-sdk

Interface NativeContentCodec<T>

interface NativeContentCodec<T> {
    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<T> {
    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/Signer.html b/interfaces/Signer.html index 2ec8f9f7..52248a73 100644 --- a/interfaces/Signer.html +++ b/interfaces/Signer.html @@ -1,3 +1,3 @@ -Signer | @xmtp/react-native-sdk

Interface Signer

interface Signer {
    getAddress: (() => Promise<string>);
    signMessage: ((message) => Promise<string>);
}

Properties

getAddress +Signer | @xmtp/react-native-sdk

Interface Signer

interface Signer {
    getAddress: (() => Promise<string>);
    signMessage: ((message) => Promise<string>);
}

Properties

getAddress signMessage -

Properties

getAddress

getAddress: (() => Promise<string>)

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

signMessage

signMessage: ((message) => Promise<string>)

Type declaration

    • (message): Promise<string>

    • Parameters

      • message: string

      Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

getAddress

getAddress: (() => Promise<string>)

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

signMessage

signMessage: ((message) => Promise<string>)

Type declaration

    • (message): Promise<string>

    • Parameters

      • message: string

      Returns Promise<string>

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 ba430f1a..3de8f52f 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/types/ContentCodec.html b/types/ContentCodec.html index 168121ca..adc7baac 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 fe2947d6..58801ad5 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 97c61da6..180e72a9 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 fb68f6a9..a8707a92 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 fef3515f..890c53f4 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 3a09da35..0e114862 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/GroupUpdatedContent.html b/types/GroupUpdatedContent.html index 7683b762..273d7ed8 100644 --- a/types/GroupUpdatedContent.html +++ b/types/GroupUpdatedContent.html @@ -1 +1 @@ -GroupUpdatedContent | @xmtp/react-native-sdk

Type alias GroupUpdatedContent

GroupUpdatedContent: {
    initiatedByInboxId: string;
    membersAdded: GroupUpdatedMemberEntry[];
    membersRemoved: GroupUpdatedMemberEntry[];
    metadataFieldsChanged: GroupUpdatedMetadatEntry[];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GroupUpdatedContent

GroupUpdatedContent: {
    initiatedByInboxId: string;
    membersAdded: GroupUpdatedMemberEntry[];
    membersRemoved: GroupUpdatedMemberEntry[];
    metadataFieldsChanged: GroupUpdatedMetadatEntry[];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GroupUpdatedMemberEntry.html b/types/GroupUpdatedMemberEntry.html index 21987837..8c226dfa 100644 --- a/types/GroupUpdatedMemberEntry.html +++ b/types/GroupUpdatedMemberEntry.html @@ -1 +1 @@ -GroupUpdatedMemberEntry | @xmtp/react-native-sdk

Type alias GroupUpdatedMemberEntry

GroupUpdatedMemberEntry: {
    inboxId: string;
}

Type declaration

  • inboxId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GroupUpdatedMemberEntry

GroupUpdatedMemberEntry: {
    inboxId: string;
}

Type declaration

  • inboxId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GroupUpdatedMetadatEntry.html b/types/GroupUpdatedMetadatEntry.html index 02601b0c..a0286823 100644 --- a/types/GroupUpdatedMetadatEntry.html +++ b/types/GroupUpdatedMetadatEntry.html @@ -1 +1 @@ -GroupUpdatedMetadatEntry | @xmtp/react-native-sdk

Type alias GroupUpdatedMetadatEntry

GroupUpdatedMetadatEntry: {
    fieldName: string;
    newValue: string;
    oldValue: string;
}

Type declaration

  • fieldName: string
  • newValue: string
  • oldValue: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GroupUpdatedMetadatEntry

GroupUpdatedMetadatEntry: {
    fieldName: string;
    newValue: string;
    oldValue: string;
}

Type declaration

  • fieldName: string
  • newValue: string
  • oldValue: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/InboxId.html b/types/InboxId.html index ba515604..cc65f247 100644 --- a/types/InboxId.html +++ b/types/InboxId.html @@ -1 +1 @@ -InboxId | @xmtp/react-native-sdk

Type alias InboxId

InboxId: string & {
    brand: unique symbol;
}

Type declaration

  • Readonly brand: unique symbol

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias InboxId

InboxId: string & {
    brand: unique symbol;
}

Type declaration

  • Readonly brand: unique symbol

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/NativeMessageContent.html b/types/NativeMessageContent.html index 69652ef1..5ecf8340 100644 --- a/types/NativeMessageContent.html +++ b/types/NativeMessageContent.html @@ -1 +1 @@ -NativeMessageContent | @xmtp/react-native-sdk

Type alias NativeMessageContent

NativeMessageContent: {
    attachment?: StaticAttachmentContent;
    encoded?: string;
    groupUpdated?: GroupUpdatedContent;
    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;
    groupUpdated?: GroupUpdatedContent;
    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 2712a770..ab95d1a7 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 571fccae..a15f829d 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 c28000d0..7076117e 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 68a85dff..7b4011f2 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 71b54646..e8c2920b 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 3c33d09b..216ebd2d 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 b3320da5..2bac56a8 100644 --- a/types/ReplyContent.html +++ b/types/ReplyContent.html @@ -1 +1 @@ -ReplyContent | @xmtp/react-native-sdk

Type alias ReplyContent

ReplyContent: {
    content: NativeMessageContent;
    reference: string;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ReplyContent

ReplyContent: {
    content: NativeMessageContent;
    reference: string;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/StaticAttachmentContent.html b/types/StaticAttachmentContent.html index b8a47d2c..61421056 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 2bb83251..64e8ba47 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 21a0a81a..62fe15d9 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 c9ff96ac..809e4b48 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