library/uniffi.xmtpv3

Package-level declarations

Types

data class FfiApiStats(var uploadKeyPackage: ULong, var fetchKeyPackage: ULong, var sendGroupMessages: ULong, var sendWelcomeMessages: ULong, var queryGroupMessages: ULong, var queryWelcomeMessages: ULong, var subscribeMessages: ULong, var subscribeWelcomes: ULong)

FfiArchiveOptions

data class FfiArchiveOptions(var startNs: Long?, var endNs: Long?, var elements: List<FfiBackupElementSelection>)

FfiBackupElementSelection

enum FfiBackupElementSelection : Enum<FfiBackupElementSelection>

FfiBackupMetadata

data class FfiBackupMetadata(var backupVersion: UShort, var elements: List<FfiBackupElementSelection>, var exportedAtNs: Long, var startNs: Long?, var endNs: Long?)

FfiConsent

data class FfiConsent(var entityType: FfiConsentEntityType, var state: FfiConsentState, var entity: String)

FfiConsentCallback

interface FfiConsentCallback

FfiConsentCallbackImpl

open class FfiConsentCallbackImpl : Disposable, AutoCloseable, FfiConsentCallback

FfiConsentEntityType

enum FfiConsentEntityType : Enum<FfiConsentEntityType>

FfiConsentState

enum FfiConsentState : Enum<FfiConsentState>

FfiContentType

enum FfiContentType : Enum<FfiContentType>

FfiConversation

open class FfiConversation : Disposable, AutoCloseable, FfiConversationInterface

FfiConversationCallback

interface FfiConversationCallback

FfiConversationCallbackImpl

open class FfiConversationCallbackImpl : Disposable, AutoCloseable, FfiConversationCallback

FfiConversationDebugInfo

data class FfiConversationDebugInfo(var epoch: ULong, var maybeForked: Boolean, var forkDetails: String, var isCommitLogForked: Boolean?, var localCommitLog: String, var remoteCommitLog: String, var cursor: Long)

FfiConversationInterface

interface FfiConversationInterface

FfiConversationListItem

open class FfiConversationListItem : Disposable, AutoCloseable, FfiConversationListItemInterface

FfiConversationListItemInterface

interface FfiConversationListItemInterface

FfiConversationMember

data class FfiConversationMember(var inboxId: String, var accountIdentifiers: List<FfiIdentifier>, var installationIds: List<ByteArray>, var permissionLevel: FfiPermissionLevel, var consentState: FfiConsentState)

FfiConversationMessageKind

enum FfiConversationMessageKind : Enum<FfiConversationMessageKind>

FfiConversationMetadata

open class FfiConversationMetadata : Disposable, AutoCloseable, FfiConversationMetadataInterface

FfiConversationMetadataInterface

interface FfiConversationMetadataInterface

FfiConversations

open class FfiConversations : Disposable, AutoCloseable, FfiConversationsInterface

FfiConversationsInterface

interface FfiConversationsInterface

FfiConversationType

enum FfiConversationType : Enum<FfiConversationType>

FfiCreateDmOptions

data class FfiCreateDmOptions(var messageDisappearingSettings: FfiMessageDisappearingSettings?)

FfiCreateGroupOptions

data class FfiCreateGroupOptions(var permissions: FfiGroupPermissionsOptions?, var groupName: String?, var groupImageUrlSquare: String?, var groupDescription: String?, var customPermissionPolicySet: FfiPermissionPolicySet?, var messageDisappearingSettings: FfiMessageDisappearingSettings?)

FfiDeliveryStatus

enum FfiDeliveryStatus : Enum<FfiDeliveryStatus>

FfiDirection

enum FfiDirection : Enum<FfiDirection>

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)

FfiIdentifier

data class FfiIdentifier(var identifier: String, var identifierKind: FfiIdentifierKind)

FfiIdentifierKind

enum FfiIdentifierKind : Enum<FfiIdentifierKind>

FfiIdentityStats

