From 8eea703c04888efcc3c3c68944b9004b83e17fa2 Mon Sep 17 00:00:00 2001 From: rygine Date: Thu, 17 Oct 2024 21:49:50 +0000 Subject: [PATCH] deploy: 5a8bd3c7878e8f221e7556320aa88f32d3cacfff --- functions/XMTPProvider.html | 2 +- functions/bulkPutConsentState.html | 2 +- functions/clearCache.html | 2 +- functions/deleteMessage.html | 2 +- functions/getAttachment.html | 2 +- functions/getCachedConsentEntries.html | 2 +- functions/getCachedConsentEntriesMap.html | 2 +- functions/getCachedConsentEntry.html | 2 +- functions/getCachedConsentState.html | 2 +- functions/getCachedConversationByPeerAddress.html | 2 +- functions/getCachedConversationByTopic.html | 2 +- functions/getConversationByTopic.html | 2 +- functions/getDbInstance.html | 2 +- functions/getLastMessage.html | 2 +- functions/getMessageByXmtpID.html | 2 +- functions/getOriginalMessageFromReply.html | 2 +- functions/getReactionsByXmtpID.html | 2 +- functions/getReplies.html | 2 +- functions/hasConversationTopic.html | 2 +- functions/hasReaction.html | 2 +- functions/hasReply.html | 2 +- functions/isValidAddress.html | 2 +- functions/loadConsentListFromCache.html | 2 +- functions/putConsentState.html | 2 +- functions/saveConversation.html | 2 +- functions/saveMessage.html | 2 +- functions/setConversationUpdatedAt.html | 2 +- functions/toCachedConversation.html | 2 +- functions/toCachedMessage.html | 2 +- functions/updateConversation.html | 2 +- functions/updateConversationMetadata.html | 2 +- functions/updateMessage.html | 2 +- functions/updateMessageMetadata.html | 2 +- functions/useAttachment.html | 2 +- functions/useCanMessage.html | 2 +- functions/useClient.html | 2 +- functions/useConsent.html | 2 +- functions/useConversation.html | 2 +- functions/useConversations.html | 2 +- functions/useDb.html | 2 +- functions/useLastMessage.html | 2 +- functions/useMessage.html | 2 +- functions/useMessages.html | 2 +- functions/useReactions.html | 2 +- functions/useReplies.html | 2 +- functions/useReply.html | 2 +- functions/useResendMessage.html | 2 +- functions/useSendMessage.html | 2 +- functions/useStartConversation.html | 2 +- functions/useStreamAllMessages.html | 2 +- functions/useStreamConsentList.html | 2 +- functions/useStreamConversations.html | 2 +- functions/useStreamMessages.html | 2 +- types/CachedConsentEntry.html | 2 +- types/CachedConsentEntryMap.html | 2 +- types/CachedConsentTable.html | 2 +- types/CachedConversation.html | 2 +- types/CachedConversationsTable.html | 2 +- types/CachedMessage.html | 2 +- types/CachedMessagesTable.html | 2 +- types/CachedReaction.html | 2 +- types/CachedReactionsMetadata.html | 2 +- types/CachedReactionsTable.html | 2 +- types/ContentTypeConfiguration.html | 2 +- types/ContentTypeMessageProcessor.html | 2 +- types/ContentTypeMessageProcessors.html | 2 +- types/ContentTypeMessageValidators.html | 2 +- types/ContentTypeMetadata.html | 2 +- types/ContentTypeMetadataValue.html | 2 +- types/ContentTypeMetadataValues.html | 2 +- types/ProcessUnprocessedMessagesOptions.html | 2 +- variables/attachmentContentTypeConfig.html | 2 +- variables/reactionContentTypeConfig.html | 2 +- variables/replyContentTypeConfig.html | 2 +- variables/textContentTypeConfig.html | 2 +- 75 files changed, 75 insertions(+), 75 deletions(-) diff --git a/functions/XMTPProvider.html b/functions/XMTPProvider.html index 73059446..6c833619 100644 --- a/functions/XMTPProvider.html +++ b/functions/XMTPProvider.html @@ -1,2 +1,2 @@ XMTPProvider | @xmtp/react-sdk

Function XMTPProvider

Settings

Member Visibility
+

Returns ReactNode

Settings

Member Visibility
diff --git a/functions/bulkPutConsentState.html b/functions/bulkPutConsentState.html index ed6075f1..f1a8cc2d 100644 --- a/functions/bulkPutConsentState.html +++ b/functions/bulkPutConsentState.html @@ -1,2 +1,2 @@ bulkPutConsentState | @xmtp/react-sdk

Function bulkPutConsentState

Add or update multiple consent states

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/clearCache.html b/functions/clearCache.html index 558f778a..2afe8829 100644 --- a/functions/clearCache.html +++ b/functions/clearCache.html @@ -1 +1 @@ -clearCache | @xmtp/react-sdk

Function clearCache

Settings

Member Visibility
+clearCache | @xmtp/react-sdk

Function clearCache

Settings

Member Visibility
diff --git a/functions/deleteMessage.html b/functions/deleteMessage.html index 8fc5898f..b1d2d80b 100644 --- a/functions/deleteMessage.html +++ b/functions/deleteMessage.html @@ -1,2 +1,2 @@ deleteMessage | @xmtp/react-sdk

Function deleteMessage

Remove a message from the cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getAttachment.html b/functions/getAttachment.html index 76be2ab8..9793a2d8 100644 --- a/functions/getAttachment.html +++ b/functions/getAttachment.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConsentEntries.html b/functions/getCachedConsentEntries.html index fa29604a..2e7ad69a 100644 --- a/functions/getCachedConsentEntries.html +++ b/functions/getCachedConsentEntries.html @@ -1,3 +1,3 @@ getCachedConsentEntries | @xmtp/react-sdk

