Determines whether the current user can send messages to a specified peer.
This method checks if the specified peer has signed up for XMTP and ensures that the message is not addressed to the sender (no self-messaging).
The address of the peer to check for messaging eligibility.
A Promise resolving to true if messaging is allowed, and false otherwise.
-Decrypts an encrypted local attachment.
+Decrypts an encrypted local attachment.
This asynchronous method takes an encrypted local attachment and decrypts it.
The encrypted local attachment to be decrypted.
A Promise that resolves to the decrypted local attachment.
Throws an error if the attachment is not a local file URI (must start with "file://").
-Encrypts a local attachment for secure transmission.
+Encrypts a local attachment for secure transmission.
This asynchronous method takes a file, checks if it's a local file URI, and encrypts the attachment for secure transmission.
The local attachment to be encrypted.
A Promise that resolves to the encrypted local attachment.
Throws an error if the attachment is not a local file URI (must start with "file://").
-Exports the key bundle associated with the current XMTP address.
This method allows you to obtain the unencrypted key bundle for the current XMTP address. Ensure the exported keys are stored securely and encrypted.
A Promise that resolves to the unencrypted key bundle for the current XMTP address.
-Retrieves a list of batch messages based on the provided queries.
+Retrieves a list of batch messages based on the provided queries.
This method pulls messages associated from multiple conversation with the current address and specified queries.
An array of queries to filter the batch messages.
A Promise that resolves to a list of batch messages.
The error is logged, and the method gracefully returns an empty array.
-Sends a prepared message.
The prepared local message to be sent.
A Promise that resolves to a string identifier for the sent message.
Throws an error if there is an issue with sending the prepared message.
-Static createStatic createCreates a new instance of the Client class using the provided signer.
The signer object used for authentication and message signing.
Optional opts: Partial<NetworkOptions> & { Optional configuration options for the Client.
A Promise that resolves to a new Client instance.
See XMTP Docs for more information.
-Static createCreates a new instance of the Client class from a provided key bundle.
+Static createCreates a new instance of the Client class from a provided key bundle.
This method is useful for scenarios where you want to manually handle private key storage, allowing the application to have access to XMTP keys without exposing wallet keys.
The key bundle used for address generation.
Optional opts: Partial<NetworkOptions> & { Optional configuration options for the Client.
A Promise that resolves to a new Client instance based on the provided key bundle.
-Static createCreates a new instance of the XMTP Client with a randomly generated address.
+Static createCreates a new instance of the XMTP Client with a randomly generated address.
Optional opts: Partial<NetworkOptions> & { Optional configuration options for the Client.
A Promise that resolves to a new Client instance with a random address.
-Generated using TypeDoc
Generated using TypeDoc
Optional context?: ConversationContextOptional conversationID?: stringOptional contextOptional conversationIDOptional context?: ConversationContextOptional conversationID?: stringOptional contextOptional conversationIDRetrieves the consent state for the current conversation.
This asynchronous method determine the consent state for the current conversation, indicating whether the user has allowed, denied, or is yet to provide consent.
A Promise that resolves to the consent state, which can be "allowed," "denied," or "unknown."
-Decodes an encrypted message, yielding a DecodedMessage object.
Decodes an encrypted message, yielding a DecodedMessage object.
This asynchronous method takes an encrypted message and decodes it.
The result is a DecodedMessage object containing the decoded content and metadata.
The encrypted message to be decoded.
A Promise that resolves to a DecodedMessage object.
Throws an error if there is an issue with decoding the message.
-Lists messages in a conversation with optional filters.
+Lists messages in a conversation with optional filters.
Optional limit: numberOptional limit to the number of messages to return.
Optional before: number | DateOptional timestamp to filter messages before.
Optional after: number | DateOptional timestamp to filter messages after.
@@ -34,7 +34,7 @@A Promise that resolves to an array of decoded messages.
Throws an error if there is an issue with listing messages.
Support pagination and conversation ID in future implementations.
-Prepares a message to be sent, yielding a PreparedLocalMessage object.
Prepares a message to be sent, yielding a PreparedLocalMessage object.
Instead of immediately sending a message, you can prepare it first using this method.
This yields a PreparedLocalMessage object, which you can send later.
This is useful to help construct a robust pending-message queue
@@ -44,18 +44,18 @@
Support pagination and conversation ID in future implementations
The content of the message. It can be either a string or a structured MessageContent object.
A Promise that resolves to a PreparedLocalMessage object.
Throws an error if there is an issue with preparing the message.
-Sends a message to the current conversation.
The content of the message. It can be either a string or a structured MessageContent object.
Optional opts: SendOptionsA Promise that resolves to a string identifier for the sent message.
Throws an error if there is an issue with sending the message.
Support specifying a conversation ID in future implementations.
-Sends a prepared local message.
This asynchronous method takes a PreparedLocalMessage and sends it.
Prepared messages are created using the prepareMessage method.
The prepared local message to be sent.
A Promise that resolves to a string identifier for the sent message.
Throws an error if there is an issue with sending the prepared message.
-Sets up a real-time message stream for the current conversation.
This method subscribes to incoming messages in real-time and listens for new message events. When a new message is detected, the provided callback function is invoked with the details of the message. Additionally, this method returns a function that can be called to unsubscribe and end the message stream.
@@ -66,4 +66,4 @@Support specifying a conversation ID in future implementations.< When a new message is detected, the provided callback function is invoked with the details of the message. Additionally, this method returns a function that can be called to unsubscribe and end the message stream.
A function that, when called, unsubscribes from the message stream and ends real-time updates.
-Generated using TypeDoc
Generated using TypeDoc
Static fromStatic fromGenerated using TypeDoc
Static fromStatic fromGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Static registerStatic subscribeGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional context: ConversationContextGenerated using TypeDoc
Optional context: ConversationContextGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional limit: numberOptional before: number | DateOptional after: number | DateOptional direction: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"Generated using TypeDoc
Optional limit: numberOptional before: number | DateOptional after: number | DateOptional direction: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Your app must use Android minSdkVersion = 22 to work with the xmtp-react-native SDK.
The XMTP message API revolves around a network client that allows retrieving and sending messages to other network participants. A client must be connected to a wallet on startup. If this is the very first time the client is created, the client will generate a key bundle that is used to encrypt and authenticate messages. The key bundle persists encrypted in the network using a wallet signature. The public side of the key bundle is also regularly advertised on the network to allow parties to establish shared encryption keys. All this happens transparently, without requiring any additional code.
-import { Client } from '@xmtp/xmtp-react-native'
import { ConnectWallet, useSigner } from "@thirdweb-dev/react-native";
// Create the client with your wallet. This will connect to the XMTP development network by default
const xmtp = await XMTP.Client.create(useSigner());
// Start a conversation with XMTP
const conversation = await xmtp.conversations.newConversation(
'0x3F11b27F323b62B159D2642964fa27C46C841897'
)
// Load all messages in the conversation
const messages = await conversation.messages()
// Send a message
await conversation.send('gm')
// Listen for new messages in the conversation
for await (const message of await conversation.streamMessages()) {
console.log(`[${message.senderAddress}]: ${message.content}`)
}
+import { Client } from '@xmtp/react-native-sdk'
import { ConnectWallet, useSigner } from "@thirdweb-dev/react-native";
// Create the client with your wallet. This will connect to the XMTP development network by default
const xmtp = await XMTP.Client.create(useSigner());
// Start a conversation with XMTP
const conversation = await xmtp.conversations.newConversation(
'0x3F11b27F323b62B159D2642964fa27C46C841897'
)
// Load all messages in the conversation
const messages = await conversation.messages()
// Send a message
await conversation.send('gm')
// Listen for new messages in the conversation
for await (const message of await conversation.streamMessages()) {
console.log(`[${message.senderAddress}]: ${message.content}`)
}
Currently, network nodes are configured to rate limit high-volume publishing from clients. A rate-limited client can expect to receive a 429 status code response from a node. Rate limits can change at any time in the interest of maintaining network health.
Use local storage
@@ -39,7 +39,7 @@
Important
The client connects to the XMTP dev environment by default. Use ClientOptions to change this and other parameters of the network connection.
-import { Client } from '@xmtp/xmtp-react-native'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
+import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
Configure the client
The client's network connection and key storage method can be configured with these optional parameters of Client.create:
@@ -67,7 +67,7 @@
Handle conversations
Most of the time, when interacting with the network, you'll want to do it through conversations. Conversations are between two wallets.
-import { Client } from '@xmtp/xmtp-react-native'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
const conversations = xmtp.conversations
+import { Client } from '@xmtp/react-native-sdk'
// Create the client with a `Signer` from your application
const xmtp = await Client.create(wallet)
const conversations = xmtp.conversations
List existing conversations
You can get a list of all conversations that have one or more messages.
const allConversations = await xmtp.conversations.list()
// Say gm to everyone you've been chatting with
for (const conversation of allConversations) {
console.log(`Saying GM to ${conversation.peerAddress}`)
await conversation.send('gm')
}
@@ -114,7 +114,7 @@
To learn more, see Request and respect user consent.
Check if an address is on the network
If you would like to check and see if a blockchain address is registered on the network before instantiating a client instance, you can use Client.canMessage.
-import { Client } from '@xmtp/xmtp-react-native'
const isOnDevNetwork = await Client.canMessage(
'0x3F11b27F323b62B159D2642964fa27C46C841897'
)
+import { Client } from '@xmtp/react-native-sdk'
const isOnDevNetwork = await Client.canMessage(
'0x3F11b27F323b62B159D2642964fa27C46C841897'
)
Send a broadcast message
You can send a broadcast message (1:many message or announcement) with XMTP. The recipient sees the message as a DM from the sending wallet address.
For important information about sending broadcast messages, see Best practices for broadcast messages.
@@ -123,7 +123,7 @@
- Send the message to all of the activated wallet addresses.
For example:
-const ethers = require('ethers')
const { Client } = require('@xmtp/xmtp-react-native')
async function main() {
//Create a random wallet for example purposes. On the frontend you should replace it with the user's wallet (metamask, rainbow, etc)
//Initialize the xmtp client
const xmtp = await XMTP.Client.createRandom({ env: "dev" });
//In this example we are going to broadcast to the GM_BOT wallet (already activated) and a random wallet (not activated)
const GM_BOT = '0x937C0d4a6294cdfa575de17382c7076b579DC176'
const test = ethers.Wallet.createRandom()
const broadcasts_array = [GM_BOT, test.address]
//Querying the activation status of the wallets
const broadcasts_canMessage = await Client.canMessage(broadcasts_array)
for (let i = 0; i < broadcasts_array.length; i++) {
//Checking the activation status of each wallet
const wallet = broadcasts_array[i]
const canMessage = broadcasts_canMessage[i]
if (broadcasts_canMessage[i]) {
//If activated, start
const conversation = await xmtp.conversations.newConversation(wallet)
// Send a message
const sent = await conversation.send('gm')
}
}
}
main()
+const ethers = require('ethers')
const { Client } = require('@xmtp/react-native-sdk')
async function main() {
//Create a random wallet for example purposes. On the frontend you should replace it with the user's wallet (metamask, rainbow, etc)
//Initialize the xmtp client
const xmtp = await XMTP.Client.createRandom({ env: "dev" });
//In this example we are going to broadcast to the GM_BOT wallet (already activated) and a random wallet (not activated)
const GM_BOT = '0x937C0d4a6294cdfa575de17382c7076b579DC176'
const test = ethers.Wallet.createRandom()
const broadcasts_array = [GM_BOT, test.address]
//Querying the activation status of the wallets
const broadcasts_canMessage = await Client.canMessage(broadcasts_array)
for (let i = 0; i < broadcasts_array.length; i++) {
//Checking the activation status of each wallet
const wallet = broadcasts_array[i]
const canMessage = broadcasts_canMessage[i]
if (broadcasts_canMessage[i]) {
//If activated, start
const conversation = await xmtp.conversations.newConversation(wallet)
// Send a message
const sent = await conversation.send('gm')
}
}
}
main()
Handle different types of content
All send functions support SendOptions as an optional parameter. The contentType option allows specifying different types of content than the default simple string standard content type, which is identified with content type identifier ContentTypeText.
To learn more about content types, see Content types with XMTP.
@@ -138,7 +138,7 @@
Custom codecs and content types may be proposed as interoperable standards through XRCs. To learn about the custom content type proposal process, see XIP-5.
Manually handle private key storage
The SDK will handle key storage for the user by encrypting the private key bundle using a signature generated from the wallet, and storing the encrypted payload on the XMTP network. This can be awkward for some server-side applications, where you may only want to give the application access to the XMTP keys but not your wallet keys. Mobile applications may also want to store keys in a secure enclave rather than rely on decrypting the remote keys on the network each time the application starts up.
You can export the unencrypted key bundle using the static method Client.exportKeyBundle, save it somewhere secure, and then provide those keys at a later time to initialize a new client using the exported XMTP identity.
-import { Client } from '@xmtp/xmtp-react-native'
// Get the keys using a valid Signer. Save them somewhere secure.
const keys = await Client.exportKeyBundle()
// Create a client using keys returned from getKeys
const client = await Client.createFromKeyBundle(keys, { env: "dev" })
+import { Client } from '@xmtp/react-native-sdk'
// Get the keys using a valid Signer. Save them somewhere secure.
const keys = await Client.exportKeyBundle()
// Create a client using keys returned from getKeys
const client = await Client.createFromKeyBundle(keys, { env: "dev" })
The keys returned by exportKeyBundle should be treated with the utmost care as compromise of these keys will allow an attacker to impersonate the user on the XMTP network. Ensure these keys are stored somewhere secure and encrypted.
Enable the example app to send push notifications
Check out the push-notifications-example branch and follow instructions in the README.
diff --git a/interfaces/JSContentCodec.html b/interfaces/JSContentCodec.html
index e3b3a0828..47a02944f 100644
--- a/interfaces/JSContentCodec.html
+++ b/interfaces/JSContentCodec.html
@@ -1,5 +1,5 @@
-JSContentCodec | @xmtp/react-native-sdk Interface JSContentCodec<T>
interface JSContentCodec {
contentType: ContentTypeId;
decode(encodedContent): T;
encode(content): EncodedContent;
fallback(content): undefined | string;
} Type Parameters
T
Index
Properties
contentJSContentCodec | @xmtp/react-native-sdk Interface JSContentCodec<T>
interface JSContentCodec {
contentType: ContentTypeId;
decode(encodedContent): T;
encode(content): EncodedContent;
fallback(content): undefined | string;
} Type Parameters
T
Index
Properties
Methods
Properties
content
contentMethods
decode
encode
fallback
Generated using TypeDoc
\ No newline at end of file
+Properties
content
contentMethods
decode
encode
fallback
Generated using TypeDoc
\ No newline at end of file
diff --git a/interfaces/NativeContentCodec.html b/interfaces/NativeContentCodec.html
index e69f03567..0579ab744 100644
--- a/interfaces/NativeContentCodec.html
+++ b/interfaces/NativeContentCodec.html
@@ -1,6 +1,6 @@
-NativeContentCodec | @xmtp/react-native-sdk Interface NativeContentCodec<T>
interface NativeContentCodec {
contentKey: string;
contentType: ContentTypeId;
decode(nativeContent): T;
encode(content): NativeMessageContent;
fallback(content): undefined | string;
} Type Parameters
T
Implemented by
Index
Properties
contentNativeContentCodec | @xmtp/react-native-sdk Interface NativeContentCodec<T>
interface NativeContentCodec {
contentKey: string;
contentType: ContentTypeId;
decode(nativeContent): T;
encode(content): NativeMessageContent;
fallback(content): undefined | string;
} Type Parameters
T
Implemented by
Index
Properties
Methods
Properties
content
contentcontent
contentMethods
decode
- decode(nativeContent): T
Parameters
nativeContent: NativeMessageContent
Returns T
encode
- encode(content): NativeMessageContent
Parameters
content: T
Returns NativeMessageContent
fallback
Generated using TypeDoc
\ No newline at end of file
+Properties
content
contentcontent
contentMethods
decode
- decode(nativeContent): T
Parameters
nativeContent: NativeMessageContent
Returns T
encode
- encode(content): NativeMessageContent
Parameters
content: T
Returns NativeMessageContent
fallback
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/ContentCodec.html b/types/ContentCodec.html
index a97e33713..5cc252c5b 100644
--- a/types/ContentCodec.html
+++ b/types/ContentCodec.html
@@ -1 +1 @@
-ContentCodec | @xmtp/react-native-sdk Type alias ContentCodec<T>
Type Parameters
T
Generated using TypeDoc
\ No newline at end of file
+ContentCodec | @xmtp/react-native-sdk Type alias ContentCodec<T>
Type Parameters
T
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/ContentTypeId.html b/types/ContentTypeId.html
index 66c7cfd4f..ceb9cfcbf 100644
--- a/types/ContentTypeId.html
+++ b/types/ContentTypeId.html
@@ -1 +1 @@
-ContentTypeId | @xmtp/react-native-sdk Type alias ContentTypeId
ContentGenerated using TypeDoc
\ No newline at end of file
+ContentTypeId | @xmtp/react-native-sdk Type alias ContentTypeId
ContentGenerated using TypeDoc
\ No newline at end of file
diff --git a/types/ConversationContext.html b/types/ConversationContext.html
index 47cc285ab..30ca0a37a 100644
--- a/types/ConversationContext.html
+++ b/types/ConversationContext.html
@@ -1 +1 @@
-ConversationContext | @xmtp/react-native-sdk Type alias ConversationContext
Conversation
conversationID: string;
metadata: {
[key: string]: string;
};
}Type declaration
conversationID: string
metadata: {
[key: string]: string;
}
[key: string]: string
Generated using TypeDoc
\ No newline at end of file
+ConversationContext | @xmtp/react-native-sdk Type alias ConversationContext
Conversation
conversationID: string;
metadata: {
[key: string]: string;
};
}Type declaration
conversationID: string
metadata: {
[key: string]: string;
}
[key: string]: string
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/DecryptedLocalAttachment.html b/types/DecryptedLocalAttachment.html
index 9b21c9736..cab4254e3 100644
--- a/types/DecryptedLocalAttachment.html
+++ b/types/DecryptedLocalAttachment.html
@@ -1 +1 @@
-DecryptedLocalAttachment | @xmtp/react-native-sdk Type alias DecryptedLocalAttachment
Decrypted
fileUri: string;
filename?: string;
mimeType?: string;
}Type declaration
file
Optional filename?: string
Optional mime
Generated using TypeDoc
\ No newline at end of file
+DecryptedLocalAttachment | @xmtp/react-native-sdk Type alias DecryptedLocalAttachment
Decrypted
fileUri: string;
filename?: string;
mimeType?: string;
}Type declaration
file
Optional filename?: string
Optional mime
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/EncodedContent.html b/types/EncodedContent.html
index 8fc61ca78..c72becbb2 100644
--- a/types/EncodedContent.html
+++ b/types/EncodedContent.html
@@ -1 +1 @@
-EncodedContent | @xmtp/react-native-sdk Type alias EncodedContent
EncodedGenerated using TypeDoc
\ No newline at end of file
+EncodedContent | @xmtp/react-native-sdk Type alias EncodedContent
EncodedGenerated using TypeDoc
\ No newline at end of file
diff --git a/types/EncryptedLocalAttachment.html b/types/EncryptedLocalAttachment.html
index 3201907cc..1c7860f4a 100644
--- a/types/EncryptedLocalAttachment.html
+++ b/types/EncryptedLocalAttachment.html
@@ -1 +1 @@
-EncryptedLocalAttachment | @xmtp/react-native-sdk Type alias EncryptedLocalAttachment
Type declaration
encrypted
metadata: RemoteAttachmentMetadata
Generated using TypeDoc
\ No newline at end of file
+EncryptedLocalAttachment | @xmtp/react-native-sdk Type alias EncryptedLocalAttachment
Type declaration
encrypted
metadata: RemoteAttachmentMetadata
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/NativeMessageContent.html b/types/NativeMessageContent.html
index eb521528b..4952201e1 100644
--- a/types/NativeMessageContent.html
+++ b/types/NativeMessageContent.html
@@ -1 +1 @@
-NativeMessageContent | @xmtp/react-native-sdk Type alias NativeMessageContent
Native
attachment?: StaticAttachmentContent;
encoded?: string;
reaction?: ReactionContent;
readReceipt?: ReadReceiptContent;
remoteAttachment?: RemoteAttachmentContent;
reply?: ReplyContent;
text?: string;
unknown?: UnknownContent;
}Type declaration
Optional attachment?: StaticAttachmentContent
Optional encoded?: string
Optional reaction?: ReactionContent
Optional read
Optional remote
Optional reply?: ReplyContent
Optional text?: string
Optional unknown?: UnknownContent
Generated using TypeDoc
\ No newline at end of file
+NativeMessageContent | @xmtp/react-native-sdk Type alias NativeMessageContent
Native
attachment?: StaticAttachmentContent;
encoded?: string;
reaction?: ReactionContent;
readReceipt?: ReadReceiptContent;
remoteAttachment?: RemoteAttachmentContent;
reply?: ReplyContent;
text?: string;
unknown?: UnknownContent;
}Type declaration
Optional attachment?: StaticAttachmentContent
Optional encoded?: string
Optional reaction?: ReactionContent
Optional read
Optional remote
Optional reply?: ReplyContent
Optional text?: string
Optional unknown?: UnknownContent
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/PreparedLocalMessage.html b/types/PreparedLocalMessage.html
index ad514b76f..95b0a8488 100644
--- a/types/PreparedLocalMessage.html
+++ b/types/PreparedLocalMessage.html
@@ -1 +1 @@
-PreparedLocalMessage | @xmtp/react-native-sdk Type alias PreparedLocalMessage
Prepared
messageId: string;
preparedAt: number;
preparedFileUri: `file://${string}`;
}Type declaration
message
prepared
prepared
Generated using TypeDoc
\ No newline at end of file
+PreparedLocalMessage | @xmtp/react-native-sdk Type alias PreparedLocalMessage
Prepared
messageId: string;
preparedAt: number;
preparedFileUri: `file://${string}`;
}Type declaration
message
prepared
prepared
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/Query.html b/types/Query.html
index 4e83f3cc6..33a02a639 100644
--- a/types/Query.html
+++ b/types/Query.html
@@ -1 +1 @@
-Query | @xmtp/react-native-sdk Type alias Query
Query: {
contentTopic: string;
direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING";
endTime?: number | Date;
pageSize?: number;
startTime?: number | Date;
}Type declaration
content
Optional direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
Optional end
Optional page
Optional start
Generated using TypeDoc
\ No newline at end of file
+Query | @xmtp/react-native-sdk Type alias Query
Query: {
contentTopic: string;
direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING";
endTime?: number | Date;
pageSize?: number;
startTime?: number | Date;
}Type declaration
content
Optional direction?: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
Optional end
Optional page
Optional start
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/ReactionContent.html b/types/ReactionContent.html
index a2cf2c722..dc39dcb1c 100644
--- a/types/ReactionContent.html
+++ b/types/ReactionContent.html
@@ -1 +1 @@
-ReactionContent | @xmtp/react-native-sdk Type alias ReactionContent
Reaction
action: "added" | "removed" | "unknown";
content: string;
reference: string;
schema: "unicode" | "shortcode" | "custom" | "unknown";
}Type declaration
action: "added" | "removed" | "unknown"
content: string
reference: string
schema: "unicode" | "shortcode" | "custom" | "unknown"
Generated using TypeDoc
\ No newline at end of file
+ReactionContent | @xmtp/react-native-sdk Type alias ReactionContent
Reaction
action: "added" | "removed" | "unknown";
content: string;
reference: string;
schema: "unicode" | "shortcode" | "custom" | "unknown";
}Type declaration
action: "added" | "removed" | "unknown"
content: string
reference: string
schema: "unicode" | "shortcode" | "custom" | "unknown"
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/ReadReceiptContent.html b/types/ReadReceiptContent.html
index e51cd9357..8bf2512ee 100644
--- a/types/ReadReceiptContent.html
+++ b/types/ReadReceiptContent.html
@@ -1 +1 @@
-ReadReceiptContent | @xmtp/react-native-sdk Type alias ReadReceiptContent
ReadGenerated using TypeDoc
\ No newline at end of file
+ReadReceiptContent | @xmtp/react-native-sdk Type alias ReadReceiptContent
ReadGenerated using TypeDoc
\ No newline at end of file
diff --git a/types/RemoteAttachmentContent.html b/types/RemoteAttachmentContent.html
index 10fdea74d..4e0ffd533 100644
--- a/types/RemoteAttachmentContent.html
+++ b/types/RemoteAttachmentContent.html
@@ -1 +1 @@
-RemoteAttachmentContent | @xmtp/react-native-sdk Type alias RemoteAttachmentContent
Type declaration
scheme: "https://"
url: string
Generated using TypeDoc
\ No newline at end of file
+RemoteAttachmentContent | @xmtp/react-native-sdk Type alias RemoteAttachmentContent
Type declaration
scheme: "https://"
url: string
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/RemoteAttachmentMetadata.html b/types/RemoteAttachmentMetadata.html
index 117b1d7dc..d76210c71 100644
--- a/types/RemoteAttachmentMetadata.html
+++ b/types/RemoteAttachmentMetadata.html
@@ -1 +1 @@
-RemoteAttachmentMetadata | @xmtp/react-native-sdk Type alias RemoteAttachmentMetadata
Remote
contentDigest: string;
contentLength?: string;
filename?: string;
nonce: string;
salt: string;
secret: string;
}Type declaration
content
Optional content
Optional filename?: string
nonce: string
salt: string
secret: string
Generated using TypeDoc
\ No newline at end of file
+RemoteAttachmentMetadata | @xmtp/react-native-sdk Type alias RemoteAttachmentMetadata
Remote
contentDigest: string;
contentLength?: string;
filename?: string;
nonce: string;
salt: string;
secret: string;
}Type declaration
content
Optional content
Optional filename?: string
nonce: string
salt: string
secret: string
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/ReplyContent.html b/types/ReplyContent.html
index fb150935b..7d0dfa55d 100644
--- a/types/ReplyContent.html
+++ b/types/ReplyContent.html
@@ -1 +1 @@
-ReplyContent | @xmtp/react-native-sdk Type alias ReplyContent
Reply
content: any;
contentType: string;
reference: string;
}Type declaration
content: any
content
reference: string
Generated using TypeDoc
\ No newline at end of file
+ReplyContent | @xmtp/react-native-sdk Type alias ReplyContent
Reply
content: any;
contentType: string;
reference: string;
}Type declaration
content: any
content
reference: string
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/StaticAttachmentContent.html b/types/StaticAttachmentContent.html
index 1bcf23644..16502e281 100644
--- a/types/StaticAttachmentContent.html
+++ b/types/StaticAttachmentContent.html
@@ -1 +1 @@
-StaticAttachmentContent | @xmtp/react-native-sdk Type alias StaticAttachmentContent
Static
data: string;
filename: string;
mimeType: string;
}Type declaration
data: string
filename: string
mime
Generated using TypeDoc
\ No newline at end of file
+StaticAttachmentContent | @xmtp/react-native-sdk Type alias StaticAttachmentContent
Static
data: string;
filename: string;
mimeType: string;
}Type declaration
data: string
filename: string
mime
Generated using TypeDoc
\ No newline at end of file
diff --git a/types/UnknownContent.html b/types/UnknownContent.html
index f2f0390e7..f6b3a4fc3 100644
--- a/types/UnknownContent.html
+++ b/types/UnknownContent.html
@@ -1 +1 @@
-UnknownContent | @xmtp/react-native-sdk Type alias UnknownContent
Unknown
contentTypeId: string;
}Type declaration
content
Generated using TypeDoc
\ No newline at end of file
+UnknownContent | @xmtp/react-native-sdk Type alias UnknownContent
Unknown
contentTypeId: string;
}Type declaration
content
Generated using TypeDoc
\ No newline at end of file
diff --git a/variables/emitter.html b/variables/emitter.html
index 50f05fcde..9d9c72f03 100644
--- a/variables/emitter.html
+++ b/variables/emitter.html
@@ -1 +1 @@
-emitter | @xmtp/react-native-sdk Variable emitterConst
emitter: EventEmitter = ...Generated using TypeDoc
\ No newline at end of file
+emitter | @xmtp/react-native-sdk Variable emitterConst
emitter: EventEmitter = ...Generated using TypeDoc
\ No newline at end of file
Determines whether the current user can send messages to a specified peer.
+