data class FfiIdentityStats(var publishIdentityUpdate: ULong, var getIdentityUpdatesV2: ULong, var getInboxIds: ULong, var verifySmartContractWalletSignature: ULong)

FfiInboxOwner

interface FfiInboxOwner

FfiInboxOwnerImpl

open class FfiInboxOwnerImpl : Disposable, AutoCloseable, FfiInboxOwner

FfiInboxState

data class FfiInboxState(var inboxId: String, var recoveryIdentity: FfiIdentifier, var installations: List<FfiInstallation>, var accountIdentities: List<FfiIdentifier>)

FfiInstallation

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

FfiKeyPackageStatus

data class FfiKeyPackageStatus(var lifetime: FfiLifetime?, var validationError: String?)

FfiLifetime

data class FfiLifetime(var notBefore: ULong, var notAfter: 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>?)

FfiLogLevel

enum FfiLogLevel : Enum<FfiLogLevel>

Enum representing log levels

FfiLogRotation

enum FfiLogRotation : Enum<FfiLogRotation>

Enum representing log file rotation options

FfiMessage

data class FfiMessage(var id: ByteArray, var sentAtNs: Long, var conversationId: ByteArray, var senderInboxId: String, var content: ByteArray, var kind: FfiConversationMessageKind, var deliveryStatus: FfiDeliveryStatus, var sequenceId: ULong?)

FfiMessageCallback

interface FfiMessageCallback

FfiMessageCallbackImpl

open class FfiMessageCallbackImpl : Disposable, AutoCloseable, FfiMessageCallback

FfiMessageDisappearingSettings

data class FfiMessageDisappearingSettings(var fromNs: Long, var inNs: Long)

Settings for disappearing messages in a conversation.

FfiMessageWithReactions

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

FfiMetadataField

enum FfiMetadataField : Enum<FfiMetadataField>

FfiMultiRemoteAttachment

data class FfiMultiRemoteAttachment(var attachments: List<FfiRemoteAttachmentInfo>)

FfiPasskeySignature

data class FfiPasskeySignature(var publicKey: ByteArray, var signature: ByteArray, var authenticatorData: ByteArray, var clientDataJson: ByteArray)

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 updateMessageDisappearingPolicy: FfiPermissionPolicy)

FfiPermissionUpdateType

enum FfiPermissionUpdateType : Enum<FfiPermissionUpdateType>

FfiPreferenceCallback

interface FfiPreferenceCallback

FfiPreferenceCallbackImpl

open class FfiPreferenceCallbackImpl : Disposable, AutoCloseable, FfiPreferenceCallback

FfiPreferenceUpdate

sealed class FfiPreferenceUpdate

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>

FfiRemoteAttachmentInfo

data class FfiRemoteAttachmentInfo(var secret: ByteArray, var contentDigest: String, var nonce: ByteArray, var scheme: String, var url: String, var salt: ByteArray, var contentLength: UInt?, var filename: String?)

FfiSignatureRequest

open class FfiSignatureRequest : Disposable, AutoCloseable, FfiSignatureRequestInterface

FfiSignatureRequestInterface

interface FfiSignatureRequestInterface

FfiStreamCloser

open class FfiStreamCloser : Disposable, AutoCloseable, FfiStreamCloserInterface

FfiStreamCloserInterface

interface FfiStreamCloserInterface

FfiSubscribeException

sealed class FfiSubscribeException : Exception

FfiSyncMetric

enum FfiSyncMetric : Enum<FfiSyncMetric>

FfiSyncWorker

open class FfiSyncWorker : Disposable, AutoCloseable, FfiSyncWorkerInterface

FfiSyncWorkerInterface

interface FfiSyncWorkerInterface

FfiSyncWorkerMode

enum FfiSyncWorkerMode : Enum<FfiSyncWorkerMode>

FfiTransactionMetadata

data class FfiTransactionMetadata(var transactionType: String, var currency: String, var amount: Double, var decimals: UInt, var fromAddress: String, var toAddress: String)

FfiTransactionReference