Function getCachedConsentEntries

Retrieve all cached consent entries for a given wallet address

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConsentEntriesMap.html b/functions/getCachedConsentEntriesMap.html index cf8c722a..3cba346e 100644 --- a/functions/getCachedConsentEntriesMap.html +++ b/functions/getCachedConsentEntriesMap.html @@ -1,3 +1,3 @@ getCachedConsentEntriesMap | @xmtp/react-sdk

Function getCachedConsentEntriesMap

Retrieve all cached consent entries as an object mapping

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConsentEntry.html b/functions/getCachedConsentEntry.html index d864039b..0f9a29ad 100644 --- a/functions/getCachedConsentEntry.html +++ b/functions/getCachedConsentEntry.html @@ -1,3 +1,3 @@ getCachedConsentEntry | @xmtp/react-sdk

Function getCachedConsentEntry

Retrieve a cached consent entry by wallet address, type, and value

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConsentState.html b/functions/getCachedConsentState.html index a49d6446..db8d1a65 100644 --- a/functions/getCachedConsentState.html +++ b/functions/getCachedConsentState.html @@ -1,3 +1,3 @@ getCachedConsentState | @xmtp/react-sdk

Function getCachedConsentState

Retrieve a cached consent state by wallet address, type, and value

  • getCachedConsentState(walletAddress, type, value, db): Promise<ConsentState>

  • Parameters

    • walletAddress: string
    • type: ConsentListEntryType
    • value: string
    • db: Dexie

    Returns Promise<ConsentState>

    The cached consent state if found, otherwise undefined

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConversationByPeerAddress.html b/functions/getCachedConversationByPeerAddress.html index f178f752..964adc59 100644 --- a/functions/getCachedConversationByPeerAddress.html +++ b/functions/getCachedConversationByPeerAddress.html @@ -1,3 +1,3 @@ getCachedConversationByPeerAddress | @xmtp/react-sdk

Function getCachedConversationByPeerAddress

Retrieve a cached conversation by peer address

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getCachedConversationByTopic.html b/functions/getCachedConversationByTopic.html index ccddbbab..012c01ce 100644 --- a/functions/getCachedConversationByTopic.html +++ b/functions/getCachedConversationByTopic.html @@ -1,3 +1,3 @@ getCachedConversationByTopic | @xmtp/react-sdk

Function getCachedConversationByTopic

Retrieve a cached conversation by topic

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getConversationByTopic.html b/functions/getConversationByTopic.html index 9834d206..493db219 100644 --- a/functions/getConversationByTopic.html +++ b/functions/getConversationByTopic.html @@ -1,3 +1,3 @@ getConversationByTopic | @xmtp/react-sdk

Function getConversationByTopic

Retrieve a conversation from the XMTP client by a topic

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getDbInstance.html b/functions/getDbInstance.html index ff0f74d7..85722df6 100644 --- a/functions/getDbInstance.html +++ b/functions/getDbInstance.html @@ -1,2 +1,2 @@ getDbInstance | @xmtp/react-sdk

Function getDbInstance

Get a new DB instance using the passed options

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getLastMessage.html b/functions/getLastMessage.html index 37bdf872..af8113f2 100644 --- a/functions/getLastMessage.html +++ b/functions/getLastMessage.html @@ -1,2 +1,2 @@ getLastMessage | @xmtp/react-sdk

Function getLastMessage

Retrieve the last message of conversation in the cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getMessageByXmtpID.html b/functions/getMessageByXmtpID.html index ca9d75a5..da9a6231 100644 --- a/functions/getMessageByXmtpID.html +++ b/functions/getMessageByXmtpID.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getOriginalMessageFromReply.html b/functions/getOriginalMessageFromReply.html index f1db7db4..dcbf829e 100644 --- a/functions/getOriginalMessageFromReply.html +++ b/functions/getOriginalMessageFromReply.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getReactionsByXmtpID.html b/functions/getReactionsByXmtpID.html index 7b93851e..f9220f34 100644 --- a/functions/getReactionsByXmtpID.html +++ b/functions/getReactionsByXmtpID.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getReplies.html b/functions/getReplies.html index 82106145..4982ca6a 100644 --- a/functions/getReplies.html +++ b/functions/getReplies.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/hasConversationTopic.html b/functions/hasConversationTopic.html index e6915348..818a6d77 100644 --- a/functions/hasConversationTopic.html +++ b/functions/hasConversationTopic.html @@ -1,2 +1,2 @@ hasConversationTopic | @xmtp/react-sdk

Function hasConversationTopic

Check to see if a topic exists in the conversations cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/hasReaction.html b/functions/hasReaction.html index 84bd11e1..de9bfdfb 100644 --- a/functions/hasReaction.html +++ b/functions/hasReaction.html @@ -1,4 +1,4 @@ hasReaction | @xmtp/react-sdk

Function hasReaction

Check if a cached message has a reaction

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/hasReply.html b/functions/hasReply.html index c6bc3714..b84bde85 100644 --- a/functions/hasReply.html +++ b/functions/hasReply.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/isValidAddress.html b/functions/isValidAddress.html index 2b36d535..533773fe 100644 --- a/functions/isValidAddress.html +++ b/functions/isValidAddress.html @@ -1,4 +1,4 @@ isValidAddress | @xmtp/react-sdk

Function isValidAddress

