Class Client<ContentTypes>
Type Parameters
ContentTypes
Index
Constructors
constructor
+Client | @xmtp/react-native-sdk
codec
can
codec
can
decrypt
ConsentListEntry | @xmtp/react-native-sdk
entry
permission
Conversation | @xmtp/react-native-sdk
DecodedMessage | @xmtp/react-native-sdk
content
native
sender
ReactionCodec | @xmtp/react-native-sdk
content
content
ReadReceiptCodec | @xmtp/react-native-sdk
content
content
RemoteAttachmentCodec | @xmtp/react-native-sdk
content
content
ReplyCodec | @xmtp/react-native-sdk
content
content
StaticAttachmentCodec | @xmtp/react-native-sdk
content
content
TextCodec | @xmtp/react-native-sdk
content
content
XMTPPush | @xmtp/react-native-sdk
address | @xmtp/react-native-sdk address | @xmtp/react-native-sdk allowContacts | @xmtp/react-native-sdk allowContacts | @xmtp/react-native-sdk auth | @xmtp/react-native-sdk auth | @xmtp/react-native-sdk canMessage | @xmtp/react-native-sdk canMessage | @xmtp/react-native-sdk consentList | @xmtp/react-native-sdk consentList | @xmtp/react-native-sdk conversationConsentState | @xmtp/react-native-sdk conversationConsentState | @xmtp/react-native-sdk createConversation | @xmtp/react-native-sdk createConversation | @xmtp/react-native-sdk createFromKeyBundle | @xmtp/react-native-sdk createFromKeyBundle | @xmtp/react-native-sdk createRandom | @xmtp/react-native-sdk createRandom | @xmtp/react-native-sdk decodeMessage | @xmtp/react-native-sdk decodeMessage | @xmtp/react-native-sdk decryptAttachment | @xmtp/react-native-sdk decryptAttachment | @xmtp/react-native-sdk denyContacts | @xmtp/react-native-sdk denyContacts | @xmtp/react-native-sdk encryptAttachment | @xmtp/react-native-sdk encryptAttachment | @xmtp/react-native-sdk exportConversationTopicData | @xmtp/react-native-sdk exportConversationTopicData | @xmtp/react-native-sdk exportKeyBundle | @xmtp/react-native-sdk exportKeyBundle | @xmtp/react-native-sdk importConversationTopicData | @xmtp/react-native-sdk importConversationTopicData | @xmtp/react-native-sdk isAllowed | @xmtp/react-native-sdk isAllowed | @xmtp/react-native-sdk isDenied | @xmtp/react-native-sdk isDenied | @xmtp/react-native-sdk listBatchMessages | @xmtp/react-native-sdk listBatchMessages | @xmtp/react-native-sdk listConversations | @xmtp/react-native-sdk listConversations | @xmtp/react-native-sdk listMessages | @xmtp/react-native-sdk listMessages | @xmtp/react-native-sdk prepareMessage | @xmtp/react-native-sdk prepareMessage | @xmtp/react-native-sdk receiveSignature | @xmtp/react-native-sdk receiveSignature | @xmtp/react-native-sdk refreshConsentList | @xmtp/react-native-sdk refreshConsentList | @xmtp/react-native-sdk registerPushToken | @xmtp/react-native-sdk registerPushToken | @xmtp/react-native-sdk sendMessage | @xmtp/react-native-sdk sendMessage | @xmtp/react-native-sdk sendPreparedMessage | @xmtp/react-native-sdk sendPreparedMessage | @xmtp/react-native-sdk sendWithContentType | @xmtp/react-native-sdk sendWithContentType | @xmtp/react-native-sdk staticCanMessage | @xmtp/react-native-sdk staticCanMessage | @xmtp/react-native-sdk subscribePushTopics | @xmtp/react-native-sdk subscribePushTopics | @xmtp/react-native-sdk subscribeToAllMessages | @xmtp/react-native-sdk subscribeToAllMessages | @xmtp/react-native-sdk subscribeToConversations | @xmtp/react-native-sdk subscribeToConversations | @xmtp/react-native-sdk subscribeToMessages | @xmtp/react-native-sdk subscribeToMessages | @xmtp/react-native-sdk unsubscribeFromAllMessages | @xmtp/react-native-sdk unsubscribeFromAllMessages | @xmtp/react-native-sdk unsubscribeFromConversations | @xmtp/react-native-sdk unsubscribeFromConversations | @xmtp/react-native-sdk unsubscribeFromMessages | @xmtp/react-native-sdk unsubscribeFromMessages | @xmtp/react-native-sdk
Class Client<ContentTypes>
Type Parameters
ContentTypes
Index
Constructors
Properties
Constructors
constructor
- new
Client<ContentTypes>(address, codecs?): Client<ContentTypes> Type Parameters
ContentTypes
Parameters
address: string
codecs: ContentCodec<ContentTypes>[] = []
Returns Client<ContentTypes>
Properties
address
address: string
codec
Type declaration
[key: string]: ContentCodec<unknown>
contacts
contacts: default
conversations
conversations: default<ContentTypes>
Methods
can
Constructors
constructor
- new
Client<ContentTypes>(address, codecs?): Client<ContentTypes> Type Parameters
ContentTypes
Parameters
address: string
codecs: ContentCodec<ContentTypes>[] = []
Returns Client<ContentTypes>
Properties
address
address: string
codec
Type declaration
[key: string]: ContentCodec<unknown>
contacts
contacts: default
conversations
conversations: default<ContentTypes>
Methods
can
- can
Message(peerAddress): Promise<boolean> 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).
Parameters
peerAddress: string
The address of the peer to check for messaging eligibility.
Returns Promise<boolean>
A Promise resolving to true if messaging is allowed, and false otherwise.
-
decrypt
- decrypt
Attachment(encryptedFile): Promise<DecryptedLocalAttachment> Decrypts an encrypted local attachment.
+decrypt
Attachment - decrypt
Attachment(encryptedFile): Promise<DecryptedLocalAttachment> Decrypts an encrypted local attachment.
This asynchronous method takes an encrypted local attachment and decrypts it.
Parameters
encryptedFile: EncryptedLocalAttachment
The encrypted local attachment to be decrypted.
Returns Promise<DecryptedLocalAttachment>
A Promise that resolves to the decrypted local attachment.
Throws
Throws an error if the attachment is not a local file URI (must start with "file://").
-
encrypt
Attachment - encrypt
Attachment(file): Promise<EncryptedLocalAttachment> Encrypts a local attachment for secure transmission.
+
encrypt
Attachment - encrypt
Attachment(file): Promise<EncryptedLocalAttachment> Encrypts a local attachment for secure transmission.
This asynchronous method takes a file, checks if it's a local file URI, and encrypts the attachment for secure transmission.
Parameters
file: DecryptedLocalAttachment
The local attachment to be encrypted.
Returns Promise<EncryptedLocalAttachment>
A Promise that resolves to the encrypted local attachment.
Throws
Throws an error if the attachment is not a local file URI (must start with "file://").
-
export
Key Bundle export
Key Bundle - export
Key Bundle(): Promise<string> 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.
Returns Promise<string>
A Promise that resolves to the unencrypted key bundle for the current XMTP address.
-
list
Batch Messages - list
Batch Messages(queries): Promise<DecodedMessage<any>[]> Retrieves a list of batch messages based on the provided queries.
+list
Batch Messages - list
Batch Messages(queries): Promise<DecodedMessage<any>[]> 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.
Parameters
queries: Query[]
An array of queries to filter the batch messages.
Returns Promise<DecodedMessage<any>[]>
A Promise that resolves to a list of batch messages.
Throws
The error is logged, and the method gracefully returns an empty array.
-
register
- register<T, Codec>(contentCodec): void
Type Parameters
T
Codec extends ContentCodec<T>
Parameters
contentCodec: Codec
Returns void
send
Prepared Message register
- register<T, Codec>(contentCodec): void
Type Parameters
T
Codec extends ContentCodec<T>
Parameters
contentCodec: Codec
Returns void
send
Prepared Message - send
Prepared Message(prepared): Promise<string> Sends a prepared message.
Parameters
prepared: PreparedLocalMessage
The prepared local message to be sent.
Returns Promise<string>
A Promise that resolves to a string identifier for the sent message.
Throws
Throws an error if there is an issue with sending the prepared message.
-
StaticcanMessage StaticcanMessage - can
Message(peerAddress, opts?): Promise<boolean> Static method to determine if the address is currently in our network.
This method checks if the specified peer has signed up for XMTP.
Parameters
peerAddress: string
The address of the peer to check for messaging eligibility.
Optionalopts: Partial<NetworkOptions>Optional configuration options for the Client.
-
Returns Promise<boolean>
StaticcreateReturns Promise<boolean>
- list
Staticcreate- create<ContentCodecs>(signer, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>
Creates a new instance of the Client class using the provided signer.
Type Parameters
ContentCodecs extends ContentCodec<any>[] = []
Parameters
signer: Signer
The signer object used for authentication and message signing.
Optionalopts: Partial<NetworkOptions> & {
codecs?: ContentCodecs;
}Optional configuration options for the Client.
Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>
A Promise that resolves to a new Client instance.
See XMTP Docs for more information.
-
StaticcreateFrom Key Bundle - create
From Key Bundle<ContentCodecs>(keyBundle, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>> Creates a new instance of the Client class from a provided key bundle.
+StaticcreateFrom Key Bundle - create
From Key Bundle<ContentCodecs>(keyBundle, opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>> Creates 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.
Type Parameters
ContentCodecs extends ContentCodec<any>[] = []
Parameters
keyBundle: string
The key bundle used for address generation.
Optionalopts: Partial<NetworkOptions> & {
codecs?: ContentCodecs;
}Optional configuration options for the Client.
Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>
A Promise that resolves to a new Client instance based on the provided key bundle.
-
StaticcreateRandom - create
Random<ContentCodecs>(opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>> Creates a new instance of the XMTP Client with a randomly generated address.
+StaticcreateRandom - create
Random<ContentCodecs>(opts?): Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>> Creates a new instance of the XMTP Client with a randomly generated address.
Type Parameters
ContentCodecs extends ContentCodec<any>[] = []
Parameters
Optionalopts: Partial<NetworkOptions> & {
codecs?: ContentCodecs;
}Optional configuration options for the Client.
Returns Promise<Client<undefined | ExtractDecodedType<[...ContentCodecs[], TextCodec][number]>>>
A Promise that resolves to a new Client instance with a random address.
-
- create
\ No newline at end of file +Generated using TypeDoc
- create
- decrypt
Generated using TypeDoc
Class ConsentListEntry
Index
Constructors
constructor
+ConsentListEntry | @xmtp/react-native-sdk
entry
permission
Class ConsentListEntry
Index
Constructors
constructor
- new
Consent List Entry(value, entryType, permissionType): ConsentListEntry Parameters
value: string
entryType: "address"
permissionType: ConsentState
Returns ConsentListEntry
Properties
entry
entry
permission
permission
value
value: string
Methods
Static from
- from(json): ConsentListEntry
Parameters
json: string
Returns ConsentListEntry
Generated using TypeDoc
Constructors
constructor
- new
Consent List Entry(value, entryType, permissionType): ConsentListEntry Parameters
value: string
entryType: "address"
permissionType: ConsentState
Returns ConsentListEntry
Properties
entry
entry
permission
permission
value
value: string
Methods
Static from
- from(json): ConsentListEntry
Parameters
json: string
Returns ConsentListEntry
Generated using TypeDoc
Class Conversation<ContentTypes>
Type Parameters
ContentTypes
Index
Constructors
constructor
+Conversation | @xmtp/react-native-sdk
created
peer
client
consent
created
peer
client
consent
decode
Class Conversation<ContentTypes>
Type Parameters
ContentTypes
Index
Constructors
Properties
Constructors
constructor
- new
Conversation<ContentTypes>(client, params): Conversation<ContentTypes> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
params: {
context?: ConversationContext;
conversationID?: string;
createdAt: number;
peerAddress: string;
topic: string;
version: string;
}Optionalcontext?: ConversationContextOptionalconversationID?: stringcreated
At: number peer
Address: string topic: string
version: string
Returns Conversation<ContentTypes>
Properties
client
Optional context
Optional conversationID
conversationID?: string
created
created
peer
peer
topic
topic: string
version
version: string
Accessors
client
- get clientAddress(): string
Returns string
Methods
consent
Constructors
constructor
- new
Conversation<ContentTypes>(client, params): Conversation<ContentTypes> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
params: {
context?: ConversationContext;
conversationID?: string;
createdAt: number;
peerAddress: string;
topic: string;
version: string;
}Optionalcontext?: ConversationContextOptionalconversationID?: stringcreated
At: number peer
Address: string topic: string
version: string
Returns Conversation<ContentTypes>
Properties
client
Optional context
Optional conversationID
conversationID?: string
created
created
peer
peer
topic
topic: string
version
version: string
Accessors
client
- get clientAddress(): string
Returns string
Methods
consent
- consent
State(): Promise<"allowed" | "denied" | "unknown"> Retrieves 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.
Returns Promise<"allowed" | "denied" | "unknown">
A Promise that resolves to the consent state, which can be "allowed," "denied," or "unknown."
-
decode
- decode
Message(encryptedMessage): Promise<DecodedMessage<any>> Decodes an encrypted message, yielding a
+DecodedMessageobject.decode
Message - decode
Message(encryptedMessage): Promise<DecodedMessage<any>> Decodes an encrypted message, yielding a
DecodedMessageobject.This asynchronous method takes an encrypted message and decodes it. The result is a
DecodedMessageobject containing the decoded content and metadata.Parameters
encryptedMessage: string
The encrypted message to be decoded.
Returns Promise<DecodedMessage<any>>
A Promise that resolves to a
DecodedMessageobject.Throws
Throws an error if there is an issue with decoding the message.
-
export
Topic Data messages
- messages(limit?, before?, after?, direction?): Promise<DecodedMessage<ContentTypes>[]>
Lists messages in a conversation with optional filters.
+
export
Topic Data messages
- messages(limit?, before?, after?, direction?): Promise<DecodedMessage<ContentTypes>[]>
Lists messages in a conversation with optional filters.
Parameters
Optionallimit: numberOptional limit to the number of messages to return.
Optionalbefore: number | DateOptional timestamp to filter messages before.
Optionalafter: number | DateOptional timestamp to filter messages after.
@@ -34,7 +34,7 @@
Returns Promise<DecodedMessage<ContentTypes>[]>
A Promise that resolves to an array of decoded messages.
Throws
Throws an error if there is an issue with listing messages.
Todo
Support pagination and conversation ID in future implementations.
-
prepare
Message - prepare
Message(content): Promise<PreparedLocalMessage> Prepares a message to be sent, yielding a
+PreparedLocalMessageobject.
prepare
Message - prepare
Message(content): Promise<PreparedLocalMessage> Prepares a message to be sent, yielding a
PreparedLocalMessageobject.Instead of immediately sending a message, you can prepare it first using this method. This yields a
PreparedLocalMessageobject, which you can send later. This is useful to help construct a robust pending-message queue @@ -44,18 +44,18 @@Todo
Support pagination and conversation ID in future implementations
Parameters
content: any
The content of the message. It can be either a string or a structured MessageContent object.
Returns Promise<PreparedLocalMessage>
A Promise that resolves to a
PreparedLocalMessageobject.Throws
Throws an error if there is an issue with preparing the message.
-
send
send
- send(content, opts?): Promise<string>
Sends a message to the current conversation.
Parameters
content: any
The content of the message. It can be either a string or a structured MessageContent object.
Optionalopts: SendOptions
Returns Promise<string>
A Promise that resolves to a string identifier for the sent message.
Throws
Throws an error if there is an issue with sending the message.
Todo
Support specifying a conversation ID in future implementations.
-
send
Prepared Message send
Prepared Message - send
Prepared Message(prepared): Promise<string> Sends a prepared local message.
This asynchronous method takes a
PreparedLocalMessageand sends it. Prepared messages are created using theprepareMessagemethod.Parameters
prepared: PreparedLocalMessage
The prepared local message to be sent.
Returns Promise<string>
A Promise that resolves to a string identifier for the sent message.
Throws
Throws an error if there is an issue with sending the prepared message.
-
stream
Messages stream
Messages - stream
Messages(callback): (() => void) 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 @@Todo
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.
Returns void
A function that, when called, unsubscribes from the message stream and ends real-time updates.
-
- decode
Generated using TypeDoc
Generated using TypeDoc
Class DecodedMessage<ContentTypes>
Type Parameters
ContentTypes = any
Index
Constructors
constructor
+DecodedMessage | @xmtp/react-native-sdk
content
native
sender
Class DecodedMessage<ContentTypes>
Type Parameters
ContentTypes = any
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Decoded Message<ContentTypes>(client, id, topic, contentTypeId, senderAddress, sent, content, fallback): DecodedMessage<ContentTypes> Type Parameters
ContentTypes = any
Parameters
client: Client<ContentTypes>
id: string
topic: string
contentTypeId: string
senderAddress: string
sent: number
content: any
fallback: undefined | string
Returns DecodedMessage<ContentTypes>
Properties
client
content
content
fallback
fallback: undefined | string
id
id: string
native
sender
sender
sent
sent: number
topic
topic: string
Methods
content
Static from
- from<ContentTypes>(json, client): DecodedMessage<any>
Type Parameters
ContentTypes
Parameters
json: string
client: Client<ContentTypes>
Returns DecodedMessage<any>
Static from
- from
Object<ContentTypes>(object, client): DecodedMessage<ContentTypes> Type Parameters
ContentTypes
Parameters
object: {
content: any;
contentTypeId: string;
fallback: undefined | string;
id: string;
senderAddress: string;
sent: number;
topic: string;
}content: any
content
Type Id: string fallback: undefined | string
id: string
sender
Address: string sent: number
topic: string
client: Client<ContentTypes>
Returns DecodedMessage<ContentTypes>
Generated using TypeDoc
Constructors
constructor
- new
Decoded Message<ContentTypes>(client, id, topic, contentTypeId, senderAddress, sent, content, fallback): DecodedMessage<ContentTypes> Type Parameters
ContentTypes = any
Parameters
client: Client<ContentTypes>
id: string
topic: string
contentTypeId: string
senderAddress: string
sent: number
content: any
fallback: undefined | string
Returns DecodedMessage<ContentTypes>
Properties
client
content
content
fallback
fallback: undefined | string
id
id: string
native
sender
sender
sent
sent: number
topic
topic: string
Methods
content
Static from
- from<ContentTypes>(json, client): DecodedMessage<any>
Type Parameters
ContentTypes
Parameters
json: string
client: Client<ContentTypes>
Returns DecodedMessage<any>
Static from
- from
Object<ContentTypes>(object, client): DecodedMessage<ContentTypes> Type Parameters
ContentTypes
Parameters
object: {
content: any;
contentTypeId: string;
fallback: undefined | string;
id: string;
senderAddress: string;
sent: number;
topic: string;
}content: any
content
Type Id: string fallback: undefined | string
id: string
sender
Address: string sent: number
topic: string
client: Client<ContentTypes>
Returns DecodedMessage<ContentTypes>
Generated using TypeDoc
Class ReactionCodec
Implements
Index
Constructors
constructor
+ReactionCodec | @xmtp/react-native-sdk
content
content
Class ReactionCodec
Implements
Index
Constructors
constructor
- new
Reaction Codec(): ReactionCodec Returns ReactionCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): ReactionContent
Parameters
nativeContent: NativeMessageContent
Returns ReactionContent
encode
- encode(content): NativeMessageContent
Parameters
content: ReactionContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: ReactionContent
Returns undefined | string
Generated using TypeDoc
Constructors
constructor
- new
Reaction Codec(): ReactionCodec Returns ReactionCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): ReactionContent
Parameters
nativeContent: NativeMessageContent
Returns ReactionContent
encode
- encode(content): NativeMessageContent
Parameters
content: ReactionContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: ReactionContent
Returns undefined | string
Generated using TypeDoc
Class ReadReceiptCodec
Implements
Index
Constructors
constructor
+ReadReceiptCodec | @xmtp/react-native-sdk
content
content
Class ReadReceiptCodec
Implements
Index
Constructors
constructor
- new
Read Receipt Codec(): ReadReceiptCodec Returns ReadReceiptCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): object
Parameters
nativeContent: NativeMessageContent
Returns object
encode
- encode(content): NativeMessageContent
Parameters
content: object
Returns NativeMessageContent
fallback
Generated using TypeDoc
Constructors
constructor
- new
Read Receipt Codec(): ReadReceiptCodec Returns ReadReceiptCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): object
Parameters
nativeContent: NativeMessageContent
Returns object
encode
- encode(content): NativeMessageContent
Parameters
content: object
Returns NativeMessageContent
fallback
Generated using TypeDoc
Class RemoteAttachmentCodec
Implements
Index
Constructors
constructor
+RemoteAttachmentCodec | @xmtp/react-native-sdk
content
content
Class RemoteAttachmentCodec
Implements
Index
Constructors
constructor
- new
Remote Attachment Codec(): RemoteAttachmentCodec Returns RemoteAttachmentCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): RemoteAttachmentContent
Parameters
nativeContent: NativeMessageContent
Returns RemoteAttachmentContent
encode
- encode(content): NativeMessageContent
Parameters
content: RemoteAttachmentContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: RemoteAttachmentContent
Returns undefined | string
Generated using TypeDoc
Constructors
constructor
- new
Remote Attachment Codec(): RemoteAttachmentCodec Returns RemoteAttachmentCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): RemoteAttachmentContent
Parameters
nativeContent: NativeMessageContent
Returns RemoteAttachmentContent
encode
- encode(content): NativeMessageContent
Parameters
content: RemoteAttachmentContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: RemoteAttachmentContent
Returns undefined | string
Generated using TypeDoc
Class ReplyCodec
Implements
- NativeContentCodec<ReplyContent>
Index
Constructors
constructor
+ReplyCodec | @xmtp/react-native-sdk
content
content
Class ReplyCodec
Implements
- NativeContentCodec<ReplyContent>
Index
Constructors
constructor
- new
Reply Codec(): ReplyCodec Returns ReplyCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): ReplyContent
Parameters
nativeContent: NativeMessageContent
Returns ReplyContent
encode
- encode(content): NativeMessageContent
Parameters
content: ReplyContent
Returns NativeMessageContent
fallback
Generated using TypeDoc
Constructors
constructor
- new
Reply Codec(): ReplyCodec Returns ReplyCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): ReplyContent
Parameters
nativeContent: NativeMessageContent
Returns ReplyContent
encode
- encode(content): NativeMessageContent
Parameters
content: ReplyContent
Returns NativeMessageContent
fallback
Generated using TypeDoc
Class StaticAttachmentCodec
Implements
Index
Constructors
constructor
+StaticAttachmentCodec | @xmtp/react-native-sdk
content
content
Class StaticAttachmentCodec
Implements
Index
Constructors
constructor
- new
Static Attachment Codec(): StaticAttachmentCodec Returns StaticAttachmentCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): StaticAttachmentContent
Parameters
nativeContent: NativeMessageContent
Returns StaticAttachmentContent
encode
- encode(content): NativeMessageContent
Parameters
content: StaticAttachmentContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: StaticAttachmentContent
Returns undefined | string
Generated using TypeDoc
Constructors
constructor
- new
Static Attachment Codec(): StaticAttachmentCodec Returns StaticAttachmentCodec
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): StaticAttachmentContent
Parameters
nativeContent: NativeMessageContent
Returns StaticAttachmentContent
encode
- encode(content): NativeMessageContent
Parameters
content: StaticAttachmentContent
Returns NativeMessageContent
fallback
- fallback(content): undefined | string
Parameters
content: StaticAttachmentContent
Returns undefined | string
Generated using TypeDoc
Class TextCodec
Implements
- NativeContentCodec<string>
Index
Constructors
constructor
+TextCodec | @xmtp/react-native-sdk
content
content
Class TextCodec
Implements
- NativeContentCodec<string>
Index
Constructors
constructor
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): string
Parameters
nativeContent: NativeMessageContent
Returns string
encode
- encode(content): NativeMessageContent
Parameters
content: string
Returns NativeMessageContent
fallback
Generated using TypeDoc
Constructors
constructor
Properties
content
content
content
content
Methods
decode
- decode(nativeContent): string
Parameters
nativeContent: NativeMessageContent
Returns string
encode
- encode(content): NativeMessageContent
Parameters
content: string
Returns NativeMessageContent
fallback
Generated using TypeDoc
Class XMTPPush
Index
Constructors
constructor
+XMTPPush | @xmtp/react-native-sdk
Generated using TypeDoc
Constructors
constructor
Methods
Static register
Static subscribe
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
Function consentList
- consent
List(clientAddress): Promise<ConsentListEntry[]> Parameters
clientAddress: string
Returns Promise<ConsentListEntry[]>
Generated using TypeDoc
Function consentList
- consent
List(clientAddress): Promise<ConsentListEntry[]> Parameters
clientAddress: string
Returns Promise<ConsentListEntry[]>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function createConversation
- create
Conversation<ContentTypes>(client, peerAddress, context?): Promise<Conversation<ContentTypes>> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
peerAddress: string
Optionalcontext: ConversationContext
Returns Promise<Conversation<ContentTypes>>
Generated using TypeDoc
Function createConversation
- create
Conversation<ContentTypes>(client, peerAddress, context?): Promise<Conversation<ContentTypes>> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
peerAddress: string
Optionalcontext: ConversationContext
Returns Promise<Conversation<ContentTypes>>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function decodeMessage
- decode
Message(clientAddress, topic, encryptedMessage): Promise<DecodedMessage> Parameters
clientAddress: string
topic: string
encryptedMessage: string
Returns Promise<DecodedMessage>
Generated using TypeDoc
Function decodeMessage
- decode
Message(clientAddress, topic, encryptedMessage): Promise<DecodedMessage> Parameters
clientAddress: string
topic: string
encryptedMessage: string
Returns Promise<DecodedMessage>
Generated using TypeDoc
Function decryptAttachment
- decrypt
Attachment(clientAddress, encryptedFile): Promise<DecryptedLocalAttachment> Parameters
clientAddress: string
encryptedFile: EncryptedLocalAttachment
Returns Promise<DecryptedLocalAttachment>
Generated using TypeDoc
Function decryptAttachment
- decrypt
Attachment(clientAddress, encryptedFile): Promise<DecryptedLocalAttachment> Parameters
clientAddress: string
encryptedFile: EncryptedLocalAttachment
Returns Promise<DecryptedLocalAttachment>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function encryptAttachment
- encrypt
Attachment(clientAddress, file): Promise<EncryptedLocalAttachment> Parameters
clientAddress: string
file: DecryptedLocalAttachment
Returns Promise<EncryptedLocalAttachment>
Generated using TypeDoc
Function encryptAttachment
- encrypt
Attachment(clientAddress, file): Promise<EncryptedLocalAttachment> Parameters
clientAddress: string
file: DecryptedLocalAttachment
Returns Promise<EncryptedLocalAttachment>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function importConversationTopicData
- import
Conversation Topic Data<ContentTypes>(client, topicData): Promise<Conversation<ContentTypes>> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
topicData: string
Returns Promise<Conversation<ContentTypes>>
Generated using TypeDoc
Function importConversationTopicData
- import
Conversation Topic Data<ContentTypes>(client, topicData): Promise<Conversation<ContentTypes>> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
topicData: string
Returns Promise<Conversation<ContentTypes>>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function listBatchMessages
- list
Batch Messages<ContentTypes>(client, queries): Promise<DecodedMessage[]> Type Parameters
ContentTypes
Returns Promise<DecodedMessage[]>
Generated using TypeDoc
Function listBatchMessages
- list
Batch Messages<ContentTypes>(client, queries): Promise<DecodedMessage[]> Type Parameters
ContentTypes
Returns Promise<DecodedMessage[]>
Generated using TypeDoc
Function listConversations
- list
Conversations<ContentTypes>(client): Promise<Conversation<ContentTypes>[]> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
Returns Promise<Conversation<ContentTypes>[]>
Generated using TypeDoc
Function listConversations
- list
Conversations<ContentTypes>(client): Promise<Conversation<ContentTypes>[]> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
Returns Promise<Conversation<ContentTypes>[]>
Generated using TypeDoc
Function listMessages
- list
Messages<ContentTypes>(client, conversationTopic, limit?, before?, after?, direction?): Promise<DecodedMessage[]> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
conversationTopic: string
Optionallimit: numberOptionalbefore: number | DateOptionalafter: number | DateOptionaldirection: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
Returns Promise<DecodedMessage[]>
Generated using TypeDoc
Function listMessages
- list
Messages<ContentTypes>(client, conversationTopic, limit?, before?, after?, direction?): Promise<DecodedMessage[]> Type Parameters
ContentTypes
Parameters
client: Client<ContentTypes>
conversationTopic: string
Optionallimit: numberOptionalbefore: number | DateOptionalafter: number | DateOptionaldirection: "SORT_DIRECTION_ASCENDING" | "SORT_DIRECTION_DESCENDING"
Returns Promise<DecodedMessage[]>
Generated using TypeDoc
Function prepareMessage
- prepare
Message(clientAddress, conversationTopic, content): Promise<PreparedLocalMessage> Parameters
clientAddress: string
conversationTopic: string
content: any
Returns Promise<PreparedLocalMessage>
Generated using TypeDoc
Function prepareMessage
- prepare
Message(clientAddress, conversationTopic, content): Promise<PreparedLocalMessage> Parameters
clientAddress: string
conversationTopic: string
content: any
Returns Promise<PreparedLocalMessage>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function refreshConsentList
- refresh
Consent List(clientAddress): Promise<ConsentListEntry[]> Parameters
clientAddress: string
Returns Promise<ConsentListEntry[]>
Generated using TypeDoc
Function refreshConsentList
- refresh
Consent List(clientAddress): Promise<ConsentListEntry[]> Parameters
clientAddress: string
Returns Promise<ConsentListEntry[]>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function sendPreparedMessage
- send
Prepared Message(clientAddress, preparedLocalMessage): Promise<string> Parameters
clientAddress: string
preparedLocalMessage: PreparedLocalMessage
Returns Promise<string>
Generated using TypeDoc
Function sendPreparedMessage
- send
Prepared Message(clientAddress, preparedLocalMessage): Promise<string> Parameters
clientAddress: string
preparedLocalMessage: PreparedLocalMessage
Returns Promise<string>
Generated using TypeDoc
Function sendWithContentType
- send
With Content Type<T>(clientAddress, conversationTopic, content, codec): Promise<string> Type Parameters
T
Parameters
clientAddress: string
conversationTopic: string
content: T
codec: ContentCodec<T>
Returns Promise<string>
Generated using TypeDoc
Function sendWithContentType
- send
With Content Type<T>(clientAddress, conversationTopic, content, codec): Promise<string> Type Parameters
T
Parameters
clientAddress: string
conversationTopic: string
content: T
codec: ContentCodec<T>
Returns Promise<string>
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
To learn more about XMTP and get answers to frequently asked questions, see XMTP documentation.
Reference docs
Access the xmtp-react-native client SDK reference documentation.
Example app
Use the XMTP React Native example app as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.
-Follow the React Native guide to set up a CLI environment.
-To use the example app, run:
-cd example
npm install --force
npm run [ios or android]
+Example app
Use the XMTP React Native example app as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with. See example/README.md for more instructions.
+Quickstart to use the example app:
Follow the React Native guide to set up a CLI environment.
+npm install
cd example
npm install --force
npm run [ios or android]
Install in a managed Expo project
npx expo prebuild
@@ -183,4 +182,4 @@
The production network is configured to store messages indefinitely. XMTP may occasionally delete messages and keys from the dev network, and will provide advance notice in the XMTP Discord community.
-Generated using TypeDoc
Determines whether the current user can send messages to a specified peer.
+