From 795456bccadd6cc11bfbaf837b108463bc2aa816 Mon Sep 17 00:00:00 2001 From: cameronvoell Date: Fri, 6 Dec 2024 16:58:22 +0000 Subject: [PATCH] deploy: 92e712af005196b528a590903eb29e67f7f588de --- classes/Client.html | 46 +++++------ classes/ConsentRecord.html | 4 +- classes/DecodedMessage.html | 4 +- classes/Dm.html | 20 ++--- classes/Group.html | 82 +++++++++---------- classes/GroupUpdatedCodec.html | 4 +- classes/Member.html | 4 +- classes/ReactionCodec.html | 4 +- classes/ReadReceiptCodec.html | 4 +- classes/RemoteAttachmentCodec.html | 4 +- classes/ReplyCodec.html | 4 +- classes/StaticAttachmentCodec.html | 4 +- classes/TextCodec.html | 4 +- classes/XMTPPush.html | 4 +- enums/ConversationVersion.html | 4 +- enums/MessageDeliveryStatus.html | 4 +- functions/XmtpProvider.html | 2 +- functions/addAccount.html | 2 +- functions/addAdmin.html | 2 +- functions/addGroupMembers.html | 2 +- functions/addGroupMembersByInboxId.html | 2 +- functions/addSuperAdmin.html | 2 +- functions/addedByInboxId.html | 2 +- functions/address-1.html | 2 +- functions/build.html | 2 +- functions/canMessage.html | 2 +- functions/consentAddressState.html | 2 +- functions/consentConversationIdState.html | 2 +- functions/consentInboxIdState.html | 2 +- functions/conversationConsentState.html | 2 +- functions/conversationMessages.html | 2 +- functions/convertWalletClientToSigner.html | 2 +- functions/create.html | 2 +- functions/createGroup.html | 2 +- functions/createGroupCustomPermissions.html | 2 +- functions/createRandom.html | 2 +- functions/creatorInboxId.html | 2 +- functions/decryptAttachment.html | 2 +- functions/deleteLocalDatabase.html | 2 +- functions/dmPeerInboxId.html | 2 +- functions/dropClient.html | 2 +- functions/dropLocalDatabaseConnection.html | 2 +- functions/encryptAttachment.html | 2 +- functions/exportNativeLogs.html | 2 +- functions/findConversation.html | 2 +- functions/findConversationByTopic.html | 2 +- functions/findDmByAddress.html | 2 +- functions/findDmByInboxId.html | 2 +- functions/findGroup.html | 2 +- functions/findInboxIdFromAddress.html | 2 +- functions/findMessage.html | 2 +- functions/findOrCreateDm.html | 2 +- functions/getInboxState.html | 2 +- functions/getInboxStates.html | 2 +- functions/getOrCreateInboxId.html | 2 +- functions/getSigner.html | 2 +- functions/groupDescription.html | 2 +- functions/groupImageUrlSquare.html | 2 +- functions/groupName.html | 2 +- functions/groupPinnedFrameUrl.html | 2 +- functions/inboxId-1.html | 2 +- functions/isAdmin.html | 2 +- functions/isGroupActive.html | 2 +- functions/isSuperAdmin.html | 2 +- functions/listAdmins.html | 2 +- functions/listConversationMembers.html | 2 +- functions/listConversations.html | 2 +- functions/listDms.html | 2 +- functions/listGroups.html | 2 +- functions/listMemberInboxIds.html | 2 +- functions/listSuperAdmins.html | 2 +- functions/permissionPolicySet.html | 2 +- ...eAuthenticateToInboxCallbackCompleted.html | 2 +- functions/prepareMessage.html | 2 +- functions/processMessage.html | 2 +- functions/processWelcomeMessage.html | 2 +- functions/publishPreparedMessages.html | 2 +- functions/receiveSCWSignature.html | 2 +- functions/receiveSignature.html | 2 +- functions/reconnectLocalDatabase.html | 2 +- functions/registerPushToken.html | 2 +- functions/removeAccount.html | 2 +- functions/removeAdmin.html | 2 +- functions/removeGroupMembers.html | 2 +- functions/removeGroupMembersByInboxId.html | 2 +- functions/removeSuperAdmin.html | 2 +- functions/requestMessageHistorySync.html | 2 +- functions/revokeAllOtherInstallations.html | 2 +- functions/sendMessage.html | 2 +- functions/setConsentState.html | 2 +- functions/signWithInstallationKey.html | 2 +- functions/staticCanMessage.html | 2 +- functions/subscribePushTopics.html | 2 +- functions/subscribeToAllMessages.html | 2 +- functions/subscribeToConsent.html | 2 +- functions/subscribeToConversations.html | 2 +- functions/subscribeToMessages.html | 2 +- functions/syncAllConversations.html | 2 +- functions/syncConsent.html | 2 +- functions/syncConversation.html | 2 +- functions/syncConversations.html | 2 +- functions/unsubscribeFromAllMessages.html | 2 +- functions/unsubscribeFromConsent.html | 2 +- functions/unsubscribeFromConversations.html | 2 +- functions/unsubscribeFromMessages.html | 2 +- functions/updateAddAdminPermission.html | 2 +- functions/updateAddMemberPermission.html | 2 +- functions/updateConversationConsent.html | 2 +- functions/updateGroupDescription.html | 2 +- .../updateGroupDescriptionPermission.html | 2 +- functions/updateGroupImageUrlSquare.html | 2 +- .../updateGroupImageUrlSquarePermission.html | 2 +- functions/updateGroupName.html | 2 +- functions/updateGroupNamePermission.html | 2 +- functions/updateGroupPinnedFrameUrl.html | 2 +- .../updateGroupPinnedFrameUrlPermission.html | 2 +- functions/updateRemoveAdminPermission.html | 2 +- functions/updateRemoveMemberPermission.html | 2 +- functions/useClient.html | 2 +- functions/useXmtp.html | 2 +- functions/verifySignature.html | 2 +- interfaces/JSContentCodec.html | 4 +- interfaces/NativeContentCodec.html | 4 +- interfaces/Signer.html | 4 +- interfaces/XmtpContextValue.html | 6 +- types/Address.html | 2 +- types/ConsentState.html | 2 +- types/ContentCodec.html | 2 +- types/ContentTypeId.html | 2 +- types/Conversation.html | 2 +- types/ConversationId.html | 2 +- types/ConversationOptions.html | 2 +- types/ConversationOrder.html | 2 +- types/ConversationTopic.html | 2 +- types/ConversationType.html | 2 +- types/DecodedMessageUnion.html | 2 +- types/DecryptedLocalAttachment.html | 2 +- types/EncodedContent.html | 2 +- types/EncryptedLocalAttachment.html | 2 +- types/GroupUpdatedContent.html | 2 +- types/GroupUpdatedMemberEntry.html | 2 +- types/GroupUpdatedMetadatEntry.html | 2 +- types/InboxId.html | 2 +- types/MessageId.html | 2 +- types/MessageOrder.html | 2 +- types/NativeMessageContent.html | 2 +- types/ReactionContent.html | 2 +- types/ReadReceiptContent.html | 2 +- types/RemoteAttachmentContent.html | 2 +- types/RemoteAttachmentMetadata.html | 2 +- types/ReplyContent.html | 2 +- types/StaticAttachmentContent.html | 2 +- types/UnknownContent.html | 2 +- types/WalletType.html | 2 +- types/XMTPEnvironment.html | 2 +- variables/XmtpContext.html | 2 +- variables/emitter.html | 2 +- 157 files changed, 246 insertions(+), 246 deletions(-) diff --git a/classes/Client.html b/classes/Client.html index e3cd670f..e92ce679 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 conversations @@ -29,63 +29,63 @@ dropClient exportNativeLogs getOrCreateInboxId -