Check if a wallet address is valid.

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/loadConsentListFromCache.html b/functions/loadConsentListFromCache.html index 3164df93..f6117aa2 100644 --- a/functions/loadConsentListFromCache.html +++ b/functions/loadConsentListFromCache.html @@ -1,2 +1,2 @@ loadConsentListFromCache | @xmtp/react-sdk

Function loadConsentListFromCache

Load the cached consent list entries into the XMTP client

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/putConsentState.html b/functions/putConsentState.html index 0a3e1f42..a15caafb 100644 --- a/functions/putConsentState.html +++ b/functions/putConsentState.html @@ -1,2 +1,2 @@ putConsentState | @xmtp/react-sdk

Function putConsentState

Add or update a consent state

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/saveConversation.html b/functions/saveConversation.html index ff22b3f6..b02c2875 100644 --- a/functions/saveConversation.html +++ b/functions/saveConversation.html @@ -1,3 +1,3 @@ saveConversation | @xmtp/react-sdk

Function saveConversation

Save a conversation to the cache

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/saveMessage.html b/functions/saveMessage.html index 2c1c0144..20288d9f 100644 --- a/functions/saveMessage.html +++ b/functions/saveMessage.html @@ -1,3 +1,3 @@ saveMessage | @xmtp/react-sdk

Function saveMessage

Save a message to the cache

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/setConversationUpdatedAt.html b/functions/setConversationUpdatedAt.html index a13dd4a7..3a1ed007 100644 --- a/functions/setConversationUpdatedAt.html +++ b/functions/setConversationUpdatedAt.html @@ -1,2 +1,2 @@ setConversationUpdatedAt | @xmtp/react-sdk

Function setConversationUpdatedAt

Sets the updatedAt field of a cached conversation

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/toCachedConversation.html b/functions/toCachedConversation.html index f28cac92..3b29cc58 100644 --- a/functions/toCachedConversation.html +++ b/functions/toCachedConversation.html @@ -1,3 +1,3 @@ toCachedConversation | @xmtp/react-sdk

Function toCachedConversation

Converts a Conversation from the XMTP network to its cached format

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

  • Parameters

    • conversation: Conversation<any>
    • walletAddress: string

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

    The conversation in cached format

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/toCachedMessage.html b/functions/toCachedMessage.html index 627edb30..41ce5eaf 100644 --- a/functions/toCachedMessage.html +++ b/functions/toCachedMessage.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/updateConversation.html b/functions/updateConversation.html index f24709fc..a6c0d2b6 100644 --- a/functions/updateConversation.html +++ b/functions/updateConversation.html @@ -1,2 +1,2 @@ updateConversation | @xmtp/react-sdk

Function updateConversation

Update properties of a cached conversation

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/updateConversationMetadata.html b/functions/updateConversationMetadata.html index b6452144..6c549ac4 100644 --- a/functions/updateConversationMetadata.html +++ b/functions/updateConversationMetadata.html @@ -1,3 +1,3 @@ updateConversationMetadata | @xmtp/react-sdk

Function updateConversationMetadata

Update metadata of a cached conversation using the specified namespace

This is not meant to be called directly

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/updateMessage.html b/functions/updateMessage.html index ecaaf734..1f66d290 100644 --- a/functions/updateMessage.html +++ b/functions/updateMessage.html @@ -1,2 +1,2 @@ updateMessage | @xmtp/react-sdk

Function updateMessage

Update properties of a cached message

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

  • Parameters

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/updateMessageMetadata.html b/functions/updateMessageMetadata.html index 50ccba79..92b6bda8 100644 --- a/functions/updateMessageMetadata.html +++ b/functions/updateMessageMetadata.html @@ -1,3 +1,3 @@ updateMessageMetadata | @xmtp/react-sdk

Function updateMessageMetadata

Update metadata of a cached message using the specified namespace

This is not meant to be called directly

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

  • Parameters

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useAttachment.html b/functions/useAttachment.html index fd2e160d..d43d560d 100644 --- a/functions/useAttachment.html +++ b/functions/useAttachment.html @@ -1,2 +1,2 @@ useAttachment | @xmtp/react-sdk

Function useAttachment

This hook returns the attachment data of a cached message

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

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

Settings

Member Visibility
diff --git a/functions/useCanMessage.html b/functions/useCanMessage.html index d6268bd9..6b466617 100644 --- a/functions/useCanMessage.html +++ b/functions/useCanMessage.html @@ -1,3 +1,3 @@ useCanMessage | @xmtp/react-sdk

Function useCanMessage

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

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

  • Parameters

    • OptionalonError: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

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

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

        • Type Parameters

          • T extends string | string[]

          Parameters

          • peerAddress: T

          Returns Promise<CanMessageReturns<T>>

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

        • Type Parameters

          • T extends string | string[]

          Parameters

          • peerAddress: T
          • Optionaloptions: Partial<NetworkOptions>

          Returns Promise<CanMessageReturns<T>>

    • error: null | Error
    • isLoading: boolean

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useClient.html b/functions/useClient.html index 6bb70917..9cb9111a 100644 --- a/functions/useClient.html +++ b/functions/useClient.html @@ -1,3 +1,3 @@ useClient | @xmtp/react-sdk

Function useClient

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

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

  • Parameters

    • OptionalonError: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

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

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

        • Returns Promise<void>

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

        • Parameters

          • __namedParameters: InitializeClientOptions

          Returns Promise<undefined | Client<any>>

    • isLoading: boolean

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useConsent.html b/functions/useConsent.html index c129883e..a79e7174 100644 --- a/functions/useConsent.html +++ b/functions/useConsent.html @@ -1,2 +1,2 @@ useConsent | @xmtp/react-sdk