data class FfiTransactionReference(var namespace: String?, var networkId: String, var reference: String, var metadata: FfiTransactionMetadata?)

FfiUpdateGroupMembershipResult

data class FfiUpdateGroupMembershipResult(var addedMembers: Map<String, ULong>, var removedMembers: List<String>, var failedInstallations: List<ByteArray>)

FfiXmtpClient

open class FfiXmtpClient : Disposable, AutoCloseable, FfiXmtpClientInterface

FfiXmtpClientInterface

interface FfiXmtpClientInterface

GenericException

sealed class GenericException : Exception

IdentityValidationException

sealed class IdentityValidationException : Exception

InternalException

class InternalException(message: String) : Exception

SigningException

sealed class SigningException : Exception

XmtpApiClient

open class XmtpApiClient : Disposable, AutoCloseable, XmtpApiClientInterface

XmtpApiClientInterface

interface XmtpApiClientInterface

Functions

applySignatureRequest

suspend fun applySignatureRequest(api: XmtpApiClient, signatureRequest: FfiSignatureRequest)

connectToBackend

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

createClient

suspend fun createClient(api: XmtpApiClient, syncApi: XmtpApiClient, db: String?, encryptionKey: ByteArray?, inboxId: String, accountIdentifier: FfiIdentifier, nonce: ULong, legacySignedPrivateKeyProto: ByteArray?, deviceSyncServerUrl: String?, deviceSyncMode: FfiSyncWorkerMode?, allowOffline: Boolean?, disableEvents: Boolean?): 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_identifier. i.e. inbox_id cannot be associated with another account address.

decodeMultiRemoteAttachment

fun decodeMultiRemoteAttachment(bytes: ByteArray): FfiMultiRemoteAttachment

decodeReaction

fun decodeReaction(bytes: ByteArray): FfiReaction

decodeTransactionReference

fun decodeTransactionReference(bytes: ByteArray): FfiTransactionReference

encodeMultiRemoteAttachment

fun encodeMultiRemoteAttachment(ffiMultiRemoteAttachment: FfiMultiRemoteAttachment): ByteArray

encodeReaction

fun encodeReaction(reaction: FfiReaction): ByteArray

encodeTransactionReference

fun encodeTransactionReference(reference: FfiTransactionReference): ByteArray

enterDebugWriter

fun enterDebugWriter(directory: String, logLevel: FfiLogLevel, rotation: FfiLogRotation, maxFiles: UInt)

turns on logging to a file on-disk in the directory specified. files will be prefixed with 'libxmtp.log' and suffixed with the timestamp, i.e "libxmtp.log.2025-04-02" A maximum of 'max_files' log files are kept.

enterDebugWriterWithLevel

fun enterDebugWriterWithLevel(directory: String, rotation: FfiLogRotation, maxFiles: UInt, logLevel: FfiLogLevel)

turns on logging to a file on-disk with a specified log level. files will be prefixed with 'libxmtp.log' and suffixed with the timestamp, i.e "libxmtp.log.2025-04-02" A maximum of 'max_files' log files are kept.

exitDebugWriter

fun exitDebugWriter()

Flush loglines from libxmtp log writer to the file, ensuring logs are written. This should be called before the program exits, to ensure all the logs in memory have been written. this ends the writer thread.

generateInboxId

fun generateInboxId(accountIdentifier: FfiIdentifier, nonce: ULong): String

getInboxIdForIdentifier

suspend fun getInboxIdForIdentifier(api: XmtpApiClient, accountIdentifier: FfiIdentifier): String?

getVersionInfo

fun getVersionInfo(): String

inboxStateFromInboxIds

suspend fun inboxStateFromInboxIds(api: XmtpApiClient, inboxIds: List<String>): List<FfiInboxState>

isConnected

suspend fun isConnected(api: XmtpApiClient): Boolean

revokeInstallations

suspend fun revokeInstallations(api: XmtpApiClient, recoveryIdentifier: FfiIdentifier, inboxId: String, installationIds: List<ByteArray>): FfiSignatureRequest