diff --git a/functions/XMTPProvider.html b/functions/XMTPProvider.html index f344c698..40f155c6 100644 --- a/functions/XMTPProvider.html +++ b/functions/XMTPProvider.html @@ -1 +1 @@ -XMTPProvider | @xmtp/react-sdk

Function XMTPProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function XMTPProvider

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/bulkPutConsentState.html b/functions/bulkPutConsentState.html index 96d08320..b2493e8e 100644 --- a/functions/bulkPutConsentState.html +++ b/functions/bulkPutConsentState.html @@ -1,2 +1,2 @@ bulkPutConsentState | @xmtp/react-sdk

Function bulkPutConsentState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/clearCache.html b/functions/clearCache.html index ae3f3943..c6fcb0e4 100644 --- a/functions/clearCache.html +++ b/functions/clearCache.html @@ -1 +1 @@ -clearCache | @xmtp/react-sdk

Function clearCache

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function clearCache

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/deleteMessage.html b/functions/deleteMessage.html index 435cb2bc..3a4a7bb3 100644 --- a/functions/deleteMessage.html +++ b/functions/deleteMessage.html @@ -1,2 +1,2 @@ deleteMessage | @xmtp/react-sdk

Function deleteMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getAttachment.html b/functions/getAttachment.html index d4d5238e..34cff44c 100644 --- a/functions/getAttachment.html +++ b/functions/getAttachment.html @@ -2,4 +2,4 @@

Parameters

Returns undefined | Attachment | RemoteAttachment

The attachment data, or undefined if the message is not an attachment content type

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getCachedConsentEntries.html b/functions/getCachedConsentEntries.html index 63db3dad..b4f6df64 100644 --- a/functions/getCachedConsentEntries.html +++ b/functions/getCachedConsentEntries.html @@ -1,3 +1,3 @@ getCachedConsentEntries | @xmtp/react-sdk

Function getCachedConsentEntries

  • getCachedConsentEntries(walletAddress, db): Promise<ConsentListEntry[]>

  • Retrieve all cached consent entries

    Parameters

    • walletAddress: string
    • db: Dexie

    Returns Promise<ConsentListEntry[]>

    An array of ConsentListEntry instances

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getCachedConsentState.html b/functions/getCachedConsentState.html index a46b3c6b..cf3c7aa9 100644 --- a/functions/getCachedConsentState.html +++ b/functions/getCachedConsentState.html @@ -1,3 +1,3 @@ getCachedConsentState | @xmtp/react-sdk

Function getCachedConsentState

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getCachedConversationByPeerAddress.html b/functions/getCachedConversationByPeerAddress.html index 9809fafa..4f873072 100644 --- a/functions/getCachedConversationByPeerAddress.html +++ b/functions/getCachedConversationByPeerAddress.html @@ -1,3 +1,3 @@ getCachedConversationByPeerAddress | @xmtp/react-sdk

Function getCachedConversationByPeerAddress

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getCachedConversationByTopic.html b/functions/getCachedConversationByTopic.html index 7c5cfc20..d7815a11 100644 --- a/functions/getCachedConversationByTopic.html +++ b/functions/getCachedConversationByTopic.html @@ -1,3 +1,3 @@ getCachedConversationByTopic | @xmtp/react-sdk

Function getCachedConversationByTopic

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getConversationByTopic.html b/functions/getConversationByTopic.html index f9255500..fdd5e441 100644 --- a/functions/getConversationByTopic.html +++ b/functions/getConversationByTopic.html @@ -1,3 +1,3 @@ getConversationByTopic | @xmtp/react-sdk

Function getConversationByTopic

  • getConversationByTopic(topic, client): Promise<undefined | Conversation<any>>

  • Retrieve a conversation from the XMTP client by a topic

    Parameters

    • topic: string
    • client: Client<any>

    Returns Promise<undefined | Conversation<any>>

    The conversation if found, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getDbInstance.html b/functions/getDbInstance.html index c873a7ef..990a3e67 100644 --- a/functions/getDbInstance.html +++ b/functions/getDbInstance.html @@ -1,2 +1,2 @@ getDbInstance | @xmtp/react-sdk

Function getDbInstance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Dexie

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getLastMessage.html b/functions/getLastMessage.html index 313ab2a8..7618cce7 100644 --- a/functions/getLastMessage.html +++ b/functions/getLastMessage.html @@ -1,2 +1,2 @@ getLastMessage | @xmtp/react-sdk

Function getLastMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<CachedMessage<any, ContentTypeMetadata>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getMessageByXmtpID.html b/functions/getMessageByXmtpID.html index f09062ca..dea87b20 100644 --- a/functions/getMessageByXmtpID.html +++ b/functions/getMessageByXmtpID.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<undefined | CachedMessageWithId<any>>

The cached message, or undefined if not found

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getOriginalMessageFromReply.html b/functions/getOriginalMessageFromReply.html index 7cd19104..77dc874b 100644 --- a/functions/getOriginalMessageFromReply.html +++ b/functions/getOriginalMessageFromReply.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<undefined | CachedMessageWithId<any>>

The original message, or undefined if the reply message is invalid

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getReactionsByXmtpID.html b/functions/getReactionsByXmtpID.html index f2b3c885..c4592a8d 100644 --- a/functions/getReactionsByXmtpID.html +++ b/functions/getReactionsByXmtpID.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<CachedReaction[]>

An array of reactions to the message

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/getReplies.html b/functions/getReplies.html index d3611d6e..c79f8af2 100644 --- a/functions/getReplies.html +++ b/functions/getReplies.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<CachedMessageWithId[]>

An array of reply messages

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/hasConversationTopic.html b/functions/hasConversationTopic.html index 605a83b2..e47f6b97 100644 --- a/functions/hasConversationTopic.html +++ b/functions/hasConversationTopic.html @@ -1,2 +1,2 @@ hasConversationTopic | @xmtp/react-sdk

Function hasConversationTopic

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/hasReaction.html b/functions/hasReaction.html index 10569fc0..59875b18 100644 --- a/functions/hasReaction.html +++ b/functions/hasReaction.html @@ -1,4 +1,4 @@ hasReaction | @xmtp/react-sdk