Function useConsent

This hook returns helper functions for working with consent

-
  • useConsent(): {
        allow: ((addresses: string[], skipPublish?: boolean) => Promise<void>);
        consentState: ((address: string) => Promise<ConsentState>);
        deny: ((addresses: string[], skipPublish?: boolean) => Promise<void>);
        entries: Partial<CachedConsentEntryMap>;
        isAllowed: ((address: string) => Promise<boolean>);
        isDenied: ((address: string) => Promise<boolean>);
        loadConsentList: ((startTime?: Date) => Promise<Map<string, ConsentState>>);
        refreshConsentList: (() => Promise<Map<string, ConsentState>>);
    }

  • Returns {
        allow: ((addresses: string[], skipPublish?: boolean) => Promise<void>);
        consentState: ((address: string) => Promise<ConsentState>);
        deny: ((addresses: string[], skipPublish?: boolean) => Promise<void>);
        entries: Partial<CachedConsentEntryMap>;
        isAllowed: ((address: string) => Promise<boolean>);
        isDenied: ((address: string) => Promise<boolean>);
        loadConsentList: ((startTime?: Date) => Promise<Map<string, ConsentState>>);
        refreshConsentList: (() => Promise<Map<string, ConsentState>>);
    }

    • allow: ((addresses: string[], skipPublish?: boolean) => Promise<void>)
        • (addresses, skipPublish?): Promise<void>

        • Parameters

          • addresses: string[]
          • skipPublish: boolean = false

          Returns Promise<void>

    • consentState: ((address: string) => Promise<ConsentState>)
        • (address): Promise<ConsentState>

        • Parameters

          • address: string

          Returns Promise<ConsentState>

    • deny: ((addresses: string[], skipPublish?: boolean) => Promise<void>)
        • (addresses, skipPublish?): Promise<void>

        • Parameters

          • addresses: string[]
          • skipPublish: boolean = false

          Returns Promise<void>

    • entries: Partial<CachedConsentEntryMap>
    • isAllowed: ((address: string) => Promise<boolean>)
        • (address): Promise<boolean>

        • Parameters

          • address: string

          Returns Promise<boolean>

    • isDenied: ((address: string) => Promise<boolean>)
        • (address): Promise<boolean>

        • Parameters

          • address: string

          Returns Promise<boolean>

    • loadConsentList: ((startTime?: Date) => Promise<Map<string, ConsentState>>)
        • (startTime?): Promise<Map<string, ConsentState>>

        • Parameters

          • OptionalstartTime: Date

          Returns Promise<Map<string, ConsentState>>

    • refreshConsentList: (() => Promise<Map<string, ConsentState>>)
        • (): Promise<Map<string, ConsentState>>

        • Returns Promise<Map<string, ConsentState>>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useConversation.html b/functions/useConversation.html index 103b18b7..cff3d8ba 100644 --- a/functions/useConversation.html +++ b/functions/useConversation.html @@ -1,3 +1,3 @@ useConversation | @xmtp/react-sdk

Function useConversation

This hook returns helper functions for working with conversations in the local cache.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useConversations.html b/functions/useConversations.html index 63e444cd..ed2edbfe 100644 --- a/functions/useConversations.html +++ b/functions/useConversations.html @@ -1,3 +1,3 @@ useConversations | @xmtp/react-sdk

Function useConversations

This hook fetches all conversations with the current wallet on mount. It also exposes error and loading states.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useDb.html b/functions/useDb.html index 86d8598f..593a5092 100644 --- a/functions/useDb.html +++ b/functions/useDb.html @@ -1,3 +1,3 @@ useDb | @xmtp/react-sdk

Function useDb

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

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

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

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

        • Returns Promise<void>

    • getDbInstance: (() => Promise<Dexie>)
        • (): Promise<Dexie>

        • Returns Promise<Dexie>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useLastMessage.html b/functions/useLastMessage.html index bbcf2941..638cc37e 100644 --- a/functions/useLastMessage.html +++ b/functions/useLastMessage.html @@ -1,2 +1,2 @@ useLastMessage | @xmtp/react-sdk

Function useLastMessage

This hook returns the last message from a conversation from the local cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useMessage.html b/functions/useMessage.html index 87ab2b85..7a6dace5 100644 --- a/functions/useMessage.html +++ b/functions/useMessage.html @@ -1,3 +1,3 @@ useMessage | @xmtp/react-sdk

Function useMessage

This hook wraps helper functions to include the client, DB instance, and other values for easier consumption.

