diff --git a/classes/Client.html b/classes/Client.html index e36ed472f..09b7c8fb2 100644 --- a/classes/Client.html +++ b/classes/Client.html @@ -20,7 +20,7 @@

Hierarchy

+
  • Defined in lib/Client.ts:16
    • @@ -62,24 +62,24 @@

    Parameters

    address: string

    Returns Client

    +
  • Defined in lib/Client.ts:86

    • Properties

    address

    address: string
    +
  • Defined in lib/Client.ts:17

    • contacts

    contacts: default
    +
  • Defined in lib/Client.ts:19

    • conversations

    conversations: default
    +
  • Defined in lib/Client.ts:18

    • Methods

    @@ -94,7 +94,7 @@

    Parameters

    peerAddress: string

    Returns Promise<boolean>

    +
  • Defined in lib/Client.ts:82

    • decryptAttachment

    Returns Promise<DecryptedLocalAttachment>

    +
  • Defined in lib/Client.ts:117

    • encryptAttachment

    Returns Promise<EncryptedLocalAttachment>

    +
  • Defined in lib/Client.ts:109

    • exportKeyBundle

    +
  • Defined in lib/Client.ts:92

    • listBatchMessages

    Returns Promise<DecodedMessage[]>

    +
  • Defined in lib/Client.ts:100

    • sendPreparedMessage

    Returns Promise<string>

    +
  • Defined in lib/Client.ts:126

    • Static create

    Returns Promise<Client>

    +
  • Defined in lib/Client.ts:21

    • Static createFromKeyBundle

    Returns Promise<Client>

    +
  • Defined in lib/Client.ts:69

    • Static createRandom

    Returns Promise<Client>

    +
  • Defined in lib/Client.ts:60
    • diff --git a/classes/Conversation.html b/classes/Conversation.html index 9e7c85c5c..0110ac31a 100644 --- a/classes/Conversation.html +++ b/classes/Conversation.html @@ -20,7 +20,7 @@

    Hierarchy

    • Conversation
    +
  • Defined in lib/Conversation.ts:5
    • @@ -80,44 +80,44 @@
    topicversion: string

    Returns Conversation

    +
  • Defined in lib/Conversation.ts:14

    • Properties

    clientAddress

    clientAddress: string
    +
  • Defined in lib/Conversation.ts:6

    • Optional context

    context?: ConversationContext
    +
  • Defined in lib/Conversation.ts:8

    • Optional conversationID

    conversationID?: string
    +
  • Defined in lib/Conversation.ts:12

    • createdAt

    createdAt: number
    +
  • Defined in lib/Conversation.ts:7

    • peerAddress

    peerAddress: string
    +
  • Defined in lib/Conversation.ts:10

    • topic

    topic: string
    +
  • Defined in lib/Conversation.ts:9

    • version

    version: string
    +
  • Defined in lib/Conversation.ts:11

    • Methods

    @@ -127,7 +127,7 @@

    consentState

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

    +
  • Defined in lib/Conversation.ts:117

    • decodeMessage

      @@ -140,7 +140,7 @@

      Parameters

      encryptedMessage: string

    Returns Promise<DecodedMessage>

    +
  • Defined in lib/Conversation.ts:104

    • exportTopicData

    +
  • Defined in lib/Conversation.ts:32

    • messages

    Returns Promise<DecodedMessage[]>

    +
  • Defined in lib/Conversation.ts:40

    • prepareMessage

    Returns Promise<PreparedLocalMessage>

    +
  • Defined in lib/Conversation.ts:83

    • send

    Returns Promise<string>

    +
  • Defined in lib/Conversation.ts:62

    • sendPreparedMessage

    Returns Promise<string>

    +
  • Defined in lib/Conversation.ts:95

    • streamMessages

    +
  • Defined in lib/Conversation.ts:121
    • diff --git a/classes/XMTPPush.html b/classes/XMTPPush.html index c99fe7aa3..4a4ac58fb 100644 --- a/classes/XMTPPush.html +++ b/classes/XMTPPush.html @@ -20,7 +20,7 @@

    Hierarchy

    • XMTPPush
    +
  • Defined in lib/XMTPPush.ts:3
    • @@ -59,7 +59,7 @@
    server: token: string

    Returns void

    +
  • Defined in lib/XMTPPush.ts:4

    • Static subscribe

      @@ -72,7 +72,7 @@

      Parameters

      topics: string[]

    Returns void

    +
  • Defined in lib/XMTPPush.ts:8
    • diff --git a/functions/address.html b/functions/address.html index 0e82a5893..e5f8181c8 100644 --- a/functions/address.html +++ b/functions/address.html @@ -21,7 +21,7 @@

    Function address

  • Returns string

    • +
  • Defined in index.ts:15
    • diff --git a/functions/allowContacts.html b/functions/allowContacts.html index 518864b41..0fff173a1 100644 --- a/functions/allowContacts.html +++ b/functions/allowContacts.html @@ -28,7 +28,7 @@
    clientAddress: addresses: string[]

    Returns void

    +
  • Defined in index.ts:292
    • diff --git a/functions/auth.html b/functions/auth.html index d7b08d5e4..8fa9374a6 100644 --- a/functions/auth.html +++ b/functions/auth.html @@ -30,7 +30,7 @@
    environment: Optional appVersion: string

    Returns Promise<any>

    +
  • Defined in index.ts:19
    • diff --git a/functions/canMessage.html b/functions/canMessage.html index 8632353eb..861d5633b 100644 --- a/functions/canMessage.html +++ b/functions/canMessage.html @@ -28,7 +28,7 @@
    clientAddress: peerAddress: string

    Returns Promise<boolean>

    +
  • Defined in index.ts:75
    • diff --git a/functions/conversationConsentState.html b/functions/conversationConsentState.html index c8af72b5c..4322c608d 100644 --- a/functions/conversationConsentState.html +++ b/functions/conversationConsentState.html @@ -28,7 +28,7 @@
    clientAddress: conversationTopic: string

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

    +
  • Defined in index.ts:264
    • diff --git a/functions/createConversation.html b/functions/createConversation.html index 76ac827d3..c65a569c9 100644 --- a/functions/createConversation.html +++ b/functions/createConversation.html @@ -30,7 +30,7 @@
    peerAddress: Optional context: ConversationContext

    Returns Promise<Conversation>

    +
  • Defined in index.ts:158
    • diff --git a/functions/createFromKeyBundle.html b/functions/createFromKeyBundle.html index a6d83216a..3aa940d92 100644 --- a/functions/createFromKeyBundle.html +++ b/functions/createFromKeyBundle.html @@ -30,7 +30,7 @@
    environment: Optional appVersion: string

    Returns Promise<string>

    +
  • Defined in index.ts:38
    • diff --git a/functions/createRandom.html b/functions/createRandom.html index c0a315751..dbe1e9ae1 100644 --- a/functions/createRandom.html +++ b/functions/createRandom.html @@ -28,7 +28,7 @@
    environment: Optional appVersion: string

    Returns Promise<string>

    +
  • Defined in index.ts:31
    • diff --git a/functions/decodeMessage.html b/functions/decodeMessage.html index ac5da7562..5e8db4698 100644 --- a/functions/decodeMessage.html +++ b/functions/decodeMessage.html @@ -30,7 +30,7 @@
    topic: encryptedMessage: string

    Returns Promise<DecodedMessage>

    +
  • Defined in index.ts:254
    • diff --git a/functions/decryptAttachment.html b/functions/decryptAttachment.html index 9e3258e04..a426855cd 100644 --- a/functions/decryptAttachment.html +++ b/functions/decryptAttachment.html @@ -28,7 +28,7 @@
    clientAddress: encryptedFile: EncryptedLocalAttachment

    Returns Promise<DecryptedLocalAttachment>

    +
  • Defined in index.ts:94
    • diff --git a/functions/denyContacts.html b/functions/denyContacts.html index d55b902e4..717e68dbb 100644 --- a/functions/denyContacts.html +++ b/functions/denyContacts.html @@ -28,7 +28,7 @@
    clientAddress: addresses: string[]

    Returns void

    +
  • Defined in index.ts:285
    • diff --git a/functions/encryptAttachment.html b/functions/encryptAttachment.html index 29f59ae49..d42e0b0b3 100644 --- a/functions/encryptAttachment.html +++ b/functions/encryptAttachment.html @@ -28,7 +28,7 @@
    clientAddress: file: DecryptedLocalAttachment

    Returns Promise<EncryptedLocalAttachment>

    +
  • Defined in index.ts:82
    • diff --git a/functions/exportConversationTopicData.html b/functions/exportConversationTopicData.html index fe1c52521..e518b2e8e 100644 --- a/functions/exportConversationTopicData.html +++ b/functions/exportConversationTopicData.html @@ -28,7 +28,7 @@
    clientAddress: conversationTopic: string

    Returns Promise<string>

    +
  • Defined in index.ts:54
    • diff --git a/functions/exportKeyBundle.html b/functions/exportKeyBundle.html index 7d1ff937f..31899103e 100644 --- a/functions/exportKeyBundle.html +++ b/functions/exportKeyBundle.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns Promise<string>

    +
  • Defined in index.ts:50
    • diff --git a/functions/importConversationTopicData.html b/functions/importConversationTopicData.html index 3cc786989..ae44fbbdd 100644 --- a/functions/importConversationTopicData.html +++ b/functions/importConversationTopicData.html @@ -28,7 +28,7 @@
    clientAddress: topicData: string

    Returns Promise<Conversation>

    +
  • Defined in index.ts:64
    • diff --git a/functions/isAllowed.html b/functions/isAllowed.html index 65f8210ed..e2d9d9c6b 100644 --- a/functions/isAllowed.html +++ b/functions/isAllowed.html @@ -28,7 +28,7 @@
    clientAddress: address: string

    Returns Promise<boolean>

    +
  • Defined in index.ts:271
    • diff --git a/functions/isDenied.html b/functions/isDenied.html index 2f3dc33c7..3173dd5da 100644 --- a/functions/isDenied.html +++ b/functions/isDenied.html @@ -28,7 +28,7 @@
    clientAddress: address: string

    Returns Promise<boolean>

    +
  • Defined in index.ts:278
    • diff --git a/functions/listBatchMessages.html b/functions/listBatchMessages.html index 54605caa0..9e8fa95bf 100644 --- a/functions/listBatchMessages.html +++ b/functions/listBatchMessages.html @@ -28,7 +28,7 @@
    clientAddress: queries: Query[]

    Returns Promise<DecodedMessage[]>

    +
  • Defined in index.ts:137
    • diff --git a/functions/listConversations.html b/functions/listConversations.html index 59e1f6564..b275bb005 100644 --- a/functions/listConversations.html +++ b/functions/listConversations.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns Promise<Conversation[]>

    +
  • Defined in index.ts:106
    • diff --git a/functions/listMessages.html b/functions/listMessages.html index e9693bdd6..0b2c1942b 100644 --- a/functions/listMessages.html +++ b/functions/listMessages.html @@ -36,7 +36,7 @@
    Optional Optional direction: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"

    Returns Promise<DecodedMessage[]>

    +
  • Defined in index.ts:116
    • diff --git a/functions/prepareMessage.html b/functions/prepareMessage.html index 9bb7bc7d5..d13bd1ec1 100644 --- a/functions/prepareMessage.html +++ b/functions/prepareMessage.html @@ -30,7 +30,7 @@
    conversationTopic: content: MessageContent

    Returns Promise<PreparedLocalMessage>

    +
  • Defined in index.ts:189
    • diff --git a/functions/receiveSignature.html b/functions/receiveSignature.html index 7da2d7f65..ac71342ab 100644 --- a/functions/receiveSignature.html +++ b/functions/receiveSignature.html @@ -28,7 +28,7 @@
    requestID: signature: string

    Returns Promise<any>

    +
  • Defined in index.ts:27
    • diff --git a/functions/refreshConsentList.html b/functions/refreshConsentList.html index e648a5112..df8900bed 100644 --- a/functions/refreshConsentList.html +++ b/functions/refreshConsentList.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns void

    +
  • Defined in index.ts:299
    • diff --git a/functions/registerPushToken.html b/functions/registerPushToken.html index cd1668eb5..fbf32eded 100644 --- a/functions/registerPushToken.html +++ b/functions/registerPushToken.html @@ -28,7 +28,7 @@
    pushServer: token: string

    Returns any

    +
  • Defined in index.ts:246
    • diff --git a/functions/sendMessage.html b/functions/sendMessage.html index 74d67ad3e..6678ef2f9 100644 --- a/functions/sendMessage.html +++ b/functions/sendMessage.html @@ -30,7 +30,7 @@
    conversationTopic: content: MessageContent

    Returns Promise<string>

    +
  • Defined in index.ts:174
    • diff --git a/functions/sendPreparedMessage.html b/functions/sendPreparedMessage.html index 1dd9d6d01..5eb97beed 100644 --- a/functions/sendPreparedMessage.html +++ b/functions/sendPreparedMessage.html @@ -28,7 +28,7 @@
    clientAddress: preparedLocalMessage: PreparedLocalMessage

    Returns Promise<string>

    +
  • Defined in index.ts:205
    • diff --git a/functions/subscribePushTopics.html b/functions/subscribePushTopics.html index f0004cb4e..277a11065 100644 --- a/functions/subscribePushTopics.html +++ b/functions/subscribePushTopics.html @@ -26,7 +26,7 @@

    Parameters

    topics: string[]

    Returns any

    +
  • Defined in index.ts:250
    • diff --git a/functions/subscribeToAllMessages.html b/functions/subscribeToAllMessages.html index 9cfef1636..024945836 100644 --- a/functions/subscribeToAllMessages.html +++ b/functions/subscribeToAllMessages.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns any

    +
  • Defined in index.ts:220
    • diff --git a/functions/subscribeToConversations.html b/functions/subscribeToConversations.html index 6359bf997..9c2022a95 100644 --- a/functions/subscribeToConversations.html +++ b/functions/subscribeToConversations.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns any

    +
  • Defined in index.ts:216
    • diff --git a/functions/subscribeToMessages.html b/functions/subscribeToMessages.html index ad381a766..654cefbd0 100644 --- a/functions/subscribeToMessages.html +++ b/functions/subscribeToMessages.html @@ -28,7 +28,7 @@
    clientAddress: topic: string

    Returns Promise<any>

    +
  • Defined in index.ts:224
    • diff --git a/functions/unsubscribeFromAllMessages.html b/functions/unsubscribeFromAllMessages.html index 7dda8b3ae..c35802535 100644 --- a/functions/unsubscribeFromAllMessages.html +++ b/functions/unsubscribeFromAllMessages.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns any

    +
  • Defined in index.ts:235
    • diff --git a/functions/unsubscribeFromConversations.html b/functions/unsubscribeFromConversations.html index c336cf342..76679e0ce 100644 --- a/functions/unsubscribeFromConversations.html +++ b/functions/unsubscribeFromConversations.html @@ -26,7 +26,7 @@

    Parameters

    clientAddress: string

    Returns any

    +
  • Defined in index.ts:231
    • diff --git a/functions/unsubscribeFromMessages.html b/functions/unsubscribeFromMessages.html index 5e37e37a6..82009e139 100644 --- a/functions/unsubscribeFromMessages.html +++ b/functions/unsubscribeFromMessages.html @@ -28,7 +28,7 @@
    clientAddress: topic: string

    Returns Promise<any>

    +
  • Defined in index.ts:239
    • diff --git a/types/ConversationContext.html b/types/ConversationContext.html index 57f4108ed..35e0ba979 100644 --- a/types/ConversationContext.html +++ b/types/ConversationContext.html @@ -27,7 +27,7 @@
    metadata
    [key: string]: string
    +
  • Defined in XMTP.types.ts:102
    • diff --git a/types/DecodedMessage.html b/types/DecodedMessage.html index 4c7cf98e2..9ccd16a55 100644 --- a/types/DecodedMessage.html +++ b/types/DecodedMessage.html @@ -34,7 +34,7 @@
    sent
    topic: string
    +
  • Defined in XMTP.types.ts:92
    • diff --git a/types/DecryptedLocalAttachment.html b/types/DecryptedLocalAttachment.html index 499300c78..12e69d127 100644 --- a/types/DecryptedLocalAttachment.html +++ b/types/DecryptedLocalAttachment.html @@ -26,7 +26,7 @@
    Optional
    Optional mimeType?: string
    +
  • Defined in XMTP.types.ts:25
    • diff --git a/types/EncryptedLocalAttachment.html b/types/EncryptedLocalAttachment.html index aea2132a2..b80ee5a6a 100644 --- a/types/EncryptedLocalAttachment.html +++ b/types/EncryptedLocalAttachment.html @@ -24,7 +24,7 @@
    encryptedLocalFileUri
    metadata: RemoteAttachmentMetadata
    +
  • Defined in XMTP.types.ts:40
    • diff --git a/types/MessageContent.html b/types/MessageContent.html index 056e2121e..df4714822 100644 --- a/types/MessageContent.html +++ b/types/MessageContent.html @@ -34,7 +34,7 @@
    Optional
    Optional unknown?: UnknownContent
    +
  • Defined in XMTP.types.ts:82
    • diff --git a/types/PreparedLocalMessage.html b/types/PreparedLocalMessage.html index 2dd94262d..285bf8004 100644 --- a/types/PreparedLocalMessage.html +++ b/types/PreparedLocalMessage.html @@ -26,7 +26,7 @@
    preparedAt
    preparedFileUri: `file://${string}`
    +
  • Defined in XMTP.types.ts:73
    • diff --git a/types/Query.html b/types/Query.html index b3a39d538..0b5dcb96c 100644 --- a/types/Query.html +++ b/types/Query.html @@ -30,7 +30,7 @@
    Optional
    Optional startTime?: number | Date
    +
  • Defined in lib/Query.ts:1
    • diff --git a/types/ReactionContent.html b/types/ReactionContent.html index 536f80a0b..695648c98 100644 --- a/types/ReactionContent.html +++ b/types/ReactionContent.html @@ -28,7 +28,7 @@
    reference
    schema: "unicode" | "shortcode" | "custom" | "unknown"
    +
  • Defined in XMTP.types.ts:12
    • diff --git a/types/ReadReceiptContent.html b/types/ReadReceiptContent.html index 658968300..9c098cea5 100644 --- a/types/ReadReceiptContent.html +++ b/types/ReadReceiptContent.html @@ -17,7 +17,7 @@

    Type alias ReadReceiptContent

    ReadReceiptContent: object
    +
  • Defined in XMTP.types.ts:5
    • diff --git a/types/RemoteAttachmentContent.html b/types/RemoteAttachmentContent.html index 96bc66433..106d67de0 100644 --- a/types/RemoteAttachmentContent.html +++ b/types/RemoteAttachmentContent.html @@ -24,7 +24,7 @@
    scheme
    url: string
    +
  • Defined in XMTP.types.ts:45
    • diff --git a/types/RemoteAttachmentMetadata.html b/types/RemoteAttachmentMetadata.html index cf83654e3..c4b40a2c0 100644 --- a/types/RemoteAttachmentMetadata.html +++ b/types/RemoteAttachmentMetadata.html @@ -32,7 +32,7 @@
    salt
    secret: string
    +
  • Defined in XMTP.types.ts:31
    • diff --git a/types/ReplyContent.html b/types/ReplyContent.html index be2d21536..d626ffca0 100644 --- a/types/ReplyContent.html +++ b/types/ReplyContent.html @@ -24,7 +24,7 @@
    content
    reference: string
    +
  • Defined in XMTP.types.ts:7
    • diff --git a/types/StaticAttachmentContent.html b/types/StaticAttachmentContent.html index 680ac7446..370cc72fb 100644 --- a/types/StaticAttachmentContent.html +++ b/types/StaticAttachmentContent.html @@ -26,7 +26,7 @@
    filename
    mimeType: string
    +
  • Defined in XMTP.types.ts:19
    • diff --git a/types/UnknownContent.html b/types/UnknownContent.html index 3dab3ad7c..6f022fd49 100644 --- a/types/UnknownContent.html +++ b/types/UnknownContent.html @@ -22,7 +22,7 @@

    Type declaration

  • contentTypeId: string
    • +
  • Defined in XMTP.types.ts:1
    • diff --git a/variables/emitter.html b/variables/emitter.html index d7186646d..db33574ec 100644 --- a/variables/emitter.html +++ b/variables/emitter.html @@ -17,7 +17,7 @@

    Variable emitterConst

    emitter: EventEmitter = ...
    +
  • Defined in index.ts:305