Function hasReaction

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/hasReply.html b/functions/hasReply.html index 824b946a..b70451c2 100644 --- a/functions/hasReply.html +++ b/functions/hasReply.html @@ -2,4 +2,4 @@

Parameters

Returns Promise<boolean>

true if the message has any replies, false otherwise

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/isValidAddress.html b/functions/isValidAddress.html index 456f4380..03298326 100644 --- a/functions/isValidAddress.html +++ b/functions/isValidAddress.html @@ -1,4 +1,4 @@ isValidAddress | @xmtp/react-sdk

Function isValidAddress

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/loadConsentListFromCache.html b/functions/loadConsentListFromCache.html index 5d5c9d30..b92ecf1d 100644 --- a/functions/loadConsentListFromCache.html +++ b/functions/loadConsentListFromCache.html @@ -1,2 +1,2 @@ loadConsentListFromCache | @xmtp/react-sdk

Function loadConsentListFromCache

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/putConsentState.html b/functions/putConsentState.html index 28c5c268..047facb9 100644 --- a/functions/putConsentState.html +++ b/functions/putConsentState.html @@ -1,2 +1,2 @@ putConsentState | @xmtp/react-sdk

Function putConsentState

  • putConsentState(walletAddress, peerAddress, state, db): Promise<void>

  • Add or update a peer address's consent state

    -

    Parameters

    • walletAddress: string
    • peerAddress: string
    • state: ConsentState
    • db: Dexie

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/saveConversation.html b/functions/saveConversation.html index afeed7d7..17f3909a 100644 --- a/functions/saveConversation.html +++ b/functions/saveConversation.html @@ -1,3 +1,3 @@ saveConversation | @xmtp/react-sdk

Function saveConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/saveMessage.html b/functions/saveMessage.html index 75cfeaac..0d0d55f9 100644 --- a/functions/saveMessage.html +++ b/functions/saveMessage.html @@ -1,3 +1,3 @@ saveMessage | @xmtp/react-sdk

Function saveMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/setConversationUpdatedAt.html b/functions/setConversationUpdatedAt.html index aaa283d4..a4d42637 100644 --- a/functions/setConversationUpdatedAt.html +++ b/functions/setConversationUpdatedAt.html @@ -1,2 +1,2 @@ setConversationUpdatedAt | @xmtp/react-sdk

Function setConversationUpdatedAt

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/toCachedConversation.html b/functions/toCachedConversation.html index b30f3c1b..1313c8a7 100644 --- a/functions/toCachedConversation.html +++ b/functions/toCachedConversation.html @@ -1,3 +1,3 @@ toCachedConversation | @xmtp/react-sdk

Function toCachedConversation

  • toCachedConversation(conversation, walletAddress): {
        context: undefined | InvitationContext;
        createdAt: Date;
        isReady: boolean;
        peerAddress: string;
        topic: string;
        updatedAt: Date;
        walletAddress: string;
    }

  • Converts a Conversation from the XMTP network to its cached format

    Parameters

    • conversation: Conversation<any>
    • walletAddress: string

    Returns {
        context: undefined | InvitationContext;
        createdAt: Date;
        isReady: boolean;
        peerAddress: string;
        topic: string;
        updatedAt: Date;
        walletAddress: string;
    }

    The conversation in cached format

    -
    • context: undefined | InvitationContext
    • createdAt: Date
    • isReady: boolean
    • peerAddress: string
    • topic: string
    • updatedAt: Date
    • walletAddress: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/toCachedMessage.html b/functions/toCachedMessage.html index 56f1c91e..48d13f9f 100644 --- a/functions/toCachedMessage.html +++ b/functions/toCachedMessage.html @@ -2,4 +2,4 @@

Parameters

Returns {
    content: any;
    contentBytes: undefined | Uint8Array;
    contentFallback: undefined | string;
    contentType: string;
    conversationTopic: string;
    hasLoadError: false;
    hasSendError: false;
    isSending: false;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed";
    uuid: string;
    walletAddress: string;
    xmtpID: string;
}

The message in cached format

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateConversation.html b/functions/updateConversation.html index 2ba36e9d..f6ba1605 100644 --- a/functions/updateConversation.html +++ b/functions/updateConversation.html @@ -1,2 +1,2 @@ updateConversation | @xmtp/react-sdk

Function updateConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateConversationMetadata.html b/functions/updateConversationMetadata.html index f01192fd..43ec77ab 100644 --- a/functions/updateConversationMetadata.html +++ b/functions/updateConversationMetadata.html @@ -1,3 +1,3 @@ updateConversationMetadata | @xmtp/react-sdk

Function updateConversationMetadata

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateMessage.html b/functions/updateMessage.html index 181a45f8..77962bc9 100644 --- a/functions/updateMessage.html +++ b/functions/updateMessage.html @@ -1,2 +1,2 @@ updateMessage | @xmtp/react-sdk

Function updateMessage

  • updateMessage(message, update, db): Promise<{
        content: any;
        contentBytes?: Uint8Array;
        contentFallback?: string;
        contentType: string;
        conversationTopic: string;
        hasLoadError: boolean;
        hasSendError: boolean;
        id?: number;
        isSending: boolean;
        metadata?: ContentTypeMetadata;
        sendOptions?: SendOptions;
        senderAddress: string;
        sentAt: Date;
        status: "unprocessed" | "processed";
        uuid: string;
        walletAddress: string;
        xmtpID: string;
    }>

  • Update properties of a cached message

    -

    Parameters

    Returns Promise<{
        content: any;
        contentBytes?: Uint8Array;
        contentFallback?: string;
        contentType: string;
        conversationTopic: string;
        hasLoadError: boolean;
        hasSendError: boolean;
        id?: number;
        isSending: boolean;
        metadata?: ContentTypeMetadata;
        sendOptions?: SendOptions;
        senderAddress: string;
        sentAt: Date;
        status: "unprocessed" | "processed";
        uuid: string;
        walletAddress: string;
        xmtpID: string;
    }>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<{
    content: any;
    contentBytes?: Uint8Array;
    contentFallback?: string;
    contentType: string;
    conversationTopic: string;
    hasLoadError: boolean;
    hasSendError: boolean;
    id?: number;
    isSending: boolean;
    metadata?: ContentTypeMetadata;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
    xmtpID: string;
}>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/updateMessageMetadata.html b/functions/updateMessageMetadata.html index 0538be56..714fccb2 100644 --- a/functions/updateMessageMetadata.html +++ b/functions/updateMessageMetadata.html @@ -1,3 +1,3 @@ updateMessageMetadata | @xmtp/react-sdk