Constructors

constructor

Properties

address

address: string

codecRegistry

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

Type declaration

conversations

conversations: default<ContentTypes>

dbPath

dbPath: string

inboxId

inboxId: string

installationId

installationId: InstallationId

preferences

preferences: default

Methods

addAccount

  • addAccount(newAccount): Promise<void>

  • Add this account to the current inboxId.

    +

Constructors

constructor

Properties

address

address: string

codecRegistry

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

Type declaration

conversations

conversations: default<ContentTypes>

dbPath

dbPath: string

inboxId

inboxId: string

installationId

installationId: InstallationId

preferences

preferences: default

Methods

addAccount

  • addAccount(newAccount): Promise<void>

  • Add this account to the current inboxId.

    Parameters

    • newAccount: Signer | {}

      The signer of the new account to be added.

      -

    Returns Promise<void>

canMessage

  • canMessage(addresses): Promise<{
        [key: Address]: boolean;
    }>

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

    +

Returns Promise<void>

canMessage

  • canMessage(addresses): Promise<{
        [key: Address]: boolean;
    }>

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

    This method checks if the specified peers are using clients that are on the network.

    Parameters

    • addresses: string[]

      The addresses of the peers to check for messaging eligibility.

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

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

    -

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

    -

findInboxIdFromAddress

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

  • Find the Address associated with this address

    +

findInboxIdFromAddress

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

  • Find the Address associated with this address

    Parameters

    • peerAddress: string

      The address of the peer to check for inboxId.

    Returns Promise<undefined | string>

    A Promise resolving to the InboxId.

    -

inboxState

  • inboxState(refreshFromNetwork): Promise<InboxState>

  • Make a request for your inbox state.

    +

inboxState

  • inboxState(refreshFromNetwork): Promise<InboxState>

  • Make a request for your inbox 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.

    -

inboxStates

  • inboxStates(refreshFromNetwork, inboxIds): Promise<InboxState[]>

  • Make a request for a list of inbox states.

    +

inboxStates

  • inboxStates(refreshFromNetwork, inboxIds): Promise<InboxState[]>

  • Make a request for a list of inbox states.

    Parameters

    • refreshFromNetwork: boolean

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

    • inboxIds: string[]

      The inboxIds to get the associate inbox states for.

    Returns Promise<InboxState[]>

    A Promise resolving to a list of InboxState.

    -

reconnectLocalDatabase

  • reconnectLocalDatabase(): Promise<any>

  • Reconnects the local database after being dropped.

    -

    Returns Promise<any>

register

removeAccount

  • removeAccount(wallet, addressToRemove): Promise<void>

  • Remove this account from the current inboxId.

    +

reconnectLocalDatabase

  • reconnectLocalDatabase(): Promise<any>

  • Reconnects the local database after being dropped.

    +

    Returns Promise<any>

register

removeAccount

  • removeAccount(wallet, addressToRemove): Promise<void>

  • Remove this account from the current inboxId.

    Parameters

    • wallet: Signer | {}

      The signer object used for authenticate the removal.

    • addressToRemove: string

      The address of the wallet you'd like to remove from the account.

      -

    Returns Promise<void>

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>

signWithInstallationKey

  • signWithInstallationKey(message): Promise<Uint8Array>

  • Sign this message with the current installation key.

    +

Returns Promise<void>

requestMessageHistorySync

revokeAllOtherInstallations

signWithInstallationKey

verifySignature

verifySignature

Static build

Static build

Static canMessage

Static canMessage

Static create

Static create

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class ConsentRecord

Constructors

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

Class ConsentRecord

Constructors

constructor

Properties

entryType state value

Methods

from -

Constructors

constructor

Properties

entryType

entryType: ConsentType

state

state: 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: ConsentType

state

state: 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/DecodedMessage.html b/classes/DecodedMessage.html index dc81e2e3..0d8bc414 100644 --- a/classes/DecodedMessage.html +++ b/classes/DecodedMessage.html @@ -1,4 +1,4 @@ -DecodedMessage | @xmtp/react-native-sdk

Class DecodedMessage<ContentType, ContentTypes>

Type Parameters

  • ContentType extends DefaultContentTypes[number] = DefaultContentTypes[number]

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Constructors

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

Class DecodedMessage<ContentType, ContentTypes>

Type Parameters

  • ContentType extends DefaultContentTypes[number] = DefaultContentTypes[number]

  • 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

sentNs

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

sentNs

sentNs: 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/Dm.html b/classes/Dm.html index 7a58523a..4721a65f 100644 --- a/classes/Dm.html +++ b/classes/Dm.html @@ -1,4 +1,4 @@ -Dm | @xmtp/react-native-sdk

Class Dm<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Implements

Constructors

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

Class Dm<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Implements

Constructors

constructor

Properties

client createdAt id @@ -17,29 +17,29 @@ streamMessages sync updateConsent -

Constructors

constructor

Properties

client

client: Client<ContentTypes>

createdAt

createdAt: number

id

id: ConversationId

Optional lastMessage

lastMessage?: DecodedMessageUnion<ContentTypes>

state

state: ConsentState

topic

topic: ConversationTopic

version

version: DM = ...

Methods

consentState

members

  • members(): Promise<Member[]>

  • Returns Promise<Member[]>

    A Promise that resolves to an array of Member objects. +

Constructors

constructor

Properties

client

client: Client<ContentTypes>

createdAt

createdAt: number

id

id: ConversationId

Optional lastMessage

lastMessage?: DecodedMessageUnion<ContentTypes>

state

state: ConsentState

topic

topic: ConversationTopic

version

version: DM = ...

Methods

consentState

members

  • members(): 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<DecodedMessageUnion<ContentTypes>[]>

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

    Parameters

    • Optional opts: MessagesOptions

    Returns Promise<DecodedMessageUnion<ContentTypes>[]>

    A Promise that resolves to an array of DecodedMessage objects.

    -

peerInboxId

  • peerInboxId(): Promise<string>

  • This method return the peer inbox id associated with the dm.

    +

peerInboxId

  • peerInboxId(): Promise<string>

  • This method return the peer inbox id associated with the dm.

    Returns Promise<string>

    A Promise that resolves to a InboxId.

    -

prepareMessage

prepareMessage

  • prepareMessage<SendContentTypes>(content): Promise<string>

  • Prepare a dm 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.

    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

    -

send

send

  • send<SendContentTypes>(content): Promise<MessageId>

  • Sends a message to the current dm.

    Type Parameters

    Parameters

    • content: ConversationSendPayload<SendContentTypes>

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

    Returns Promise<MessageId>

    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.

    -

streamMessages

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

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

    +

streamMessages

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

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

    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.

    -

sync

  • sync(): Promise<void>

  • Executes a network request to fetch the latest messages and membership changes +

sync

  • sync(): Promise<void>

  • Executes a network request to fetch the latest messages and membership changes associated with the dm and saves them to the local state.

    -

    Returns Promise<void>

updateConsent

  • updateConsent(state): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

updateConsent

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 78d4b008..a477dfdc 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: string

client

client: Client<ContentTypes>

createdAt

createdAt: number

description

description: string

id

id: ConversationId

imageUrlSquare

imageUrlSquare: string

isGroupActive

isGroupActive: boolean

Optional lastMessage

lastMessage?: DecodedMessageUnion<ContentTypes>

name

name: string

state

state: ConsentState

topic

topic: ConversationTopic

version

version: GROUP = ...

Methods

addAdmin

  • addAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

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

Constructors

constructor

Properties

addedByInboxId

addedByInboxId: string

client

client: Client<ContentTypes>

createdAt

createdAt: number