-
  • useMessage(): {
        deleteMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>]) => Promise<void>);
        getMessageByXmtpID: ((...args: [id: string]) => Promise<undefined | CachedMessage<any, ContentTypeMetadata>>);
        processMessage: ((conversation: CachedConversation, message: CachedMessage<any, ContentTypeMetadata>) => Promise<{
            message: CachedMessage<any, ContentTypeMetadata>;
            status: ProcessStatus;
        }>);
        resendMessage: ((message: CachedMessage) => Promise<DecodedMessage<any>>);
        sendMessage: ((conversation: CachedConversation, content: any, contentType?: ContentTypeId, options?: SendMessageOptions) => Promise<{
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            sentMessage: DecodedMessage<any>;
        } | {
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            sentMessage: undefined;
        }>);
        updateMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>, update: Partial<Pick<CachedMessage<any, ContentTypeMetadata>,
            | "metadata"
            | "id"
            | "status"
            | "isSending"
            | "sentAt"
            | "hasLoadError"
            | "hasSendError"
            | "sendOptions">>]) => Promise<{
            content: any;
            contentBytes?: Uint8Array;
            contentFallback?: string;
            contentType: string;
            conversationTopic: string;
            hasLoadError: boolean;
            hasSendError: boolean;
            id: string;
            isSending: boolean;
            metadata?: ContentTypeMetadata;
            sendOptions?: SendOptions;
            senderAddress: string;
            sentAt: Date;
            status: "unprocessed" | "processed";
            uuid: string;
            walletAddress: string;
        }>);
    }

  • Returns {
        deleteMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>]) => Promise<void>);
        getMessageByXmtpID: ((...args: [id: string]) => Promise<undefined | CachedMessage<any, ContentTypeMetadata>>);
        processMessage: ((conversation: CachedConversation, message: CachedMessage<any, ContentTypeMetadata>) => Promise<{
            message: CachedMessage<any, ContentTypeMetadata>;
            status: ProcessStatus;
        }>);
        resendMessage: ((message: CachedMessage) => Promise<DecodedMessage<any>>);
        sendMessage: ((conversation: CachedConversation, content: any, contentType?: ContentTypeId, options?: SendMessageOptions) => Promise<{
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            sentMessage: DecodedMessage<any>;
        } | {
            cachedMessage: CachedMessage<any, ContentTypeMetadata>;
            sentMessage: undefined;
        }>);
        updateMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>, update: Partial<Pick<CachedMessage<any, ContentTypeMetadata>,
            | "metadata"
            | "id"
            | "status"
            | "isSending"
            | "sentAt"
            | "hasLoadError"
            | "hasSendError"
            | "sendOptions">>]) => Promise<{
            content: any;
            contentBytes?: Uint8Array;
            contentFallback?: string;
            contentType: string;
            conversationTopic: string;
            hasLoadError: boolean;
            hasSendError: boolean;
            id: string;
            isSending: boolean;
            metadata?: ContentTypeMetadata;
            sendOptions?: SendOptions;
            senderAddress: string;
            sentAt: Date;
            status: "unprocessed" | "processed";
            uuid: string;
            walletAddress: string;
        }>);
    }

    • deleteMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>]) => Promise<void>)
    • getMessageByXmtpID: ((...args: [id: string]) => Promise<undefined | CachedMessage<any, ContentTypeMetadata>>)
    • processMessage: ((conversation: CachedConversation, message: CachedMessage<any, ContentTypeMetadata>) => Promise<{
          message: CachedMessage<any, ContentTypeMetadata>;
          status: ProcessStatus;
      }>)
    • resendMessage: ((message: CachedMessage) => Promise<DecodedMessage<any>>)
        • (message): Promise<DecodedMessage<any>>

        • Parameters

          Returns Promise<DecodedMessage<any>>

    • sendMessage: ((conversation: CachedConversation, content: any, contentType?: ContentTypeId, options?: SendMessageOptions) => Promise<{
          cachedMessage: CachedMessage<any, ContentTypeMetadata>;
          sentMessage: DecodedMessage<any>;
      } | {
          cachedMessage: CachedMessage<any, ContentTypeMetadata>;
          sentMessage: undefined;
      }>)
    • updateMessage: ((...args: [message: CachedMessage<any, ContentTypeMetadata>, update: Partial<Pick<CachedMessage<any, ContentTypeMetadata>,
          | "metadata"
          | "id"
          | "status"
          | "isSending"
          | "sentAt"
          | "hasLoadError"
          | "hasSendError"
          | "sendOptions">>]) => Promise<{
          content: any;
          contentBytes?: Uint8Array;
          contentFallback?: string;
          contentType: string;
          conversationTopic: string;
          hasLoadError: boolean;
          hasSendError: boolean;
          id: string;
          isSending: boolean;
          metadata?: ContentTypeMetadata;
          sendOptions?: SendOptions;
          senderAddress: string;
          sentAt: Date;
          status: "unprocessed" | "processed";
          uuid: string;
          walletAddress: string;
      }>)
        • (...args): Promise<{
              content: any;
              contentBytes?: Uint8Array;
              contentFallback?: string;
              contentType: string;
              conversationTopic: string;
              hasLoadError: boolean;
              hasSendError: boolean;
              id: string;
              isSending: boolean;
              metadata?: ContentTypeMetadata;
              sendOptions?: SendOptions;
              senderAddress: string;
              sentAt: Date;
              status: "unprocessed" | "processed";
              uuid: string;
              walletAddress: string;
          }>

        • Parameters

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useMessages.html b/functions/useMessages.html index ec1e80d3..21e0c28e 100644 --- a/functions/useMessages.html +++ b/functions/useMessages.html @@ -1,4 +1,4 @@ useMessages | @xmtp/react-sdk

Function useMessages

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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useReactions.html b/functions/useReactions.html index 11110040..625a272b 100644 --- a/functions/useReactions.html +++ b/functions/useReactions.html @@ -1,2 +1,2 @@ useReactions | @xmtp/react-sdk

Function useReactions

This hook returns cached reactions to a message from the local cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useReplies.html b/functions/useReplies.html index ea7568db..3c313d62 100644 --- a/functions/useReplies.html +++ b/functions/useReplies.html @@ -1,2 +1,2 @@ useReplies | @xmtp/react-sdk

Function useReplies

This hook returns cached replies to a message from the local cache

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useReply.html b/functions/useReply.html index aeb52b7d..a9ac5a64 100644 --- a/functions/useReply.html +++ b/functions/useReply.html @@ -1,2 +1,2 @@ useReply | @xmtp/react-sdk

Function useReply

