data class FfiCreateGroupOptions(var permissions: FfiGroupPermissionsOptions?, var groupName: String?, var groupImageUrlSquare: String?, var groupDescription: String?, var groupPinnedFrameUrl: String?, var customPermissionPolicySet: FfiPermissionPolicySet?, var messageExpirationFromMs: Long?, var messageExpirationMs: Long?)

FfiCursor

data class FfiCursor(var digest: ByteArray, var senderTimeNs: ULong)

FfiDeliveryStatus

enum FfiDeliveryStatus : Enum<FfiDeliveryStatus>

FfiDeviceSyncKind

enum FfiDeviceSyncKind : Enum<FfiDeviceSyncKind>

FfiDirection

enum FfiDirection : Enum<FfiDirection>

FfiEnvelope

data class FfiEnvelope(var contentTopic: String, var timestampNs: ULong, var message: ByteArray)

FfiGroupPermissions

open class FfiGroupPermissions : Disposable, AutoCloseable, FfiGroupPermissionsInterface

FfiGroupPermissionsInterface

interface FfiGroupPermissionsInterface

FfiGroupPermissionsOptions

enum FfiGroupPermissionsOptions : Enum<FfiGroupPermissionsOptions>

FfiHmacKey

data class FfiHmacKey(var key: ByteArray, var epoch: Long)

FfiInboxOwner

interface FfiInboxOwner

FfiInboxState

data class FfiInboxState(var inboxId: String, var recoveryAddress: String, var installations: List<FfiInstallation>, var accountAddresses: List<String>)

FfiInstallation

data class FfiInstallation(var id: ByteArray, var clientTimestampNs: ULong?)

FfiListConversationsOptions

data class FfiListConversationsOptions(var createdAfterNs: Long?, var createdBeforeNs: Long?, var limit: Long?, var consentStates: List<FfiConsentState>?, var includeDuplicateDms: Boolean)

FfiListMessagesOptions

data class FfiListMessagesOptions(var sentBeforeNs: Long?, var sentAfterNs: Long?, var limit: Long?, var deliveryStatus: FfiDeliveryStatus?, var direction: FfiDirection?, var contentTypes: List<FfiContentType>?)

FfiMessage

data class FfiMessage(var id: ByteArray, var sentAtNs: Long, var convoId: ByteArray, var senderInboxId: String, var content: ByteArray, var kind: FfiConversationMessageKind, var deliveryStatus: FfiDeliveryStatus)

FfiMessageCallback

interface FfiMessageCallback

FfiMessageCallbackImpl

open class FfiMessageCallbackImpl : Disposable, AutoCloseable, FfiMessageCallback

FfiMessageWithReactions

data class FfiMessageWithReactions(var message: FfiMessage, var reactions: List<FfiMessage>)

FfiMetadataField

enum FfiMetadataField : Enum<FfiMetadataField>

FfiPagingInfo

data class FfiPagingInfo(var limit: UInt, var cursor: FfiCursor?, var direction: FfiSortDirection)

FfiPermissionLevel

enum FfiPermissionLevel : Enum<FfiPermissionLevel>

FfiPermissionPolicy

enum FfiPermissionPolicy : Enum<FfiPermissionPolicy>

FfiPermissionPolicySet

data class FfiPermissionPolicySet(var addMemberPolicy: FfiPermissionPolicy, var removeMemberPolicy: FfiPermissionPolicy, var addAdminPolicy: FfiPermissionPolicy, var removeAdminPolicy: FfiPermissionPolicy, var updateGroupNamePolicy: FfiPermissionPolicy, var updateGroupDescriptionPolicy: FfiPermissionPolicy, var updateGroupImageUrlSquarePolicy: FfiPermissionPolicy, var updateGroupPinnedFrameUrlPolicy: FfiPermissionPolicy, var updateMessageExpirationMsPolicy: FfiPermissionPolicy)

FfiPermissionUpdateType