description

description: string

id

id: ConversationId

imageUrlSquare

imageUrlSquare: string

isGroupActive

isGroupActive: boolean

Optional lastMessage

lastMessage?: DecodedMessageUnion<ContentTypes>

name

name: string

state

state: ConsentState

topic

topic: ConversationTopic

version

version: GROUP = ...

Methods

addAdmin

  • addAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    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: string[]

      inboxIds to add to the group

      -

    Returns Promise<void>

addSuperAdmin

  • addSuperAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    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: string[]

      inboxIds to add to the group

      +

    Returns Promise<void>

addSuperAdmin

  • addSuperAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    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

creatorInboxId

  • creatorInboxId(): Promise<string>

  • This method returns a inbox id associated with the creator of the group.

    +

consentState

creatorInboxId

  • creatorInboxId(): Promise<string>

  • This method returns a inbox id associated with the creator of the group.

    Returns Promise<string>

    A Promise that resolves to a InboxId.

    -

groupDescription

  • groupDescription(): Promise<string>

  • Returns the group description. +

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 image url.

    -

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

    • inboxId: string

    Returns Promise<boolean>

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

isAdmin

  • isAdmin(inboxId): Promise<boolean>

  • Parameters

    • inboxId: string

    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.

    -

isSuperAdmin

  • isSuperAdmin(inboxId): Promise<boolean>

  • Parameters

    • inboxId: string

    Returns Promise<boolean>

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

isSuperAdmin

  • isSuperAdmin(inboxId): Promise<boolean>

  • Parameters

    • inboxId: string

    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(): Promise<string[]>

  • Returns Promise<string[]>

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

listAdmins

  • listAdmins(): Promise<string[]>

  • Returns Promise<string[]>

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

  • Returns Promise<string[]>

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

listSuperAdmins

  • listSuperAdmins(): Promise<string[]>

  • Returns Promise<string[]>

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

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

memberInboxIds

  • memberInboxIds(): Promise<string[]>

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

    A Promise that resolves to an array of InboxId objects.

    -

members

members

  • members(): 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<DecodedMessageUnion<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<DecodedMessageUnion<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): 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.

    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

    • inboxId: string

    Returns Promise<void>

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

removeAdmin

  • removeAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

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

    -

removeMembers

  • removeMembers(addresses): Promise<void>

  • Parameters

    • addresses: string[]

      addresses to remove from the group

      -

    Returns Promise<void>

removeMembersByInboxId

  • removeMembersByInboxId(inboxIds): Promise<void>

  • Parameters

    • inboxIds: string[]

      inboxIds to remove from the group

      -

    Returns Promise<void>

removeSuperAdmin

  • removeSuperAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

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

removeMembers

  • removeMembers(addresses): Promise<void>

  • Parameters

    • addresses: string[]

      addresses to remove from the group

      +

    Returns Promise<void>

removeMembersByInboxId

  • removeMembersByInboxId(inboxIds): Promise<void>

  • Parameters

    • inboxIds: string[]

      inboxIds to remove from the group

      +

    Returns Promise<void>

removeSuperAdmin

  • removeSuperAdmin(inboxId): Promise<void>

  • Parameters

    • inboxId: string

    Returns Promise<void>

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

    -

send

send

  • send<SendContentTypes>(content): Promise<MessageId>

  • Sends a message to the current group.

    Type Parameters

    Parameters

    • content: ConversationSendPayload<SendContentTypes>

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

    Returns Promise<MessageId>

    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.

    -

streamMessages

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

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

    +

streamMessages

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

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

    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.

    -

sync

  • sync(): Promise<void>

  • Executes a network request to fetch the latest messages and membership changes +

sync

  • sync(): Promise<void>

  • Executes a network request to fetch the latest messages and membership changes associated with the group and saves them to the local state.

    -

    Returns Promise<void>

updateAddAdminPermission

  • updateAddAdminPermission(permissionOption): Promise<void>

  • Parameters

    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

    A Promise that resolves when the addAdmin permission is updated for the group. +

Returns Promise<void>

updateAddAdminPermission

updateAddMemberPermission

updateAddMemberPermission

updateConsent

updateGroupDescription

updateConsent

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 9c1beec8..9910387c 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 ec2daaad..9fee623a 100644 --- a/classes/Member.html +++ b/classes/Member.html @@ -1,7 +1,7 @@ -Member | @xmtp/react-native-sdk

Class Member

Constructors

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

Class Member

Constructors

constructor

Properties

addresses consentState inboxId permissionLevel

Methods

from -

Constructors

constructor

Properties

addresses

addresses: string[]

consentState

consentState: ConsentState

inboxId

inboxId: string

permissionLevel

permissionLevel: PermissionLevel

Methods

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

addresses

addresses: string[]

consentState

consentState: ConsentState

inboxId

inboxId: string

permissionLevel

permissionLevel: PermissionLevel

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 2af3b1cb..f8032fda 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 717c91f9..ab8e0cd2 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 67bb1fd7..314665e7 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 49789b2c..e9c6ad14 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 ed91f3de..d49db9a7 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 e51818a9..e2aee97e 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 425fd971..c8f36631 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 ae5b341e..d7d978cf 100644 --- a/enums/ConversationVersion.html +++ b/enums/ConversationVersion.html @@ -1,3 +1,3 @@ -ConversationVersion | @xmtp/react-native-sdk

Enumeration ConversationVersion

Enumeration Members

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

Enumeration ConversationVersion

Enumeration Members

DM GROUP -

Enumeration Members

DM

DM: "DM"

GROUP

GROUP: "GROUP"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DM

DM: "DM"

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 74022942..4fdf55cf 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 5f21b88f..51383644 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/addAccount.html b/functions/addAccount.html index 11b3883a..67837812 100644 --- a/functions/addAccount.html +++ b/functions/addAccount.html @@ -1 +1 @@ -addAccount | @xmtp/react-native-sdk