This hook returns the original message of a cached reply

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useResendMessage.html b/functions/useResendMessage.html index 02f7b656..dcd84417 100644 --- a/functions/useResendMessage.html +++ b/functions/useResendMessage.html @@ -1,2 +1,2 @@ useResendMessage | @xmtp/react-sdk

Function useResendMessage

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

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

  • Parameters

    • Optionaloptions: UseSendMessageOptions

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

    • cancel: ((message: CachedMessage) => Promise<void>)
        • (message): Promise<void>

        • Parameters

          Returns Promise<void>

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

        • Parameters

          Returns Promise<DecodedMessage<any>>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useSendMessage.html b/functions/useSendMessage.html index b0251d92..79d97758 100644 --- a/functions/useSendMessage.html +++ b/functions/useSendMessage.html @@ -1,2 +1,2 @@ useSendMessage | @xmtp/react-sdk

Function useSendMessage

This hook sends a new message into a conversation

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

  • Parameters

    • Optionaloptions: UseSendMessageOptions

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

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

        • Type Parameters

          • T = string

          Parameters

          • conversation: CachedConversation
          • content: T
          • OptionalcontentType: ContentTypeId
          • OptionalsendOptions: Omit<SendOptions, "contentType">

          Returns Promise<undefined | DecodedMessage<any>>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useStartConversation.html b/functions/useStartConversation.html index ac88f5aa..db91d055 100644 --- a/functions/useStartConversation.html +++ b/functions/useStartConversation.html @@ -1,2 +1,2 @@ useStartConversation | @xmtp/react-sdk

Function useStartConversation

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

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

  • Parameters

    • Optionaloptions: UseStartConversation

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

    • error: null | Error
    • isLoading: boolean
    • startConversation: (<T>(peerAddress: string, content: T, contentType?: ContentTypeId, sendOptions?: SendMessageOptions) => Promise<
          | {
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: undefined;
          }
          | {
              cachedConversation: undefined;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          }
          | {
              cachedConversation: CachedConversation<ContentTypeMetadata>;
              cachedMessage: undefined;
              conversation: Conversation<any>;
          }
          | {
              cachedConversation: CachedConversation<ContentTypeMetadata>;
              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: CachedConversation<ContentTypeMetadata>;
                  cachedMessage: undefined;
                  conversation: Conversation<any>;
              }
              | {
                  cachedConversation: CachedConversation<ContentTypeMetadata>;
                  cachedMessage: CachedMessage<any, ContentTypeMetadata>;
                  conversation: Conversation<any>;
              }>

        • Type Parameters

          • T = string

          Parameters

          • peerAddress: string
          • content: T
          • OptionalcontentType: ContentTypeId
          • OptionalsendOptions: SendMessageOptions

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

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useStreamAllMessages.html b/functions/useStreamAllMessages.html index 46565429..d5da75f3 100644 --- a/functions/useStreamAllMessages.html +++ b/functions/useStreamAllMessages.html @@ -1,3 +1,3 @@ useStreamAllMessages | @xmtp/react-sdk

Function useStreamAllMessages

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

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

  • Parameters

    • OptionalonMessage: ((message: DecodedMessage<any>) => void | Promise<void>)
        • (message): void | Promise<void>

        • Parameters

          • message: DecodedMessage<any>

          Returns void | Promise<void>

    • OptionalonError: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useStreamConsentList.html b/functions/useStreamConsentList.html index 50f4ffd6..a2c5457e 100644 --- a/functions/useStreamConsentList.html +++ b/functions/useStreamConsentList.html @@ -1,3 +1,3 @@ useStreamConsentList | @xmtp/react-sdk

Function useStreamConsentList

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

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

  • Parameters

    • OptionalonAction: ((action: PrivatePreferencesAction) => void | Promise<void>)
        • (action): void | Promise<void>

        • Parameters

          • action: PrivatePreferencesAction

          Returns void | Promise<void>

    • OptionalonError: ((error: Error) => void)
        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns {
        error: null | Error;
    }

    • error: null | Error

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useStreamConversations.html b/functions/useStreamConversations.html index f9b14fc5..aadf7a4f 100644 --- a/functions/useStreamConversations.html +++ b/functions/useStreamConversations.html @@ -1,3 +1,3 @@ useStreamConversations | @xmtp/react-sdk

Function useStreamConversations

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.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/useStreamMessages.html b/functions/useStreamMessages.html index 86bde475..0bc67945 100644 --- a/functions/useStreamMessages.html +++ b/functions/useStreamMessages.html @@ -1,2 +1,2 @@ useStreamMessages | @xmtp/react-sdk

Function useStreamMessages

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

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/types/CachedConsentEntry.html b/types/CachedConsentEntry.html index f0e06a51..f1ce45e1 100644 --- a/types/CachedConsentEntry.html +++ b/types/CachedConsentEntry.html @@ -1 +1 @@ -CachedConsentEntry | @xmtp/react-sdk

Type Alias CachedConsentEntry

CachedConsentEntry: {
    state: ConsentState;
    type: ConsentListEntryType;
    value: string;
    walletAddress: string;
}

Settings

Member Visibility
+CachedConsentEntry | @xmtp/react-sdk

Type Alias CachedConsentEntry

CachedConsentEntry: {
    state: ConsentState;
    type: ConsentListEntryType;
    value: string;
    walletAddress: string;
}

Settings

Member Visibility
diff --git a/types/CachedConsentEntryMap.html b/types/CachedConsentEntryMap.html index 89ebe164..9ee17ea3 100644 --- a/types/CachedConsentEntryMap.html +++ b/types/CachedConsentEntryMap.html @@ -1 +1 @@ -CachedConsentEntryMap | @xmtp/react-sdk

Type Alias CachedConsentEntryMap

CachedConsentEntryMap: {
    [value: string]: ConsentListEntry;
}

Settings

Member Visibility
+CachedConsentEntryMap | @xmtp/react-sdk

Type Alias CachedConsentEntryMap

CachedConsentEntryMap: {
    [value: string]: ConsentListEntry;
}

Settings

Member Visibility
diff --git a/types/CachedConsentTable.html b/types/CachedConsentTable.html index d4b88257..4d694b6a 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
+CachedConsentTable | @xmtp/react-sdk

Type Alias CachedConsentTable

CachedConsentTable: Table<CachedConsentEntry, string>

Settings

Member Visibility
diff --git a/types/CachedConversation.html b/types/CachedConversation.html index bccf1c0e..b8af9d1d 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;
    isReady: boolean;
    lastSyncedAt?: Date;
    metadata?: M;
    peerAddress: string;
    topic: string;
    updatedAt: Date;
    walletAddress: string;
}