enum FfiPermissionUpdateType : Enum<FfiPermissionUpdateType>

FfiPreferenceCallback

interface FfiPreferenceCallback

FfiPreferenceCallbackImpl

open class FfiPreferenceCallbackImpl : Disposable, AutoCloseable, FfiPreferenceCallback

FfiPreferenceUpdate

sealed class FfiPreferenceUpdate

FfiPublishRequest

data class FfiPublishRequest(var envelopes: List<FfiEnvelope>)

FfiReaction

data class FfiReaction(var reference: String, var referenceInboxId: String, var action: FfiReactionAction, var content: String, var schema: FfiReactionSchema)

FfiReactionAction

enum FfiReactionAction : Enum<FfiReactionAction>

FfiReactionSchema

enum FfiReactionSchema : Enum<FfiReactionSchema>

FfiSignatureRequest

open class FfiSignatureRequest : Disposable, AutoCloseable, FfiSignatureRequestInterface

FfiSignatureRequestInterface

interface FfiSignatureRequestInterface

FfiSortDirection

enum FfiSortDirection : Enum<FfiSortDirection>

FfiStreamCloser

open class FfiStreamCloser : Disposable, AutoCloseable, FfiStreamCloserInterface

FfiStreamCloserInterface

interface FfiStreamCloserInterface

FfiSubscribeException

sealed class FfiSubscribeException : Exception

FfiV2ApiClient

open class FfiV2ApiClient : Disposable, AutoCloseable, FfiV2ApiClientInterface

FfiV2ApiClientInterface

interface FfiV2ApiClientInterface

FfiV2BatchQueryRequest

data class FfiV2BatchQueryRequest(var requests: List<FfiV2QueryRequest>)

FfiV2BatchQueryResponse

data class FfiV2BatchQueryResponse(var responses: List<FfiV2QueryResponse>)

FfiV2QueryRequest

data class FfiV2QueryRequest(var contentTopics: List<String>, var startTimeNs: ULong, var endTimeNs: ULong, var pagingInfo: FfiPagingInfo?)

FfiV2QueryResponse

data class FfiV2QueryResponse(var envelopes: List<FfiEnvelope>, var pagingInfo: FfiPagingInfo?)

FfiV2SubscribeRequest

data class FfiV2SubscribeRequest(var contentTopics: List<String>)

FfiV2Subscription

open class FfiV2Subscription : Disposable, AutoCloseable, FfiV2SubscriptionInterface

Subscription to a stream of V2 Messages

FfiV2SubscriptionCallback

interface FfiV2SubscriptionCallback

FfiV2SubscriptionCallbackImpl

open class FfiV2SubscriptionCallbackImpl : Disposable, AutoCloseable, FfiV2SubscriptionCallback

FfiV2SubscriptionInterface

interface FfiV2SubscriptionInterface

Subscription to a stream of V2 Messages

FfiXmtpClient

open class FfiXmtpClient : Disposable, AutoCloseable, FfiXmtpClientInterface

FfiXmtpClientInterface

interface FfiXmtpClientInterface

GenericException

sealed class GenericException : Exception

InternalException

class InternalException(message: String) : Exception

SigningException

sealed class SigningException : Exception

XmtpApiClient

open class XmtpApiClient : Disposable, AutoCloseable, XmtpApiClientInterface

XmtpApiClientInterface

interface XmtpApiClientInterface

Functions

connectToBackend

suspend fun connectToBackend(host: String, isSecure: Boolean): XmtpApiClient

createClient

suspend fun createClient(api: XmtpApiClient, db: String?, encryptionKey: ByteArray?, inboxId: String, accountAddress: String, nonce: ULong, legacySignedPrivateKeyProto: ByteArray?, historySyncUrl: String?): FfiXmtpClient

It returns a new client of the specified inbox_id. Note that the inbox_id must be either brand new or already associated with the account_address. i.e. inbox_id cannot be associated with another account address.

createV2Client