Function addAccount

  • addAccount(installationId, newAddress, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • newAddress: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addAccount

  • addAccount(installationId, newAddress, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • newAddress: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addAdmin

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addAdmin

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

  • Parameters

    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 baba1b68..9582cc4c 100644 --- a/functions/addGroupMembers.html +++ b/functions/addGroupMembers.html @@ -1 +1 @@ -addGroupMembers | @xmtp/react-native-sdk

Function addGroupMembers

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addGroupMembers

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

  • Parameters

    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 62986343..a07b11fd 100644 --- a/functions/addGroupMembersByInboxId.html +++ b/functions/addGroupMembersByInboxId.html @@ -1 +1 @@ -addGroupMembersByInboxId | @xmtp/react-native-sdk

Function addGroupMembersByInboxId

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addGroupMembersByInboxId

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

  • Parameters

    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 6cf2afa4..6338eb07 100644 --- a/functions/addSuperAdmin.html +++ b/functions/addSuperAdmin.html @@ -1 +1 @@ -addSuperAdmin | @xmtp/react-native-sdk

Function addSuperAdmin

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function addSuperAdmin

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

  • Parameters

    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 55e5a375..92f6fef6 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-1.html b/functions/address-1.html index fea0d80a..a78426b6 100644 --- a/functions/address-1.html +++ b/functions/address-1.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/build.html b/functions/build.html index 03555e31..acb1aebe 100644 --- a/functions/build.html +++ b/functions/build.html @@ -1 +1 @@ -build | @xmtp/react-native-sdk

Function build

  • build(address, environment, dbEncryptionKey, appVersion?, dbDirectory?, historySyncUrl?, inboxId?): Promise<string>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • dbEncryptionKey: Uint8Array
    • Optional appVersion: string
    • Optional dbDirectory: string
    • Optional historySyncUrl: string
    • Optional inboxId: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function build

  • build(address, environment, dbEncryptionKey, appVersion?, dbDirectory?, historySyncUrl?, inboxId?): Promise<string>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • dbEncryptionKey: Uint8Array
    • Optional appVersion: string
    • Optional dbDirectory: string
    • Optional historySyncUrl: string
    • Optional inboxId: string

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function canMessage

  • canMessage(installationId, peerAddresses): Promise<{
        [key: Address]: boolean;
    }>

  • Parameters

    • installationId: InstallationId
    • peerAddresses: string[]

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function canMessage

  • canMessage(installationId, peerAddresses): Promise<{
        [key: Address]: boolean;
    }>

  • Parameters

    • installationId: InstallationId
    • peerAddresses: string[]

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function consentAddressState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function consentAddressState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function consentConversationIdState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function consentConversationIdState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/consentInboxIdState.html b/functions/consentInboxIdState.html index 471b9dc4..dc64f5c0 100644 --- a/functions/consentInboxIdState.html +++ b/functions/consentInboxIdState.html @@ -1 +1 @@ -consentInboxIdState | @xmtp/react-native-sdk

Function consentInboxIdState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function consentInboxIdState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/conversationConsentState.html b/functions/conversationConsentState.html index a11e7ff8..28f7d5fa 100644 --- a/functions/conversationConsentState.html +++ b/functions/conversationConsentState.html @@ -1 +1 @@ -conversationConsentState | @xmtp/react-native-sdk

Function conversationConsentState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function conversationConsentState

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function conversationMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function conversationMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/convertWalletClientToSigner.html b/functions/convertWalletClientToSigner.html index 4a3b3048..f41d6cf2 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/create.html b/functions/create.html index 3a26d7a8..420d9ec1 100644 --- a/functions/create.html +++ b/functions/create.html @@ -1 +1 @@ -create | @xmtp/react-native-sdk

Function create

  • create(address, environment, dbEncryptionKey, appVersion?, hasPreAuthenticateToInboxCallback?, dbDirectory?, historySyncUrl?, walletType?, chainId?, blockNumber?): Promise<string>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • dbEncryptionKey: Uint8Array
    • Optional appVersion: string
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional dbDirectory: string
    • Optional historySyncUrl: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function create

  • create(address, environment, dbEncryptionKey, appVersion?, hasPreAuthenticateToInboxCallback?, dbDirectory?, historySyncUrl?, walletType?, chainId?, blockNumber?): Promise<string>

  • Parameters

    • address: string
    • environment: "local" | "dev" | "production"
    • dbEncryptionKey: Uint8Array
    • Optional appVersion: string
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • Optional dbDirectory: string
    • Optional historySyncUrl: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    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 60d81b3f..41632fbc 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 5f1f4bd9..31b01289 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 4cede6d2..58171cf4 100644 --- a/functions/createRandom.html +++ b/functions/createRandom.html @@ -1 +1 @@ -createRandom | @xmtp/react-native-sdk

Function createRandom

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

  • Parameters

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

  • Parameters

    • environment: "local" | "dev" | "production"
    • dbEncryptionKey: Uint8Array
    • Optional appVersion: string
    • Optional hasPreAuthenticateToInboxCallback: boolean
    • 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 c85b8941..80dc48f5 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/decryptAttachment.html b/functions/decryptAttachment.html index 864031cc..8122dff2 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 02bafd49..f8910c1a 100644 --- a/functions/deleteLocalDatabase.html +++ b/functions/deleteLocalDatabase.html @@ -1 +1 @@ -deleteLocalDatabase | @xmtp/react-native-sdk

Function deleteLocalDatabase

  • deleteLocalDatabase(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function deleteLocalDatabase

  • deleteLocalDatabase(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/dmPeerInboxId.html b/functions/dmPeerInboxId.html index 9ec25bfc..7c20d1d9 100644 --- a/functions/dmPeerInboxId.html +++ b/functions/dmPeerInboxId.html @@ -1 +1 @@ -dmPeerInboxId | @xmtp/react-native-sdk

Function dmPeerInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function dmPeerInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/dropClient.html b/functions/dropClient.html index 055739b7..99c194e5 100644 --- a/functions/dropClient.html +++ b/functions/dropClient.html @@ -1 +1 @@ -dropClient | @xmtp/react-native-sdk

Function dropClient

  • dropClient(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function dropClient

  • dropClient(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    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 1a6f73bd..635b0b4e 100644 --- a/functions/dropLocalDatabaseConnection.html +++ b/functions/dropLocalDatabaseConnection.html @@ -1 +1 @@ -dropLocalDatabaseConnection | @xmtp/react-native-sdk

Function dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function dropLocalDatabaseConnection

  • dropLocalDatabaseConnection(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    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 9e0b124f..43cd916c 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/exportNativeLogs.html b/functions/exportNativeLogs.html index 01e731f9..bc4e3d94 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/findConversation.html b/functions/findConversation.html index 775b8551..13b882af 100644 --- a/functions/findConversation.html +++ b/functions/findConversation.html @@ -1 +1 @@ -findConversation | @xmtp/react-native-sdk

Function findConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findConversationByTopic

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findConversationByTopic

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findDmByAddress

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findDmByAddress

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findDmByInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findDmByInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/findGroup.html b/functions/findGroup.html index a393aaa0..4dd98f44 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 f44c01c1..9b491a73 100644 --- a/functions/findInboxIdFromAddress.html +++ b/functions/findInboxIdFromAddress.html @@ -1 +1 @@ -findInboxIdFromAddress | @xmtp/react-native-sdk

Function findInboxIdFromAddress

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

  • Parameters

    • installationId: InstallationId
    • 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(installationId, address): Promise<InboxId | undefined>

  • Parameters

    • installationId: InstallationId
    • address: string

    Returns Promise<InboxId | undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/findMessage.html b/functions/findMessage.html index 69600a97..31ef6461 100644 --- a/functions/findMessage.html +++ b/functions/findMessage.html @@ -1 +1 @@ -findMessage | @xmtp/react-native-sdk

Function findMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/findOrCreateDm.html b/functions/findOrCreateDm.html index 982b59c4..6d12ecc0 100644 --- a/functions/findOrCreateDm.html +++ b/functions/findOrCreateDm.html @@ -1 +1 @@ -findOrCreateDm | @xmtp/react-native-sdk

Function findOrCreateDm

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function findOrCreateDm

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getInboxState.html b/functions/getInboxState.html index 5edbd0a5..19a1da92 100644 --- a/functions/getInboxState.html +++ b/functions/getInboxState.html @@ -1 +1 @@ -getInboxState | @xmtp/react-native-sdk

Function getInboxState

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

  • Parameters

    • installationId: InstallationId
    • 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(installationId, refreshFromNetwork): Promise<InboxState>

  • Parameters

    • installationId: InstallationId
    • refreshFromNetwork: boolean

    Returns Promise<InboxState>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getInboxStates

  • getInboxStates(installationId, refreshFromNetwork, inboxIds): Promise<InboxState[]>

  • Parameters

    • installationId: InstallationId
    • refreshFromNetwork: boolean
    • inboxIds: string[]

    Returns Promise<InboxState[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getInboxStates

  • getInboxStates(installationId, refreshFromNetwork, inboxIds): Promise<InboxState[]>

  • Parameters

    • installationId: InstallationId
    • refreshFromNetwork: boolean
    • inboxIds: string[]

    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 26cfc3e1..b7b9a3c5 100644 --- a/functions/getOrCreateInboxId.html +++ b/functions/getOrCreateInboxId.html @@ -1 +1 @@ -getOrCreateInboxId | @xmtp/react-native-sdk

Function getOrCreateInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function getOrCreateInboxId

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getSigner.html b/functions/getSigner.html index 4d45f101..495ff46a 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/groupDescription.html b/functions/groupDescription.html index 1edaf96b..bcc9bf56 100644 --- a/functions/groupDescription.html +++ b/functions/groupDescription.html @@ -1 +1 @@ -groupDescription | @xmtp/react-native-sdk

Function groupDescription

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

  • Parameters

    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(installationId, id): string | PromiseLike<string>

  • Parameters

    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 50e1aa3f..1e1f3f64 100644 --- a/functions/groupImageUrlSquare.html +++ b/functions/groupImageUrlSquare.html @@ -1 +1 @@ -groupImageUrlSquare | @xmtp/react-native-sdk

Function groupImageUrlSquare

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

  • Parameters

    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(installationId, id): string | PromiseLike<string>

  • Parameters

    Returns string | PromiseLike<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/groupName.html b/functions/groupName.html index 89c77e7a..26164aa2 100644 --- a/functions/groupName.html +++ b/functions/groupName.html @@ -1 +1 @@ -groupName | @xmtp/react-native-sdk

Function groupName

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

  • Parameters

    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(installationId, id): string | PromiseLike<string>

  • Parameters

    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 ba266820..6ea8a2bf 100644 --- a/functions/groupPinnedFrameUrl.html +++ b/functions/groupPinnedFrameUrl.html @@ -1 +1 @@ -groupPinnedFrameUrl | @xmtp/react-native-sdk

Function groupPinnedFrameUrl

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

  • Parameters

    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(installationId, id): string | PromiseLike<string>

  • Parameters

    Returns string | PromiseLike<string>

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 106728a2..e9b1375d 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 c40323a3..73197ef9 100644 --- a/functions/isAdmin.html +++ b/functions/isAdmin.html @@ -1 +1 @@ -isAdmin | @xmtp/react-native-sdk

Function isAdmin

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

  • Parameters

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isAdmin

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

  • Parameters

    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 c545e454..7b89a436 100644 --- a/functions/isGroupActive.html +++ b/functions/isGroupActive.html @@ -1 +1 @@ -isGroupActive | @xmtp/react-native-sdk

Function isGroupActive

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

  • Parameters

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isGroupActive

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

  • Parameters

    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 7e7ed6d2..95f3bcbe 100644 --- a/functions/isSuperAdmin.html +++ b/functions/isSuperAdmin.html @@ -1 +1 @@ -isSuperAdmin | @xmtp/react-native-sdk

Function isSuperAdmin

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

  • Parameters

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isSuperAdmin

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

  • Parameters

    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 4f964572..cc7d3480 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/listConversationMembers.html b/functions/listConversationMembers.html index 26ad8818..07d8a036 100644 --- a/functions/listConversationMembers.html +++ b/functions/listConversationMembers.html @@ -1 +1 @@ -listConversationMembers | @xmtp/react-native-sdk

Function listConversationMembers

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listConversationMembers

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listConversations.html b/functions/listConversations.html index 79def52d..85b03dba 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/listDms.html b/functions/listDms.html index 244f306a..bad8587f 100644 --- a/functions/listDms.html +++ b/functions/listDms.html @@ -1 +1 @@ -listDms | @xmtp/react-native-sdk

Function listDms

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function listDms

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/listGroups.html b/functions/listGroups.html index eac83b3d..beb9d504 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 fa54eb45..cacdd7e9 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/listSuperAdmins.html b/functions/listSuperAdmins.html index 33d5399a..1f560a3f 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 fdce8e72..326fb402 100644 --- a/functions/permissionPolicySet.html +++ b/functions/permissionPolicySet.html @@ -1 +1 @@ -permissionPolicySet | @xmtp/react-native-sdk

Function permissionPolicySet

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

  • Parameters

    Returns Promise<PermissionPolicySet>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function permissionPolicySet

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

  • Parameters

    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 b91c5f4c..56e49131 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/prepareMessage.html b/functions/prepareMessage.html index e6d78875..1352ad5c 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/processMessage.html b/functions/processMessage.html index 7521e0d3..4aedb253 100644 --- a/functions/processMessage.html +++ b/functions/processMessage.html @@ -1 +1 @@ -processMessage | @xmtp/react-native-sdk

Function processMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function processMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/processWelcomeMessage.html b/functions/processWelcomeMessage.html index 0837e7e2..f05f8adc 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/publishPreparedMessages.html b/functions/publishPreparedMessages.html index 6f2e3a39..c2110ea5 100644 --- a/functions/publishPreparedMessages.html +++ b/functions/publishPreparedMessages.html @@ -1 +1 @@ -publishPreparedMessages | @xmtp/react-native-sdk

Function publishPreparedMessages

  • publishPreparedMessages(installationId, conversationId): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function publishPreparedMessages

  • publishPreparedMessages(installationId, conversationId): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/receiveSCWSignature.html b/functions/receiveSCWSignature.html index 771f57a2..f7b81eeb 100644 --- a/functions/receiveSCWSignature.html +++ b/functions/receiveSCWSignature.html @@ -1 +1 @@ -receiveSCWSignature | @xmtp/react-native-sdk

Function receiveSCWSignature

  • receiveSCWSignature(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 +receiveSCWSignature | @xmtp/react-native-sdk

Function receiveSCWSignature

  • receiveSCWSignature(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/receiveSignature.html b/functions/receiveSignature.html index 956c8c10..1ac102c9 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 67780c15..6e21c832 100644 --- a/functions/reconnectLocalDatabase.html +++ b/functions/reconnectLocalDatabase.html @@ -1 +1 @@ -reconnectLocalDatabase | @xmtp/react-native-sdk

Function reconnectLocalDatabase

  • reconnectLocalDatabase(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function reconnectLocalDatabase

  • reconnectLocalDatabase(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/registerPushToken.html b/functions/registerPushToken.html index 86e9a5a8..0e37cb5b 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/removeAccount.html b/functions/removeAccount.html index ed7b939a..39fa5039 100644 --- a/functions/removeAccount.html +++ b/functions/removeAccount.html @@ -1 +1 @@ -removeAccount | @xmtp/react-native-sdk

Function removeAccount

  • removeAccount(installationId, addressToRemove, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • addressToRemove: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeAccount

  • removeAccount(installationId, addressToRemove, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • addressToRemove: string
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<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 b0f7117e..d81f5661 100644 --- a/functions/removeAdmin.html +++ b/functions/removeAdmin.html @@ -1 +1 @@ -removeAdmin | @xmtp/react-native-sdk

Function removeAdmin

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeAdmin

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

  • Parameters

    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 db4fe9c8..41886c1d 100644 --- a/functions/removeGroupMembers.html +++ b/functions/removeGroupMembers.html @@ -1 +1 @@ -removeGroupMembers | @xmtp/react-native-sdk

Function removeGroupMembers

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeGroupMembers

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

  • Parameters

    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 007abf6e..772d0748 100644 --- a/functions/removeGroupMembersByInboxId.html +++ b/functions/removeGroupMembersByInboxId.html @@ -1 +1 @@ -removeGroupMembersByInboxId | @xmtp/react-native-sdk

Function removeGroupMembersByInboxId

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeGroupMembersByInboxId

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

  • Parameters

    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 24af3ae2..5deddd4c 100644 --- a/functions/removeSuperAdmin.html +++ b/functions/removeSuperAdmin.html @@ -1 +1 @@ -removeSuperAdmin | @xmtp/react-native-sdk

Function removeSuperAdmin

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function removeSuperAdmin

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

  • Parameters

    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 0afbcaea..cad9ef2d 100644 --- a/functions/requestMessageHistorySync.html +++ b/functions/requestMessageHistorySync.html @@ -1 +1 @@ -requestMessageHistorySync | @xmtp/react-native-sdk

Function requestMessageHistorySync

  • requestMessageHistorySync(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function requestMessageHistorySync

  • requestMessageHistorySync(installationId): Promise<any>

  • Parameters

    • installationId: InstallationId

    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 aae50f41..39d60c5e 100644 --- a/functions/revokeAllOtherInstallations.html +++ b/functions/revokeAllOtherInstallations.html @@ -1 +1 @@ -revokeAllOtherInstallations | @xmtp/react-native-sdk

Function revokeAllOtherInstallations

  • revokeAllOtherInstallations(installationId, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function revokeAllOtherInstallations

  • revokeAllOtherInstallations(installationId, walletType?, chainId?, blockNumber?): Promise<any>

  • Parameters

    • installationId: InstallationId
    • Optional walletType: WalletType
    • Optional chainId: number
    • Optional blockNumber: number

    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 0c795f08..73646d78 100644 --- a/functions/sendMessage.html +++ b/functions/sendMessage.html @@ -1 +1 @@ -sendMessage | @xmtp/react-native-sdk

Function sendMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function sendMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/setConsentState.html b/functions/setConsentState.html index 11960a50..2c9b87a5 100644 --- a/functions/setConsentState.html +++ b/functions/setConsentState.html @@ -1 +1 @@ -setConsentState | @xmtp/react-native-sdk

Function setConsentState

  • setConsentState(installationId, value, entryType, consentType): Promise<void>

  • Parameters

    • installationId: InstallationId
    • value: string
    • entryType: ConsentType
    • consentType: ConsentState

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function setConsentState

  • setConsentState(installationId, value, entryType, consentType): Promise<void>

  • Parameters

    • installationId: InstallationId
    • value: string
    • entryType: ConsentType
    • consentType: ConsentState

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function signWithInstallationKey

  • signWithInstallationKey(installationId, message): Promise<Uint8Array>

  • Parameters

    • installationId: InstallationId
    • message: string

    Returns Promise<Uint8Array>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function signWithInstallationKey

  • signWithInstallationKey(installationId, message): Promise<Uint8Array>

  • Parameters

    • installationId: InstallationId
    • message: string

    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 61c0a8ba..0db01e48 100644 --- a/functions/staticCanMessage.html +++ b/functions/staticCanMessage.html @@ -1 +1 @@ -staticCanMessage | @xmtp/react-native-sdk

Function staticCanMessage

  • staticCanMessage(environment, peerAddresses): Promise<{
        [key: Address]: boolean;
    }>

  • Parameters

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

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function staticCanMessage

  • staticCanMessage(environment, peerAddresses): Promise<{
        [key: Address]: boolean;
    }>

  • Parameters

    Returns Promise<{
        [key: Address]: 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 117f2d7d..4a64670a 100644 --- a/functions/subscribePushTopics.html +++ b/functions/subscribePushTopics.html @@ -1 +1 @@ -subscribePushTopics | @xmtp/react-native-sdk

Function subscribePushTopics

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribePushTopics

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToAllMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToAllMessages

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToConsent

  • subscribeToConsent(installationId): any

  • Parameters

    • installationId: InstallationId

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToConsent

  • subscribeToConsent(installationId): any

  • Parameters

    • installationId: InstallationId

    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 c5d608da..9ae0daca 100644 --- a/functions/subscribeToConversations.html +++ b/functions/subscribeToConversations.html @@ -1 +1 @@ -subscribeToConversations | @xmtp/react-native-sdk

Function subscribeToConversations

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToConversations

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToMessages

  • subscribeToMessages(installationId, id): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function subscribeToMessages

  • subscribeToMessages(installationId, id): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncAllConversations.html b/functions/syncAllConversations.html index 967d9348..d5cec065 100644 --- a/functions/syncAllConversations.html +++ b/functions/syncAllConversations.html @@ -1 +1 @@ -syncAllConversations | @xmtp/react-native-sdk

Function syncAllConversations

  • syncAllConversations(installationId): Promise<number>

  • Parameters

    • installationId: InstallationId

    Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncAllConversations

  • syncAllConversations(installationId): Promise<number>

  • Parameters

    • installationId: InstallationId

    Returns Promise<number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncConsent

  • syncConsent(installationId): Promise<void>

  • Parameters

    • installationId: InstallationId

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncConsent

  • syncConsent(installationId): Promise<void>

  • Parameters

    • installationId: InstallationId

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncConversation.html b/functions/syncConversation.html index 691d78d9..757f02ea 100644 --- a/functions/syncConversation.html +++ b/functions/syncConversation.html @@ -1 +1 @@ -syncConversation | @xmtp/react-native-sdk

Function syncConversation

  • syncConversation(installationId, id): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncConversation

  • syncConversation(installationId, id): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/syncConversations.html b/functions/syncConversations.html index a9468736..26546e79 100644 --- a/functions/syncConversations.html +++ b/functions/syncConversations.html @@ -1 +1 @@ -syncConversations | @xmtp/react-native-sdk

Function syncConversations

  • syncConversations(installationId): Promise<void>

  • Parameters

    • installationId: InstallationId

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function syncConversations

  • syncConversations(installationId): Promise<void>

  • Parameters

    • installationId: InstallationId

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(installationId): any

  • Parameters

    • installationId: InstallationId

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromAllMessages

  • unsubscribeFromAllMessages(installationId): any

  • Parameters

    • installationId: InstallationId

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/unsubscribeFromConsent.html b/functions/unsubscribeFromConsent.html index 5b73037f..14aa214f 100644 --- a/functions/unsubscribeFromConsent.html +++ b/functions/unsubscribeFromConsent.html @@ -1 +1 @@ -unsubscribeFromConsent | @xmtp/react-native-sdk

Function unsubscribeFromConsent

  • unsubscribeFromConsent(installationId): any

  • Parameters

    • installationId: InstallationId

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromConsent

  • unsubscribeFromConsent(installationId): any

  • Parameters

    • installationId: InstallationId

    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 6fc398e2..0d88f155 100644 --- a/functions/unsubscribeFromConversations.html +++ b/functions/unsubscribeFromConversations.html @@ -1 +1 @@ -unsubscribeFromConversations | @xmtp/react-native-sdk

Function unsubscribeFromConversations

  • unsubscribeFromConversations(installationId): any

  • Parameters

    • installationId: InstallationId

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromConversations

  • unsubscribeFromConversations(installationId): any

  • Parameters

    • installationId: InstallationId

    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 d2336cf6..0ca8293d 100644 --- a/functions/unsubscribeFromMessages.html +++ b/functions/unsubscribeFromMessages.html @@ -1 +1 @@ -unsubscribeFromMessages | @xmtp/react-native-sdk

Function unsubscribeFromMessages

  • unsubscribeFromMessages(installationId, id): Promise<any>

  • Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function unsubscribeFromMessages

  • unsubscribeFromMessages(installationId, id): Promise<any>

  • Parameters

    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 af43f367..b3f7df9f 100644 --- a/functions/updateAddAdminPermission.html +++ b/functions/updateAddAdminPermission.html @@ -1 +1 @@ -updateAddAdminPermission | @xmtp/react-native-sdk

Function updateAddAdminPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 ce359d89..68fffdd9 100644 --- a/functions/updateAddMemberPermission.html +++ b/functions/updateAddMemberPermission.html @@ -1 +1 @@ -updateAddMemberPermission | @xmtp/react-native-sdk

Function updateAddMemberPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • permissionOption: PermissionUpdateOption

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateConversationConsent.html b/functions/updateConversationConsent.html index fd86da7d..777a28f3 100644 --- a/functions/updateConversationConsent.html +++ b/functions/updateConversationConsent.html @@ -1 +1 @@ -updateConversationConsent | @xmtp/react-native-sdk

Function updateConversationConsent

  • updateConversationConsent(installationId, conversationId, state): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateConversationConsent

  • updateConversationConsent(installationId, conversationId, state): Promise<void>

  • Parameters

    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 196082fa..49b83456 100644 --- a/functions/updateGroupDescription.html +++ b/functions/updateGroupDescription.html @@ -1 +1 @@ -updateGroupDescription | @xmtp/react-native-sdk

Function updateGroupDescription

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupDescription

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

  • Parameters

    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 404e5fcb..11301f6f 100644 --- a/functions/updateGroupDescriptionPermission.html +++ b/functions/updateGroupDescriptionPermission.html @@ -1 +1 @@ -updateGroupDescriptionPermission | @xmtp/react-native-sdk

Function updateGroupDescriptionPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 30a58df0..a9f5d114 100644 --- a/functions/updateGroupImageUrlSquare.html +++ b/functions/updateGroupImageUrlSquare.html @@ -1 +1 @@ -updateGroupImageUrlSquare | @xmtp/react-native-sdk

Function updateGroupImageUrlSquare

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

  • Parameters

    • installationId: InstallationId
    • id: ConversationId
    • 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(installationId, id, imageUrlSquare): Promise<void>

  • Parameters

    • installationId: InstallationId
    • id: ConversationId
    • 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 bd797c3a..3c0c1475 100644 --- a/functions/updateGroupImageUrlSquarePermission.html +++ b/functions/updateGroupImageUrlSquarePermission.html @@ -1 +1 @@ -updateGroupImageUrlSquarePermission | @xmtp/react-native-sdk

Function updateGroupImageUrlSquarePermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 a4536f57..853f1fb4 100644 --- a/functions/updateGroupName.html +++ b/functions/updateGroupName.html @@ -1 +1 @@ -updateGroupName | @xmtp/react-native-sdk

Function updateGroupName

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

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function updateGroupName

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

  • Parameters

    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 d58d8b3f..915469c8 100644 --- a/functions/updateGroupNamePermission.html +++ b/functions/updateGroupNamePermission.html @@ -1 +1 @@ -updateGroupNamePermission | @xmtp/react-native-sdk

Function updateGroupNamePermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 222c3e69..b0877dea 100644 --- a/functions/updateGroupPinnedFrameUrl.html +++ b/functions/updateGroupPinnedFrameUrl.html @@ -1 +1 @@ -updateGroupPinnedFrameUrl | @xmtp/react-native-sdk

Function updateGroupPinnedFrameUrl

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

  • Parameters

    • installationId: InstallationId
    • id: ConversationId
    • 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(installationId, id, pinnedFrameUrl): Promise<void>

  • Parameters

    • installationId: InstallationId
    • id: ConversationId
    • 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 8b6b1026..a91b6cba 100644 --- a/functions/updateGroupPinnedFrameUrlPermission.html +++ b/functions/updateGroupPinnedFrameUrlPermission.html @@ -1 +1 @@ -updateGroupPinnedFrameUrlPermission | @xmtp/react-native-sdk

Function updateGroupPinnedFrameUrlPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 0e07fc92..1bc716d6 100644 --- a/functions/updateRemoveAdminPermission.html +++ b/functions/updateRemoveAdminPermission.html @@ -1 +1 @@ -updateRemoveAdminPermission | @xmtp/react-native-sdk

Function updateRemoveAdminPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 8d5d75a3..eb438d62 100644 --- a/functions/updateRemoveMemberPermission.html +++ b/functions/updateRemoveMemberPermission.html @@ -1 +1 @@ -updateRemoveMemberPermission | @xmtp/react-native-sdk

Function updateRemoveMemberPermission

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

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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(clientInstallationId, id, permissionOption): Promise<void>

  • Parameters

    • clientInstallationId: InstallationId
    • id: ConversationId
    • 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 458d2cf3..95529ea4 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 ad372fe5..f424b239 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/functions/verifySignature.html b/functions/verifySignature.html index 1b31505c..775f8dc7 100644 --- a/functions/verifySignature.html +++ b/functions/verifySignature.html @@ -1 +1 @@ -verifySignature | @xmtp/react-native-sdk

Function verifySignature

  • verifySignature(installationId, message, signature): Promise<boolean>

  • Parameters

    • installationId: InstallationId
    • message: string
    • signature: Uint8Array

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function verifySignature

  • verifySignature(installationId, message, signature): Promise<boolean>

  • Parameters

    • installationId: InstallationId
    • message: string
    • signature: Uint8Array

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html index 2d981b03..c48423da 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 cf9116cb..443b098d 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 da3963f1..d97b1c5d 100644 --- a/interfaces/Signer.html +++ b/interfaces/Signer.html @@ -1,6 +1,6 @@ -Signer | @xmtp/react-native-sdk

Interface Signer

interface Signer {
    getAddress: (() => Promise<string>);
    getBlockNumber: (() => undefined | number);
    getChainId: (() => undefined | number);
    signMessage: ((message) => Promise<string>);
    walletType: (() => undefined | WalletType);
}

Properties

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

Interface Signer

interface Signer {
    getAddress: (() => Promise<string>);
    getBlockNumber: (() => undefined | number);
    getChainId: (() => undefined | number);
    signMessage: ((message) => Promise<string>);
    walletType: (() => undefined | WalletType);
}

Properties

getAddress getBlockNumber getChainId signMessage walletType -

Properties

getAddress

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

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

getBlockNumber

getBlockNumber: (() => undefined | number)

Type declaration

    • (): undefined | number

    • Returns undefined | number

getChainId

getChainId: (() => undefined | number)

Type declaration

    • (): undefined | number

    • Returns undefined | number

signMessage

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

Type declaration

    • (message): Promise<string>

    • Parameters

      • message: string

      Returns Promise<string>

walletType

walletType: (() => undefined | WalletType)

Type declaration

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>

getBlockNumber

getBlockNumber: (() => undefined | number)

Type declaration

    • (): undefined | number

    • Returns undefined | number

getChainId

getChainId: (() => undefined | number)

Type declaration

    • (): undefined | number

    • Returns undefined | number

signMessage

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

Type declaration

    • (message): Promise<string>

    • Parameters

      • message: string

      Returns Promise<string>

walletType

walletType: (() => undefined | WalletType)

Type declaration

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 5cf7eb34..efa9dfbb 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/Address.html b/types/Address.html index 1efb8ddd..9fab5795 100644 --- a/types/Address.html +++ b/types/Address.html @@ -1 +1 @@ -Address | @xmtp/react-native-sdk

Type alias Address

Address: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias Address

Address: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ConsentState.html b/types/ConsentState.html index 779fa33e..0853d501 100644 --- a/types/ConsentState.html +++ b/types/ConsentState.html @@ -1 +1 @@ -ConsentState | @xmtp/react-native-sdk

Type alias ConsentState

ConsentState: "allowed" | "denied" | "unknown"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConsentState

ConsentState: "allowed" | "denied" | "unknown"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentCodec.html b/types/ContentCodec.html index 0e67e1d0..afea56c4 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 7bcf66be..820b86b3 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/Conversation.html b/types/Conversation.html index 346da42c..245b1b36 100644 --- a/types/Conversation.html +++ b/types/Conversation.html @@ -1 +1 @@ -Conversation | @xmtp/react-native-sdk

Type alias Conversation<ContentTypes>

Conversation<ContentTypes>: Group<ContentTypes> | Dm<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias Conversation<ContentTypes>

Conversation<ContentTypes>: Group<ContentTypes> | Dm<ContentTypes>

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ConversationId.html b/types/ConversationId.html index edcec027..563a01af 100644 --- a/types/ConversationId.html +++ b/types/ConversationId.html @@ -1 +1 @@ -ConversationId | @xmtp/react-native-sdk

Type alias ConversationId

ConversationId: string & {
    brand: unique symbol;
}

Type declaration

  • Readonly brand: unique symbol

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConversationId

ConversationId: 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/ConversationOptions.html b/types/ConversationOptions.html index 76fa91a2..07a0dfbd 100644 --- a/types/ConversationOptions.html +++ b/types/ConversationOptions.html @@ -1 +1 @@ -ConversationOptions | @xmtp/react-native-sdk

Type alias ConversationOptions

ConversationOptions: {
    addedByInboxId?: boolean;
    consentState?: boolean;
    description?: boolean;
    imageUrlSquare?: boolean;
    isActive?: boolean;
    lastMessage?: boolean;
    name?: boolean;
}

Type declaration

  • Optional addedByInboxId?: boolean
  • Optional consentState?: boolean
  • Optional description?: boolean
  • Optional imageUrlSquare?: boolean
  • Optional isActive?: boolean
  • Optional lastMessage?: boolean
  • Optional name?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConversationOptions

ConversationOptions: {
    addedByInboxId?: boolean;
    consentState?: boolean;
    description?: boolean;
    imageUrlSquare?: boolean;
    isActive?: boolean;
    lastMessage?: boolean;
    name?: boolean;
}

Type declaration

  • Optional addedByInboxId?: boolean
  • Optional consentState?: boolean
  • Optional description?: boolean
  • Optional imageUrlSquare?: boolean
  • Optional isActive?: boolean
  • Optional lastMessage?: boolean
  • Optional name?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ConversationOrder.html b/types/ConversationOrder.html index 3a77ff7e..cef99668 100644 --- a/types/ConversationOrder.html +++ b/types/ConversationOrder.html @@ -1 +1 @@ -ConversationOrder | @xmtp/react-native-sdk

Type alias ConversationOrder

ConversationOrder: "lastMessage" | "createdAt"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConversationOrder

ConversationOrder: "lastMessage" | "createdAt"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ConversationTopic.html b/types/ConversationTopic.html index 8bd1768e..31c22e95 100644 --- a/types/ConversationTopic.html +++ b/types/ConversationTopic.html @@ -1 +1 @@ -ConversationTopic | @xmtp/react-native-sdk

Type alias ConversationTopic

ConversationTopic: string & {
    brand: unique symbol;
}

Type declaration

  • Readonly brand: unique symbol

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConversationTopic

ConversationTopic: 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/ConversationType.html b/types/ConversationType.html index 01131bb1..3b3b8eed 100644 --- a/types/ConversationType.html +++ b/types/ConversationType.html @@ -1 +1 @@ -ConversationType | @xmtp/react-native-sdk

Type alias ConversationType

ConversationType: "all" | "groups" | "dms"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ConversationType

ConversationType: "all" | "groups" | "dms"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DecodedMessageUnion.html b/types/DecodedMessageUnion.html index 9bd22338..d5941846 100644 --- a/types/DecodedMessageUnion.html +++ b/types/DecodedMessageUnion.html @@ -1 +1 @@ -DecodedMessageUnion | @xmtp/react-native-sdk

Type alias DecodedMessageUnion<ContentTypes>

DecodedMessageUnion<ContentTypes>: {
    [K in keyof ContentTypes]: ContentTypes[K] extends ContentCodec<any>
        ? DecodedMessage<ContentTypes[K], ContentTypes>
        : never
}[number]

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias DecodedMessageUnion<ContentTypes>

DecodedMessageUnion<ContentTypes>: {
    [K in keyof ContentTypes]: ContentTypes[K] extends ContentCodec<any>
        ? DecodedMessage<ContentTypes[K], ContentTypes>
        : never
}[number]

Type Parameters

  • ContentTypes extends DefaultContentTypes = DefaultContentTypes

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/DecryptedLocalAttachment.html b/types/DecryptedLocalAttachment.html index ab955ff4..7b890302 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 3a74c9fe..a4eb80cd 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 de1e65ef..1a79de3a 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 0ca81e93..95c68b9c 100644 --- a/types/GroupUpdatedContent.html +++ b/types/GroupUpdatedContent.html @@ -1 +1 @@ -GroupUpdatedContent | @xmtp/react-native-sdk

Type alias GroupUpdatedContent

GroupUpdatedContent: {
    initiatedByInboxId: InboxId;
    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: InboxId;
    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 04f62d15..ade1e7f7 100644 --- a/types/GroupUpdatedMemberEntry.html +++ b/types/GroupUpdatedMemberEntry.html @@ -1 +1 @@ -GroupUpdatedMemberEntry | @xmtp/react-native-sdk

Type alias GroupUpdatedMemberEntry

GroupUpdatedMemberEntry: {
    inboxId: InboxId;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias GroupUpdatedMemberEntry

GroupUpdatedMemberEntry: {
    inboxId: InboxId;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/GroupUpdatedMetadatEntry.html b/types/GroupUpdatedMetadatEntry.html index 9de3b0d4..ee19c461 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 8f060396..45f967b2 100644 --- a/types/InboxId.html +++ b/types/InboxId.html @@ -1 +1 @@ -InboxId | @xmtp/react-native-sdk

Type alias InboxId

InboxId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias InboxId

InboxId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/MessageId.html b/types/MessageId.html index 2ab7b0fe..e2b5b209 100644 --- a/types/MessageId.html +++ b/types/MessageId.html @@ -1 +1 @@ -MessageId | @xmtp/react-native-sdk

Type alias MessageId

MessageId: string & {
    brand: unique symbol;
}

Type declaration

  • Readonly brand: unique symbol

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessageId

MessageId: 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/MessageOrder.html b/types/MessageOrder.html index 585e17fc..affecbde 100644 --- a/types/MessageOrder.html +++ b/types/MessageOrder.html @@ -1 +1 @@ -MessageOrder | @xmtp/react-native-sdk

Type alias MessageOrder

MessageOrder: "ASCENDING" | "DESCENDING"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias MessageOrder

MessageOrder: "ASCENDING" | "DESCENDING"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/NativeMessageContent.html b/types/NativeMessageContent.html index c7d58db1..02b4cb1d 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/ReactionContent.html b/types/ReactionContent.html index b6953803..63fd2e78 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 7c1a25c9..60cecfe8 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 290a8ff5..2ca314e6 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 72eba75d..1ea39a31 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 88546b2f..1a0e0933 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 7872bf7b..0d05f462 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 5aaa2ae7..d87e1343 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/types/WalletType.html b/types/WalletType.html index 85257d35..b8ee932e 100644 --- a/types/WalletType.html +++ b/types/WalletType.html @@ -1 +1 @@ -WalletType | @xmtp/react-native-sdk

Type alias WalletType

WalletType: "EOA" | "SCW"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias WalletType

WalletType: "EOA" | "SCW"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/XMTPEnvironment.html b/types/XMTPEnvironment.html index 91337a84..15d79241 100644 --- a/types/XMTPEnvironment.html +++ b/types/XMTPEnvironment.html @@ -1 +1 @@ -XMTPEnvironment | @xmtp/react-native-sdk

Type alias XMTPEnvironment

XMTPEnvironment: "local" | "dev" | "production"

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias XMTPEnvironment

XMTPEnvironment: "local" | "dev" | "production"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/XmtpContext.html b/variables/XmtpContext.html index 02f0d715..f77cc7fd 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 14335f30..a0c0555a 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