Type Parameters

Settings

Member Visibility
+CachedConversation | @xmtp/react-sdk

Type Alias CachedConversation<M>

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

Type Parameters

Settings

Member Visibility
diff --git a/types/CachedConversationsTable.html b/types/CachedConversationsTable.html index 82a7ef5c..0668fb4a 100644 --- a/types/CachedConversationsTable.html +++ b/types/CachedConversationsTable.html @@ -1 +1 @@ -CachedConversationsTable | @xmtp/react-sdk

Type Alias CachedConversationsTable

CachedConversationsTable: Table<CachedConversation, string, Omit<CachedConversation, "id">>

Settings

Member Visibility
+CachedConversationsTable | @xmtp/react-sdk

Type Alias CachedConversationsTable

CachedConversationsTable: Table<CachedConversation, string, Omit<CachedConversation, "id">>

Settings

Member Visibility
diff --git a/types/CachedMessage.html b/types/CachedMessage.html index 9db32fb1..5856da3f 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: string;
    isSending: boolean;
    metadata?: M;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
}

Type Parameters

Settings

Member Visibility
+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: string;
    isSending: boolean;
    metadata?: M;
    sendOptions?: SendOptions;
    senderAddress: string;
    sentAt: Date;
    status: "unprocessed" | "processed";
    uuid: string;
    walletAddress: string;
}

Type Parameters

Settings

Member Visibility
diff --git a/types/CachedMessagesTable.html b/types/CachedMessagesTable.html index 9a56d7ca..888cdaaa 100644 --- a/types/CachedMessagesTable.html +++ b/types/CachedMessagesTable.html @@ -1 +1 @@ -CachedMessagesTable | @xmtp/react-sdk

Type Alias CachedMessagesTable<C>

CachedMessagesTable<C>: Table<CachedMessage<C>, string>

Type Parameters

  • C = any

Settings

Member Visibility
+CachedMessagesTable | @xmtp/react-sdk

Type Alias CachedMessagesTable<C>

CachedMessagesTable<C>: Table<CachedMessage<C>, string>

Type Parameters

  • C = any

Settings

Member Visibility
diff --git a/types/CachedReaction.html b/types/CachedReaction.html index 5e2bbf27..9970679e 100644 --- a/types/CachedReaction.html +++ b/types/CachedReaction.html @@ -1 +1 @@ -CachedReaction | @xmtp/react-sdk

Type Alias CachedReaction

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

Settings

Member Visibility
+CachedReaction | @xmtp/react-sdk

Type Alias CachedReaction

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

Settings

Member Visibility
diff --git a/types/CachedReactionsMetadata.html b/types/CachedReactionsMetadata.html index 2c447e25..6941e188 100644 --- a/types/CachedReactionsMetadata.html +++ b/types/CachedReactionsMetadata.html @@ -1 +1 @@ -CachedReactionsMetadata | @xmtp/react-sdk

Type Alias CachedReactionsMetadata

CachedReactionsMetadata: boolean

Settings

Member Visibility
+CachedReactionsMetadata | @xmtp/react-sdk

Type Alias CachedReactionsMetadata

CachedReactionsMetadata: boolean

Settings

Member Visibility
diff --git a/types/CachedReactionsTable.html b/types/CachedReactionsTable.html index f5d19f5d..24b167fd 100644 --- a/types/CachedReactionsTable.html +++ b/types/CachedReactionsTable.html @@ -1 +1 @@ -CachedReactionsTable | @xmtp/react-sdk

Type Alias CachedReactionsTable

CachedReactionsTable: Table<CachedReaction, string>

Settings

Member Visibility
+CachedReactionsTable | @xmtp/react-sdk

Type Alias CachedReactionsTable

CachedReactionsTable: Table<CachedReaction, string>

Settings

Member Visibility
diff --git a/types/ContentTypeConfiguration.html b/types/ContentTypeConfiguration.html index 6ac0f3d0..f801557d 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;
}

Settings

Member Visibility
+ContentTypeConfiguration | @xmtp/react-sdk

Type Alias ContentTypeConfiguration

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

Settings

Member Visibility
diff --git a/types/ContentTypeMessageProcessor.html b/types/ContentTypeMessageProcessor.html index 6006f4bd..46dbef06 100644 --- a/types/ContentTypeMessageProcessor.html +++ b/types/ContentTypeMessageProcessor.html @@ -1 +1 @@ -ContentTypeMessageProcessor | @xmtp/react-sdk

Type Alias ContentTypeMessageProcessor<C>