Function updateMessageMetadata

  • updateMessageMetadata(message, namespace, data, db): Promise<{
        content: any;
        contentBytes?: Uint8Array;
        contentFallback?: string;
        contentType: string;
        conversationTopic: string;
        hasLoadError: boolean;
        hasSendError: boolean;
        id?: number;
        isSending: boolean;
        metadata?: ContentTypeMetadata;
        sendOptions?: SendOptions;
        senderAddress: string;
        sentAt: Date;
        status: "unprocessed" | "processed";
        uuid: string;
        walletAddress: string;
        xmtpID: string;
    }>

  • Update metadata of a cached message using the specified namespace

    This is not meant to be called directly

    -

    Parameters

    Returns Promise<{
        content: any;
        contentBytes?: Uint8Array;
        contentFallback?: string;
        contentType: string;
        conversationTopic: string;
        hasLoadError: boolean;
        hasSendError: boolean;
        id?: number;
        isSending: boolean;
        metadata?: ContentTypeMetadata;
        sendOptions?: SendOptions;
        senderAddress: string;
        sentAt: Date;
        status: "unprocessed" | "processed";
        uuid: string;
        walletAddress: string;
        xmtpID: string;
    }>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<{
    content: any;
    contentBytes?: Uint8Array;
    contentFallback?: string;
    contentType: string;
    conversationTopic: string;
    hasLoadError: boolean;
    hasSendError: boolean;
    id?: number;
    isSending: boolean;
    metadata?: ContentTypeMetadata;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
    xmtpID: string;
}>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useAttachment.html b/functions/useAttachment.html index 2571355c..ed73935e 100644 --- a/functions/useAttachment.html +++ b/functions/useAttachment.html @@ -1,2 +1,2 @@ useAttachment | @xmtp/react-sdk

Function useAttachment

  • useAttachment(message, options?): {
        attachment: undefined | Attachment;
        error: undefined | Error;
        load: (() => void);
        status: AttachmentStatus;
    }

  • This hook returns the attachment data of a cached message

    -

    Parameters

    Returns {
        attachment: undefined | Attachment;
        error: undefined | Error;
        load: (() => void);
        status: AttachmentStatus;
    }

    • attachment: undefined | Attachment
    • error: undefined | Error
    • load: (() => void)
        • (): void

        • Returns void

    • status: AttachmentStatus

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    attachment: undefined | Attachment;
    error: undefined | Error;
    load: (() => void);
    status: AttachmentStatus;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useCanMessage.html b/functions/useCanMessage.html index c102ed6c..2bb725f9 100644 --- a/functions/useCanMessage.html +++ b/functions/useCanMessage.html @@ -1,3 +1,3 @@ useCanMessage | @xmtp/react-sdk

Function useCanMessage

  • useCanMessage(onError?): {
        canMessage: (<T>(peerAddress) => Promise<CanMessageReturns<T>>);
        canMessageStatic: (<T>(peerAddress, options?) => Promise<CanMessageReturns<T>>);
        error: null | Error;
        isLoading: boolean;
    }

  • This hook exposes both the client and static instances of the canMessage method.

    -

    Parameters

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

        • Parameters

          • error: Error

          Returns void

    Returns {
        canMessage: (<T>(peerAddress) => Promise<CanMessageReturns<T>>);
        canMessageStatic: (<T>(peerAddress, options?) => Promise<CanMessageReturns<T>>);
        error: null | Error;
        isLoading: boolean;
    }

    • canMessage: (<T>(peerAddress) => Promise<CanMessageReturns<T>>)
        • <T>(peerAddress): Promise<CanMessageReturns<T>>

        • Type Parameters

          • T extends string | string[]

          Parameters

          • peerAddress: T

          Returns Promise<CanMessageReturns<T>>

    • canMessageStatic: (<T>(peerAddress, options?) => Promise<CanMessageReturns<T>>)
        • <T>(peerAddress, options?): Promise<CanMessageReturns<T>>

        • Type Parameters

          • T extends string | string[]

          Parameters

          • peerAddress: T
          • Optional options: Partial<NetworkOptions>

          Returns Promise<CanMessageReturns<T>>

    • error: null | Error
    • isLoading: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    canMessage: (<T>(peerAddress) => Promise<CanMessageReturns<T>>);
    canMessageStatic: (<T>(peerAddress, options?) => Promise<CanMessageReturns<T>>);
    error: null | Error;
    isLoading: boolean;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useClient.html b/functions/useClient.html index 60923458..be0a5ec6 100644 --- a/functions/useClient.html +++ b/functions/useClient.html @@ -1,3 +1,3 @@ useClient | @xmtp/react-sdk

Function useClient

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

  • This hook allows you to initialize, disconnect, and access the XMTP client instance. It also exposes the error and loading states of the client.

    -

    Parameters

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

        • Parameters

          • error: Error

          Returns void

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

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

        • Returns Promise<void>

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

        • Parameters

          • __namedParameters: InitializeClientOptions

          Returns Promise<undefined | Client<any>>

    • isLoading: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useConsent.html b/functions/useConsent.html index ed0988e3..8425270c 100644 --- a/functions/useConsent.html +++ b/functions/useConsent.html @@ -1,2 +1,2 @@ useConsent | @xmtp/react-sdk