ContentTypeMessageProcessor<C>: ((options: {
    client: Client;
    conversation: CachedConversation;
    db: Dexie;
    message: CachedMessage<C>;
    processors?: ContentTypeMessageProcessors;
    updateConversationMetadata: ((data: ContentTypeMetadataValues) => Promise<void>);
}) => void | Promise<void>)

Type Parameters

  • C = any

Settings

Member Visibility
+ContentTypeMessageProcessor | @xmtp/react-sdk

Type Alias ContentTypeMessageProcessor<C>

ContentTypeMessageProcessor<C>: ((options: {
    client: Client;
    conversation: CachedConversation;
    db: Dexie;
    message: CachedMessage<C>;
    processors?: ContentTypeMessageProcessors;
    updateConversationMetadata: ((data: ContentTypeMetadataValues) => Promise<void>);
}) => void | Promise<void>)

Type Parameters

  • C = any

Settings

Member Visibility
diff --git a/types/ContentTypeMessageProcessors.html b/types/ContentTypeMessageProcessors.html index 012e2e00..336d5da0 100644 --- a/types/ContentTypeMessageProcessors.html +++ b/types/ContentTypeMessageProcessors.html @@ -1 +1 @@ -ContentTypeMessageProcessors | @xmtp/react-sdk

Type Alias ContentTypeMessageProcessors

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

Settings

Member Visibility
+ContentTypeMessageProcessors | @xmtp/react-sdk

Type Alias ContentTypeMessageProcessors

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

Settings

Member Visibility
diff --git a/types/ContentTypeMessageValidators.html b/types/ContentTypeMessageValidators.html index 25251a0e..8167ddf5 100644 --- a/types/ContentTypeMessageValidators.html +++ b/types/ContentTypeMessageValidators.html @@ -1 +1 @@ -ContentTypeMessageValidators | @xmtp/react-sdk

Type Alias ContentTypeMessageValidators

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

Settings

Member Visibility
+ContentTypeMessageValidators | @xmtp/react-sdk

Type Alias ContentTypeMessageValidators

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

Settings

Member Visibility
diff --git a/types/ContentTypeMetadata.html b/types/ContentTypeMetadata.html index 20406d5d..6a9c2004 100644 --- a/types/ContentTypeMetadata.html +++ b/types/ContentTypeMetadata.html @@ -1 +1 @@ -ContentTypeMetadata | @xmtp/react-sdk

Type Alias ContentTypeMetadata

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

Settings

Member Visibility
+ContentTypeMetadata | @xmtp/react-sdk

Type Alias ContentTypeMetadata

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

Settings

Member Visibility
diff --git a/types/ContentTypeMetadataValue.html b/types/ContentTypeMetadataValue.html index 30440e24..fe4d4f16 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
+ContentTypeMetadataValue | @xmtp/react-sdk

Type Alias ContentTypeMetadataValue

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

Settings

Member Visibility
diff --git a/types/ContentTypeMetadataValues.html b/types/ContentTypeMetadataValues.html index e794eb81..ad45afe4 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
+ContentTypeMetadataValues | @xmtp/react-sdk

Type Alias ContentTypeMetadataValues

ContentTypeMetadataValues: ContentTypeMetadataValue | Record<string, ContentTypeMetadataValue>

Settings

Member Visibility
diff --git a/types/ProcessUnprocessedMessagesOptions.html b/types/ProcessUnprocessedMessagesOptions.html index 6e6f23e3..17cc702a 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

  • Optionalreprocess?: 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
+

Settings

Member Visibility
diff --git a/variables/attachmentContentTypeConfig.html b/variables/attachmentContentTypeConfig.html index 258cdb57..d19e1e5c 100644 --- a/variables/attachmentContentTypeConfig.html +++ b/variables/attachmentContentTypeConfig.html @@ -1 +1 @@ -attachmentContentTypeConfig | @xmtp/react-sdk

Variable attachmentContentTypeConfigConst

attachmentContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
+attachmentContentTypeConfig | @xmtp/react-sdk

Variable attachmentContentTypeConfigConst

attachmentContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
diff --git a/variables/reactionContentTypeConfig.html b/variables/reactionContentTypeConfig.html index 086df5f0..d5d95776 100644 --- a/variables/reactionContentTypeConfig.html +++ b/variables/reactionContentTypeConfig.html @@ -1 +1 @@ -reactionContentTypeConfig | @xmtp/react-sdk

Variable reactionContentTypeConfigConst

reactionContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
+reactionContentTypeConfig | @xmtp/react-sdk

Variable reactionContentTypeConfigConst

reactionContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
diff --git a/variables/replyContentTypeConfig.html b/variables/replyContentTypeConfig.html index 9330a269..2c617da5 100644 --- a/variables/replyContentTypeConfig.html +++ b/variables/replyContentTypeConfig.html @@ -1 +1 @@ -replyContentTypeConfig | @xmtp/react-sdk

Variable replyContentTypeConfigConst

replyContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
+replyContentTypeConfig | @xmtp/react-sdk

Variable replyContentTypeConfigConst

replyContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
diff --git a/variables/textContentTypeConfig.html b/variables/textContentTypeConfig.html index d830c809..22afacf1 100644 --- a/variables/textContentTypeConfig.html +++ b/variables/textContentTypeConfig.html @@ -1 +1 @@ -textContentTypeConfig | @xmtp/react-sdk

Variable textContentTypeConfigConst

textContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility
+textContentTypeConfig | @xmtp/react-sdk

Variable textContentTypeConfigConst

textContentTypeConfig: ContentTypeConfiguration = ...

Settings

Member Visibility