Function useConsent

  • useConsent(): {
        allow: ((addresses) => Promise<void>);
        consentState: ((address) => ConsentState);
        deny: ((addresses) => Promise<void>);
        isAllowed: ((address) => undefined | boolean);
        isDenied: ((address) => undefined | boolean);
        loadConsentList: ((startTime?) => Promise<ConsentListEntry[]>);
        refreshConsentList: (() => Promise<ConsentListEntry[]>);
    }

  • This hook returns helper functions for working with consent

    -

    Returns {
        allow: ((addresses) => Promise<void>);
        consentState: ((address) => ConsentState);
        deny: ((addresses) => Promise<void>);
        isAllowed: ((address) => undefined | boolean);
        isDenied: ((address) => undefined | boolean);
        loadConsentList: ((startTime?) => Promise<ConsentListEntry[]>);
        refreshConsentList: (() => Promise<ConsentListEntry[]>);
    }

    • allow: ((addresses) => Promise<void>)
        • (addresses): Promise<void>

        • Parameters

          • addresses: string[]

          Returns Promise<void>

    • consentState: ((address) => ConsentState)
        • (address): ConsentState

        • Parameters

          • address: string

          Returns ConsentState

    • deny: ((addresses) => Promise<void>)
        • (addresses): Promise<void>

        • Parameters

          • addresses: string[]

          Returns Promise<void>

    • isAllowed: ((address) => undefined | boolean)
        • (address): undefined | boolean

        • Parameters

          • address: string

          Returns undefined | boolean

    • isDenied: ((address) => undefined | boolean)
        • (address): undefined | boolean

        • Parameters

          • address: string

          Returns undefined | boolean

    • loadConsentList: ((startTime?) => Promise<ConsentListEntry[]>)
        • (startTime?): Promise<ConsentListEntry[]>

        • Parameters

          • Optional startTime: Date

          Returns Promise<ConsentListEntry[]>

    • refreshConsentList: (() => Promise<ConsentListEntry[]>)
        • (): Promise<ConsentListEntry[]>

        • Returns Promise<ConsentListEntry[]>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns {
    allow: ((addresses) => Promise<void>);
    consentState: ((address) => ConsentState);
    deny: ((addresses) => Promise<void>);
    isAllowed: ((address) => undefined | boolean);
    isDenied: ((address) => undefined | boolean);
    loadConsentList: ((startTime?) => Promise<ConsentListEntry[]>);
    refreshConsentList: (() => Promise<ConsentListEntry[]>);
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useConversation.html b/functions/useConversation.html index 24135eb1..47ab4d59 100644 --- a/functions/useConversation.html +++ b/functions/useConversation.html @@ -1,3 +1,3 @@ useConversation | @xmtp/react-sdk

Function useConversation

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns {
    getByTopic: ((topic) => Promise<undefined | Conversation<any>>);
    getCachedByPeerAddress: ((peerAddress) => Promise<undefined | CachedConversationWithId>);
    getCachedByTopic: ((topic) => Promise<undefined | CachedConversationWithId>);
    getLastMessage: ((topic) => Promise<CachedMessage<any, ContentTypeMetadata>>);
    hasConversationTopic: ((topic) => Promise<boolean>);
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useConversations.html b/functions/useConversations.html index edf146d4..58f288bc 100644 --- a/functions/useConversations.html +++ b/functions/useConversations.html @@ -1,3 +1,3 @@ useConversations | @xmtp/react-sdk

Function useConversations

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    conversations: CachedConversation<ContentTypeMetadata>[];
    error: null | Error;
    isLoaded: boolean;
    isLoading: boolean;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useDb.html b/functions/useDb.html index 3105c257..c0f73d68 100644 --- a/functions/useDb.html +++ b/functions/useDb.html @@ -1,3 +1,3 @@ useDb | @xmtp/react-sdk

Function useDb

  • useDb(): {
        clearCache: (() => Promise<void>);
        db: Dexie;
    }

  • This hook returns the local DB instance and a method for clearing all of its data

    -

    Returns {
        clearCache: (() => Promise<void>);
        db: Dexie;
    }

    • clearCache: (() => Promise<void>)
        • (): Promise<void>

        • Returns Promise<void>

    • db: Dexie

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Returns {
    clearCache: (() => Promise<void>);
    db: Dexie;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useLastMessage.html b/functions/useLastMessage.html index 53a3507d..70400a7c 100644 --- a/functions/useLastMessage.html +++ b/functions/useLastMessage.html @@ -1,2 +1,2 @@ useLastMessage | @xmtp/react-sdk

Function useLastMessage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns undefined | CachedMessage<any, ContentTypeMetadata>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useMessages.html b/functions/useMessages.html index db5ad211..53a5f007 100644 --- a/functions/useMessages.html +++ b/functions/useMessages.html @@ -1,4 +1,4 @@ useMessages | @xmtp/react-sdk

Function useMessages

  • useMessages(conversation, options?): {
        error: null | Error;
        isLoaded: boolean;
        isLoading: boolean;
        messages: CachedMessageWithId[];
    }

  • This hook fetches a list of all messages within a conversation on mount. It also exposes loading and error states and whether or not there are more messages based on the options passed.

    -

    Parameters

    Returns {
        error: null | Error;
        isLoaded: boolean;
        isLoading: boolean;
        messages: CachedMessageWithId[];
    }

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
    isLoaded: boolean;
    isLoading: boolean;
    messages: CachedMessageWithId[];
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useReactions.html b/functions/useReactions.html index 2257c669..6059818d 100644 --- a/functions/useReactions.html +++ b/functions/useReactions.html @@ -1,2 +1,2 @@ useReactions | @xmtp/react-sdk

Function useReactions

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns CachedReaction[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useReplies.html b/functions/useReplies.html index e846f86b..0b562bfa 100644 --- a/functions/useReplies.html +++ b/functions/useReplies.html @@ -1,2 +1,2 @@ useReplies | @xmtp/react-sdk

Function useReplies

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns CachedMessageWithId[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useReply.html b/functions/useReply.html index 0045086e..e5dc2502 100644 --- a/functions/useReply.html +++ b/functions/useReply.html @@ -1,2 +1,2 @@ useReply | @xmtp/react-sdk

Function useReply

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    originalMessage: undefined | CachedMessage;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useResendMessage.html b/functions/useResendMessage.html index d5257e4b..78255a1a 100644 --- a/functions/useResendMessage.html +++ b/functions/useResendMessage.html @@ -1,2 +1,2 @@ useResendMessage | @xmtp/react-sdk

Function useResendMessage

  • useResendMessage(options?): {
        cancel: ((message) => Promise<void>);
        error: null | Error;
        isLoading: boolean;
        resend: ((message) => Promise<DecodedMessage<any>>);
    }

  • This hook can be used to resend a previously failed message, or cancel it.

    -

    Parameters

    • Optional options: UseSendMessageOptions

    Returns {
        cancel: ((message) => Promise<void>);
        error: null | Error;
        isLoading: boolean;
        resend: ((message) => Promise<DecodedMessage<any>>);
    }

    • cancel: ((message) => Promise<void>)
    • error: null | Error
    • isLoading: boolean
    • resend: ((message) => Promise<DecodedMessage<any>>)
        • (message): Promise<DecodedMessage<any>>

        • Parameters

          Returns Promise<DecodedMessage<any>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    cancel: ((message) => Promise<void>);
    error: null | Error;
    isLoading: boolean;
    resend: ((message) => Promise<DecodedMessage<any>>);
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useSendMessage.html b/functions/useSendMessage.html index 127b00c0..b5fb8165 100644 --- a/functions/useSendMessage.html +++ b/functions/useSendMessage.html @@ -1,2 +1,2 @@ useSendMessage | @xmtp/react-sdk

Function useSendMessage

  • useSendMessage(options?): {
        error: null | Error;
        isLoading: boolean;
        sendMessage: (<T>(conversation, content, contentType?, sendOptions?) => Promise<undefined | DecodedMessage<any>>);
    }

  • This hook sends a new message into a conversation

    -

    Parameters

    • Optional options: UseSendMessageOptions

    Returns {
        error: null | Error;
        isLoading: boolean;
        sendMessage: (<T>(conversation, content, contentType?, sendOptions?) => Promise<undefined | DecodedMessage<any>>);
    }

    • error: null | Error
    • isLoading: boolean
    • sendMessage: (<T>(conversation, content, contentType?, sendOptions?) => Promise<undefined | DecodedMessage<any>>)
        • <T>(conversation, content, contentType?, sendOptions?): Promise<undefined | DecodedMessage<any>>

        • Type Parameters

          • T = string

          Parameters

          • conversation: CachedConversation
          • content: T
          • Optional contentType: ContentTypeId
          • Optional sendOptions: Omit<SendOptions, "contentType">

          Returns Promise<undefined | DecodedMessage<any>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
    isLoading: boolean;
    sendMessage: (<T>(conversation, content, contentType?, sendOptions?) => Promise<undefined | DecodedMessage<any>>);
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useStartConversation.html b/functions/useStartConversation.html index e7c4a9e2..51c2cb5e 100644 --- a/functions/useStartConversation.html +++ b/functions/useStartConversation.html @@ -1,2 +1,2 @@ useStartConversation | @xmtp/react-sdk

Function useStartConversation

  • useStartConversation(options?): {
        error: null | Error;
        isLoading: boolean;
        startConversation: (<T>(peerAddress, content, contentType?, sendOptions?) => Promise<{
            cachedConversation: undefined;
            cachedMessage: undefined;
            conversation: undefined;
        } | {
            cachedConversation: undefined;
            cachedMessage: undefined;
            conversation: Conversation<any>;
        } | {
            cachedConversation: CachedConversationWithId;
            cachedMessage: undefined;
            conversation: Conversation<any>;
        } | {
            cachedConversation: CachedConversationWithId;
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            conversation: Conversation<any>;
        }>);
    }

  • This hook starts a new conversation and sends an initial message to it.

    -

    Parameters

    • Optional options: UseStartConversation

    Returns {
        error: null | Error;
        isLoading: boolean;
        startConversation: (<T>(peerAddress, content, contentType?, sendOptions?) => Promise<{
            cachedConversation: undefined;
            cachedMessage: undefined;
            conversation: undefined;
        } | {
            cachedConversation: undefined;
            cachedMessage: undefined;
            conversation: Conversation<any>;
        } | {
            cachedConversation: CachedConversationWithId;
            cachedMessage: undefined;
            conversation: Conversation<any>;
        } | {
            cachedConversation: CachedConversationWithId;
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            conversation: Conversation<any>;
        }>);
    }

    • error: null | Error
    • isLoading: boolean
    • startConversation: (<T>(peerAddress, content, contentType?, sendOptions?) => Promise<{
          cachedConversation: undefined;
          cachedMessage: undefined;
          conversation: undefined;
      } | {
          cachedConversation: undefined;
          cachedMessage: undefined;
          conversation: Conversation<any>;
      } | {
          cachedConversation: CachedConversationWithId;
          cachedMessage: undefined;
          conversation: Conversation<any>;
      } | {
          cachedConversation: CachedConversationWithId;
          cachedMessage: CachedMessage<any, ContentTypeMetadata>;
          conversation: Conversation<any>;
      }>)
        • <T>(peerAddress, content, contentType?, sendOptions?): Promise<{
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: undefined;
          } | {
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          } | {
              cachedConversation: CachedConversationWithId;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          } | {
              cachedConversation: CachedConversationWithId;
              cachedMessage: CachedMessage<any, ContentTypeMetadata>;
              conversation: Conversation<any>;
          }>

        • Type Parameters

          • T = string

          Parameters

          • peerAddress: string
          • content: T
          • Optional contentType: ContentTypeId
          • Optional sendOptions: SendMessageOptions

          Returns Promise<{
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: undefined;
          } | {
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          } | {
              cachedConversation: CachedConversationWithId;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          } | {
              cachedConversation: CachedConversationWithId;
              cachedMessage: CachedMessage<any, ContentTypeMetadata>;
              conversation: Conversation<any>;
          }>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
    isLoading: boolean;
    startConversation: (<T>(peerAddress, content, contentType?, sendOptions?) => Promise<{
        cachedConversation: undefined;
        cachedMessage: undefined;
        conversation: undefined;
    } | {
        cachedConversation: undefined;
        cachedMessage: undefined;
        conversation: Conversation<any>;
    } | {
        cachedConversation: CachedConversationWithId;
        cachedMessage: undefined;
        conversation: Conversation<any>;
    } | {
        cachedConversation: CachedConversationWithId;
        cachedMessage: CachedMessage<any, ContentTypeMetadata>;
        conversation: Conversation<any>;
    }>);
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useStreamAllMessages.html b/functions/useStreamAllMessages.html index 18971c5c..98252cd9 100644 --- a/functions/useStreamAllMessages.html +++ b/functions/useStreamAllMessages.html @@ -1,3 +1,3 @@ useStreamAllMessages | @xmtp/react-sdk

Function useStreamAllMessages

  • useStreamAllMessages(onMessage?, onError?): {
        error: null | Error;
    }

  • This hook streams new messages from all conversations on mount and exposes an error state.

    -

    Parameters

    • Optional onMessage: ((message) => void | Promise<void>)
        • (message): void | Promise<void>

        • Parameters

          • message: DecodedMessage<any>

          Returns void | Promise<void>

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

        • Parameters

          • error: Error

          Returns void

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useStreamConsentList.html b/functions/useStreamConsentList.html index 6f2404df..d77bba74 100644 --- a/functions/useStreamConsentList.html +++ b/functions/useStreamConsentList.html @@ -1,3 +1,3 @@ useStreamConsentList | @xmtp/react-sdk

Function useStreamConsentList

  • useStreamConsentList(onAction?, onError?): {
        error: null | Error;
    }

  • This hook streams new consent list actions on mount and exposes an error state.

    -

    Parameters

    • Optional onAction: ((action) => void | Promise<void>)
        • (action): void | Promise<void>

        • Parameters

          • action: PrivatePreferencesAction

          Returns void | Promise<void>

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

        • Parameters

          • error: Error

          Returns void

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useStreamConversations.html b/functions/useStreamConversations.html index 85631fc2..3716522a 100644 --- a/functions/useStreamConversations.html +++ b/functions/useStreamConversations.html @@ -1,3 +1,3 @@ useStreamConversations | @xmtp/react-sdk

Function useStreamConversations

  • useStreamConversations(options?): {
        error: null | Error;
    }

  • This hook listens for new conversations in real-time and calls the passed callback when a new conversation is created. It also exposes an error state.

    -

    Parameters

    • Optional options: UseStreamConversationsOptions

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/useStreamMessages.html b/functions/useStreamMessages.html index 0944f529..c721a326 100644 --- a/functions/useStreamMessages.html +++ b/functions/useStreamMessages.html @@ -1,2 +1,2 @@ useStreamMessages | @xmtp/react-sdk

Function useStreamMessages

  • useStreamMessages(conversation, options?): {
        error: null | Error;
    }

  • This hook streams new conversation messages on mount and exposes an error state.

    -

    Parameters

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns {
    error: null | Error;
}

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedConsentEntry.html b/types/CachedConsentEntry.html index 98236c4e..3949f84b 100644 --- a/types/CachedConsentEntry.html +++ b/types/CachedConsentEntry.html @@ -1 +1 @@ -CachedConsentEntry | @xmtp/react-sdk

Type alias CachedConsentEntry

CachedConsentEntry: {
    peerAddress: string;
    state: ConsentState;
    walletAddress: string;
}

Type declaration

  • peerAddress: string
  • state: ConsentState
  • walletAddress: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedConsentEntry

CachedConsentEntry: {
    peerAddress: string;
    state: ConsentState;
    walletAddress: string;
}

Type declaration

  • peerAddress: string
  • state: ConsentState
  • walletAddress: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedConsentTable.html b/types/CachedConsentTable.html index 7e1d771a..e47ebed3 100644 --- a/types/CachedConsentTable.html +++ b/types/CachedConsentTable.html @@ -1 +1 @@ -CachedConsentTable | @xmtp/react-sdk

Type alias CachedConsentTable

CachedConsentTable: Table<CachedConsentEntry, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedConsentTable

CachedConsentTable: Table<CachedConsentEntry, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedConversation.html b/types/CachedConversation.html index 6ed46a1e..6b4fbb8c 100644 --- a/types/CachedConversation.html +++ b/types/CachedConversation.html @@ -1 +1 @@ -CachedConversation | @xmtp/react-sdk

Type alias CachedConversation<M>

CachedConversation<M>: {
    context?: InvitationContext;
    createdAt: Date;
    id?: number;
    isReady: boolean;
    lastSyncedAt?: Date;
    metadata?: M;
    peerAddress: string;
    topic: string;
    updatedAt: Date;
    walletAddress: string;
}

Type Parameters

Type declaration

  • Optional context?: InvitationContext
  • createdAt: Date
  • Optional id?: number
  • isReady: boolean
  • Optional lastSyncedAt?: Date
  • Optional metadata?: M
  • peerAddress: string
  • topic: string
  • updatedAt: Date
  • walletAddress: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedConversation<M>

CachedConversation<M>: {
    context?: InvitationContext;
    createdAt: Date;
    id?: number;
    isReady: boolean;
    lastSyncedAt?: Date;
    metadata?: M;
    peerAddress: string;
    topic: string;
    updatedAt: Date;
    walletAddress: string;
}

Type Parameters

Type declaration

  • Optional context?: InvitationContext
  • createdAt: Date
  • Optional id?: number
  • isReady: boolean
  • Optional lastSyncedAt?: Date
  • Optional metadata?: M
  • peerAddress: string
  • topic: string
  • updatedAt: Date
  • walletAddress: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedConversationWithId.html b/types/CachedConversationWithId.html index 925f7ef2..3114f306 100644 --- a/types/CachedConversationWithId.html +++ b/types/CachedConversationWithId.html @@ -1 +1 @@ -CachedConversationWithId | @xmtp/react-sdk

Type alias CachedConversationWithId

CachedConversationWithId: CachedConversation & {
    id: number;
}

Type declaration

  • id: number

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedConversationWithId

CachedConversationWithId: CachedConversation & {
    id: number;
}

Type declaration

  • id: number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedConversationsTable.html b/types/CachedConversationsTable.html index 54f5b528..6e0fa271 100644 --- a/types/CachedConversationsTable.html +++ b/types/CachedConversationsTable.html @@ -1 +1 @@ -CachedConversationsTable | @xmtp/react-sdk

Type alias CachedConversationsTable

CachedConversationsTable: Table<CachedConversation, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedConversationsTable

CachedConversationsTable: Table<CachedConversation, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedMessage.html b/types/CachedMessage.html index 77ee2ddc..3791f7b0 100644 --- a/types/CachedMessage.html +++ b/types/CachedMessage.html @@ -1 +1 @@ -CachedMessage | @xmtp/react-sdk

Type alias CachedMessage<C, M>

CachedMessage<C, M>: {
    content: C;
    contentBytes?: Uint8Array;
    contentFallback?: string;
    contentType: string;
    conversationTopic: string;
    hasLoadError: boolean;
    hasSendError: boolean;
    id?: number;
    isSending: boolean;
    metadata?: M;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
    xmtpID: string;
}

Type Parameters

Type declaration

  • content: C
  • Optional contentBytes?: Uint8Array
  • Optional contentFallback?: string
  • contentType: string
  • conversationTopic: string
  • hasLoadError: boolean
  • hasSendError: boolean
  • Optional id?: number
  • isSending: boolean
  • Optional metadata?: M
  • Optional sendOptions?: SendOptions
  • senderAddress: string
  • sentAt: Date
  • status: "unprocessed" | "processed"
  • uuid: string
  • walletAddress: string
  • xmtpID: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedMessage<C, M>

CachedMessage<C, M>: {
    content: C;
    contentBytes?: Uint8Array;
    contentFallback?: string;
    contentType: string;
    conversationTopic: string;
    hasLoadError: boolean;
    hasSendError: boolean;
    id?: number;
    isSending: boolean;
    metadata?: M;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
    xmtpID: string;
}

Type Parameters

Type declaration

  • content: C
  • Optional contentBytes?: Uint8Array
  • Optional contentFallback?: string
  • contentType: string
  • conversationTopic: string
  • hasLoadError: boolean
  • hasSendError: boolean
  • Optional id?: number
  • isSending: boolean
  • Optional metadata?: M
  • Optional sendOptions?: SendOptions
  • senderAddress: string
  • sentAt: Date
  • status: "unprocessed" | "processed"
  • uuid: string
  • walletAddress: string
  • xmtpID: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedMessageWithId.html b/types/CachedMessageWithId.html index d0472e1c..bc79cae5 100644 --- a/types/CachedMessageWithId.html +++ b/types/CachedMessageWithId.html @@ -1 +1 @@ -CachedMessageWithId | @xmtp/react-sdk

Type alias CachedMessageWithId<C>

CachedMessageWithId<C>: CachedMessage<C> & {
    id: number;
}

Type Parameters

  • C = any

Type declaration

  • id: number

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedMessageWithId<C>

CachedMessageWithId<C>: CachedMessage<C> & {
    id: number;
}

Type Parameters

  • C = any

Type declaration

  • id: number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedMessagesTable.html b/types/CachedMessagesTable.html index f2283c69..691f61dc 100644 --- a/types/CachedMessagesTable.html +++ b/types/CachedMessagesTable.html @@ -1 +1 @@ -CachedMessagesTable | @xmtp/react-sdk

Type alias CachedMessagesTable

CachedMessagesTable: Table<CachedMessage, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedMessagesTable

CachedMessagesTable: Table<CachedMessage, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedReaction.html b/types/CachedReaction.html index 6048a61d..223951ac 100644 --- a/types/CachedReaction.html +++ b/types/CachedReaction.html @@ -1 +1 @@ -CachedReaction | @xmtp/react-sdk

Type alias CachedReaction

CachedReaction: {
    content: Reaction["content"];
    id?: number;
    referenceXmtpID: Reaction["reference"];
    schema: Reaction["schema"];
    senderAddress: string;
    sentAt: Date;
    xmtpID: string;
}

Type declaration

  • content: Reaction["content"]
  • Optional id?: number
  • referenceXmtpID: Reaction["reference"]
  • schema: Reaction["schema"]
  • senderAddress: string
  • sentAt: Date
  • xmtpID: string

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedReaction

CachedReaction: {
    content: Reaction["content"];
    id?: number;
    referenceXmtpID: Reaction["reference"];
    schema: Reaction["schema"];
    senderAddress: string;
    sentAt: Date;
    xmtpID: string;
}

Type declaration

  • content: Reaction["content"]
  • Optional id?: number
  • referenceXmtpID: Reaction["reference"]
  • schema: Reaction["schema"]
  • senderAddress: string
  • sentAt: Date
  • xmtpID: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedReactionsMetadata.html b/types/CachedReactionsMetadata.html index b7665858..a69fabfa 100644 --- a/types/CachedReactionsMetadata.html +++ b/types/CachedReactionsMetadata.html @@ -1 +1 @@ -CachedReactionsMetadata | @xmtp/react-sdk

Type alias CachedReactionsMetadata

CachedReactionsMetadata: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedReactionsMetadata

CachedReactionsMetadata: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/CachedReactionsTable.html b/types/CachedReactionsTable.html index 3f9d0883..8a79d07d 100644 --- a/types/CachedReactionsTable.html +++ b/types/CachedReactionsTable.html @@ -1 +1 @@ -CachedReactionsTable | @xmtp/react-sdk

Type alias CachedReactionsTable

CachedReactionsTable: Table<CachedReaction, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias CachedReactionsTable

CachedReactionsTable: Table<CachedReaction, number>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeConfiguration.html b/types/ContentTypeConfiguration.html index 23c82bfd..d8e48875 100644 --- a/types/ContentTypeConfiguration.html +++ b/types/ContentTypeConfiguration.html @@ -1 +1 @@ -ContentTypeConfiguration | @xmtp/react-sdk

Type alias ContentTypeConfiguration

ContentTypeConfiguration: {
    codecs: ContentCodec<any>[];
    contentTypes: string[];
    namespace: string;
    processors?: ContentTypeMessageProcessors;
    schema?: Record<string, string>;
    validators?: ContentTypeMessageValidators;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeConfiguration

ContentTypeConfiguration: {
    codecs: ContentCodec<any>[];
    contentTypes: string[];
    namespace: string;
    processors?: ContentTypeMessageProcessors;
    schema?: Record<string, string>;
    validators?: ContentTypeMessageValidators;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMessageProcessor.html b/types/ContentTypeMessageProcessor.html index 25109482..1edd9421 100644 --- a/types/ContentTypeMessageProcessor.html +++ b/types/ContentTypeMessageProcessor.html @@ -1 +1 @@ -ContentTypeMessageProcessor | @xmtp/react-sdk

Type alias ContentTypeMessageProcessor<C>

ContentTypeMessageProcessor<C>: ((options) => void | Promise<void>)

Type Parameters

  • C = any

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMessageProcessor<C>

ContentTypeMessageProcessor<C>: ((options) => void | Promise<void>)

Type Parameters

  • C = any

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMessageProcessors.html b/types/ContentTypeMessageProcessors.html index 8ca2031b..10fa12b7 100644 --- a/types/ContentTypeMessageProcessors.html +++ b/types/ContentTypeMessageProcessors.html @@ -1 +1 @@ -ContentTypeMessageProcessors | @xmtp/react-sdk

Type alias ContentTypeMessageProcessors

ContentTypeMessageProcessors: {
    [contentType: string]: ContentTypeMessageProcessor[];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMessageProcessors

ContentTypeMessageProcessors: {
    [contentType: string]: ContentTypeMessageProcessor[];
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMessageValidators.html b/types/ContentTypeMessageValidators.html index 6b5f2621..e730a06a 100644 --- a/types/ContentTypeMessageValidators.html +++ b/types/ContentTypeMessageValidators.html @@ -1 +1 @@ -ContentTypeMessageValidators | @xmtp/react-sdk

Type alias ContentTypeMessageValidators

ContentTypeMessageValidators: Record<string, ((content) => boolean)>

Type declaration

    • (content): boolean

    • Parameters

      • content: unknown

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMessageValidators

ContentTypeMessageValidators: Record<string, ((content) => boolean)>

Type declaration

    • (content): boolean

    • Parameters

      • content: unknown

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMetadata.html b/types/ContentTypeMetadata.html index 7d233e37..2ff42005 100644 --- a/types/ContentTypeMetadata.html +++ b/types/ContentTypeMetadata.html @@ -1 +1 @@ -ContentTypeMetadata | @xmtp/react-sdk

Type alias ContentTypeMetadata

ContentTypeMetadata: {
    [namespace: string]: ContentTypeMetadataValues;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMetadata

ContentTypeMetadata: {
    [namespace: string]: ContentTypeMetadataValues;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMetadataValue.html b/types/ContentTypeMetadataValue.html index 7971eba4..cd0ebc00 100644 --- a/types/ContentTypeMetadataValue.html +++ b/types/ContentTypeMetadataValue.html @@ -1 +1 @@ -ContentTypeMetadataValue | @xmtp/react-sdk

Type alias ContentTypeMetadataValue

ContentTypeMetadataValue: string | string[] | number | number[] | boolean | boolean[] | null | Uint8Array

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMetadataValue

ContentTypeMetadataValue: string | string[] | number | number[] | boolean | boolean[] | null | Uint8Array

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ContentTypeMetadataValues.html b/types/ContentTypeMetadataValues.html index 4993161a..24c7bee0 100644 --- a/types/ContentTypeMetadataValues.html +++ b/types/ContentTypeMetadataValues.html @@ -1 +1 @@ -ContentTypeMetadataValues | @xmtp/react-sdk

Type alias ContentTypeMetadataValues

ContentTypeMetadataValues: ContentTypeMetadataValue | Record<string, ContentTypeMetadataValue>

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Type alias ContentTypeMetadataValues

ContentTypeMetadataValues: ContentTypeMetadataValue | Record<string, ContentTypeMetadataValue>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/ProcessUnprocessedMessagesOptions.html b/types/ProcessUnprocessedMessagesOptions.html index bbcc1c69..fcf5ac39 100644 --- a/types/ProcessUnprocessedMessagesOptions.html +++ b/types/ProcessUnprocessedMessagesOptions.html @@ -1,3 +1,3 @@ ProcessUnprocessedMessagesOptions | @xmtp/react-sdk

Type alias ProcessUnprocessedMessagesOptions

ProcessUnprocessedMessagesOptions: Omit<ProcessMessageOptions, "conversation" | "message" | "client"> & Pick<Required<ProcessMessageOptions>, "client"> & {
    reprocess?: typeof reprocessMessage;
}

Type declaration

  • Optional reprocess?: typeof reprocessMessage

    This is a convenience option to override the default reprocessMessage for testing purposes and should not be used in production.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/attachmentContentTypeConfig.html b/variables/attachmentContentTypeConfig.html index 486544b6..f5b29caa 100644 --- a/variables/attachmentContentTypeConfig.html +++ b/variables/attachmentContentTypeConfig.html @@ -1 +1 @@ -attachmentContentTypeConfig | @xmtp/react-sdk

Variable attachmentContentTypeConfigConst

attachmentContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable attachmentContentTypeConfigConst

attachmentContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/reactionContentTypeConfig.html b/variables/reactionContentTypeConfig.html index cd683bab..8e1593ef 100644 --- a/variables/reactionContentTypeConfig.html +++ b/variables/reactionContentTypeConfig.html @@ -1 +1 @@ -reactionContentTypeConfig | @xmtp/react-sdk

Variable reactionContentTypeConfigConst

reactionContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable reactionContentTypeConfigConst

reactionContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/replyContentTypeConfig.html b/variables/replyContentTypeConfig.html index c7488ce3..7cc5f05a 100644 --- a/variables/replyContentTypeConfig.html +++ b/variables/replyContentTypeConfig.html @@ -1 +1 @@ -replyContentTypeConfig | @xmtp/react-sdk

Variable replyContentTypeConfigConst

replyContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable replyContentTypeConfigConst

replyContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/textContentTypeConfig.html b/variables/textContentTypeConfig.html index 34aefbdc..adb9efc2 100644 --- a/variables/textContentTypeConfig.html +++ b/variables/textContentTypeConfig.html @@ -1 +1 @@ -textContentTypeConfig | @xmtp/react-sdk

Variable textContentTypeConfigConst

textContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Variable textContentTypeConfigConst

textContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file