library/uniffi.xmtp_sdk

Package-level declarations

Types

data class Action(var id: String, var label: String, var imageUrl: String?, var style: ActionStyle?, var expiresAt: Timestamp?)

Actions

data class Actions(var id: String, var description: String, var actions: List<Action>, var expiresAt: Timestamp?)

ActionsCodec

class ActionsCodec : ContentCodec<Actions>

ActionStyle

enum ActionStyle : Enum<ActionStyle>

AndroidStreamLifecycle

object AndroidStreamLifecycle

Keep the shared transport in step with the process lifecycle. Set enabled before the first Android client factory call to opt out. The observer owns no client and lives for the process.

ApiStats

data class ApiStats(var publish: ULong, var query: ULong, var queryNewest: ULong, var subscribe: ULong, var subscribeStatic: ULong)

ApplicationComponentDefinition

data class ApplicationComponentDefinition(var componentId: UShort, var name: String, var componentType: MetadataComponentType, var permissions: ComponentPermissions, var inGroups: Boolean, var inDms: Boolean)

A field that a backend offers apps. A new conversation registers it when in_groups or in_dms selects the conversation kind.

ArchiveElement

enum ArchiveElement : Enum<ArchiveElement>

ArchiveMetadata

data class ArchiveMetadata(var backupVersion: UShort, var elements: List<ArchiveElement>, var exportedAt: Timestamp, var start: Timestamp?, var end: Timestamp?)

ArchiveOptions

data class ArchiveOptions(var start: Timestamp? = null, var end: Timestamp? = null, var elements: List<ArchiveElement>? = null, var excludeDisappearingMessages: Boolean = false)

ArchiveRestored

data class ArchiveRestored(var complete: Boolean)

Archives

open class Archives : Disposable, AutoCloseable, ArchivesInterface

ArchivesInterface

interface ArchivesInterface

Attachment

data class Attachment(var filename: String?, var mimeType: String, var content: ByteArray)

AttachmentCodec

class AttachmentCodec : ContentCodec<Attachment>

AttachmentFailed

data class AttachmentFailed(var attachmentKey: String, var url: String, var contentDigest: String, var cause: String)

The attachment a failed transfer reports, with its failure cause.

AttachmentFailure

data class AttachmentFailure(var cause: AttachmentFailureCause, var credentialKind: CredentialFailureKind?, var retryable: Boolean, var missingScope: Boolean, var httpStatus: UShort?)

The failure of an attachment operation. A thrown XmtpError.Attachment and a Failed pending status carry the same record.

AttachmentFailureCause

enum AttachmentFailureCause : Enum<AttachmentFailureCause>

Why an attachment operation failed. Each value is one ATCH failure cause.

AttachmentOptions

data class AttachmentOptions(var maxDownloadBytes: ULong? = null, var maxPendingAgeSeconds: ULong? = null, var allowPrivateNetwork: Boolean = false)

Limits for attachment downloads and for pending uploads.

AttachmentRef

data class AttachmentRef(var attachmentKey: String, var url: String, var contentDigest: String)

The attachment an attachment.* event reports.

Attachments

open class Attachments : Disposable, AutoCloseable, AttachmentsInterface

The attachments of one client. The paths it returns name files under the client's attachments directory; in the browser they name OPFS entries.

AttachmentsConfiguration

data class AttachmentsConfiguration(var baseUrl: String, var maxUploadBytes: ULong, var retentionSeconds: ULong)

The attachment service a deployment offers.

AttachmentsInterface

interface AttachmentsInterface

The attachments of one client. The paths it returns name files under the client's attachments directory; in the browser they name OPFS entries.

AttachmentSource

sealed class AttachmentSource

The data of a new attachment. The SDK copies it into its own storage at create, so later changes to the source do not change the attachment.

AuthConfiguration

data class AuthConfiguration(var enabled: Boolean, var keys: List<SigningKeyDescription>, var audiences: List<String>, var issuers: List<String>, var requiredScopes: List<String>)

Backend

open class Backend : Disposable, AutoCloseable, BackendInterface

BackendInterface

interface BackendInterface

BackendOptions

data class BackendOptions(var url: String = "", var appVersion: String? = null, var credentials: CredentialSource? = null, var credential: Credential? = null) : Disposable

BackendSource

sealed class BackendSource : Disposable

Use connection options or an existing backend connection.

CatchUpSummary

data class CatchUpSummary(var messages: ULong, var conversations: ULong, var failed: ULong, var completed: Boolean)

Client

open class Client : Disposable, AutoCloseable, ClientInterface

ClientEvent

sealed class ClientEvent

ClientHandlers

data class ClientHandlers(var preAuthenticate: PreAuthenticate? = null) : Disposable

ClientInterface

interface ClientInterface

ClientOptions

data class ClientOptions(var backend: BackendSource? = null, var storage: StorageOptions, var deviceSync: Boolean = true, var allowOffline: Boolean = false, var registration: RegistrationOptions = RegistrationOptions(), var forkRecovery: ForkRecoveryOptions? = null, var workers: WorkerOptions? = null, var handlers: ClientHandlers? = null, var attachments: AttachmentOptions? = null) : Disposable

ClientRegistry

object ClientRegistry

ClientRejectedByServer

data class ClientRejectedByServer(var cause: RejectionCause, var minLibxmtpVersion: String?)

CommitLogForkStatus

enum CommitLogForkStatus : Enum<CommitLogForkStatus>

ComponentMutation

sealed class ComponentMutation

A write to one field. A map or set delta applies atomically: inserting a present key, or updating or deleting an absent key, rejects the whole write.

ComponentPermissions

data class ComponentPermissions(var insert: MetadataPolicy, var update: MetadataPolicy, var delete: MetadataPolicy)

A field's insert, update and delete policies.

Compression

enum Compression : Enum<Compression>

ConnectionState

enum ConnectionState : Enum<ConnectionState>

Transport state for one subscription reader.

ConnectionStateChanged

data class ConnectionStateChanged(var previous: ConnectionState, var current: ConnectionState)

ConsentChanged

data class ConsentChanged(var entityKind: ConsentEntityKind, var entity: String, var state: EventConsentState)

ConsentEntity

sealed class ConsentEntity

ConsentEntityKind

enum ConsentEntityKind : Enum<ConsentEntityKind>

ConsentRecord

data class ConsentRecord(var entity: ConsentEntity, var state: ConsentState)

ConsentState

enum ConsentState : Enum<ConsentState>

ContentCodec

interface ContentCodec<T : Any>

A content codec with a typed value (Ref Public surface, Host codecs). The send helpers run its steps before the send: encode, then fallback when the envelope has none, then shouldPush when the send has no explicit shouldPush option and the type is not a catalogue type. A step that throws fails the send with XmtpException.CodecEncodeFailed, and the SDK makes no publish attempt.

ContentTypeId

data class ContentTypeId(var authorityId: String, var typeId: String, var versionMajor: UInt, var versionMinor: UInt)

Conversation

sealed class Conversation : Disposable

ConversationDebugInfo

data class ConversationDebugInfo(var epoch: ULong, var maybeForked: Boolean, var forkDetails: String, var isCommitLogForked: Boolean?, var localCommitLog: String, var remoteCommitLog: String, var cursor: List<ULong>)

ConversationId

typealias ConversationId = String

ConversationJoined

data class ConversationJoined(var groupId: ByteArray, var conversationType: EventConversationType, var origin: JoinOrigin, var adderInboxId: InboxId?)

ConversationKind

enum ConversationKind : Enum<ConversationKind>

ConversationMessageReaderOptions

data class ConversationMessageReaderOptions(var from: String? = null)

Exclusive replay position for a named conversation.

ConversationMessageStreamOptions

data class ConversationMessageStreamOptions(val from: String? = null, val onClose: (SDKStreamCloseReason) -> Unit? = null, val onConnectionStateChange: (ConnectionState?, ConnectionState) -> Unit? = null)

ConversationOrder

enum ConversationOrder : Enum<ConversationOrder>

ConversationPaused

data class ConversationPaused(var groupId: ByteArray, var floor: String)

ConversationReader

open class ConversationReader : Disposable, AutoCloseable, ConversationReaderInterface

A pull reader for new stored conversations.

ConversationReaderInterface

interface ConversationReaderInterface

A pull reader for new stored conversations.

ConversationReaderOptions

data class ConversationReaderOptions(var kind: ConversationKind? = null, var consentStates: List<ConsentState>? = null)

ConversationRemoved

data class ConversationRemoved(var groupId: ByteArray, var cause: RemovalCause)

Conversations

open class Conversations : Disposable, AutoCloseable, ConversationsInterface

ConversationsInterface

interface ConversationsInterface

ConversationState

data class ConversationState(var isActive: Boolean, var consentState: ConsentState, var pausedForVersion: String?, var isDisappearingEnabled: Boolean, var disappearingSettings: DisappearingSettings?, var notificationsEnabled: Boolean, var commitLogForkStatus: CommitLogForkStatus)

ConversationStreamOptions

data class ConversationStreamOptions(val conversationKind: ConversationKind? = null, val consentStates: List<ConsentState>? = null, val onClose: (SDKStreamCloseReason) -> Unit? = null, val onConnectionStateChange: (ConnectionState?, ConnectionState) -> Unit? = null)

CreateDmOptions

data class CreateDmOptions(var disappearing: DisappearingSettings? = null)

CreateGroupOptions

data class CreateGroupOptions(var permissions: GroupPermissionMode? = null, var name: String? = null, var imageUrl: String? = null, var description: String? = null, var disappearing: DisappearingSettings? = null, var appData: String? = null)

Credential

data class Credential(var name: String?, var value: String, var expiresAtSeconds: Long)

CredentialException

sealed class CredentialException : Exception

CredentialFailureKind

enum CredentialFailureKind : Enum<CredentialFailureKind>

Which credential step failed, for the Credential cause.

CredentialSource

interface CredentialSource

CredentialSourceImpl

open class CredentialSourceImpl : Disposable, AutoCloseable, CredentialSource

DeletedBy

sealed class DeletedBy

DeletedMessage

data class DeletedMessage(var deletedBy: DeletedBy)

DeleteMessageCodec

class DeleteMessageCodec : ContentCodec<DeleteMessageContent>

DeleteMessageContent

data class DeleteMessageContent(var messageId: MessageId)

DeletionCause

enum DeletionCause : Enum<DeletionCause>

DeliveryStatus

enum DeliveryStatus : Enum<DeliveryStatus>

Diagnostics

open class Diagnostics : Disposable, AutoCloseable, DiagnosticsInterface

DiagnosticsInterface

interface DiagnosticsInterface

DisappearingSettings

data class DisappearingSettings(var from: Timestamp, var retentionNs: Long)

Disposable

interface Disposable

open class Dm : Disposable, AutoCloseable, DmInterface

DmInterface

interface DmInterface

DownloadedAttachment

data class DownloadedAttachment(var path: String, var mimeType: String?, var filename: String?)

A verified attachment in the attachments directory.

EncodedContent

data class EncodedContent(var type: ContentTypeId, var parameters: Map<String, String> = mapOf(), var fallback: String? = null, var content: ByteArray)

Content at this boundary is uncompressed. Send options control wire compression.

EncryptedEncodedContent

data class EncryptedEncodedContent(var ciphertext: ByteArray, var keys: EncryptionKeys)

EncryptionKeys

data class EncryptionKeys(var secret: ByteArray, var salt: ByteArray, var nonce: ByteArray, var digest: String, var length: ULong)

ErrorCategory

enum ErrorCategory : Enum<ErrorCategory>

The kind of a façade failure.

ErrorDetails

data class ErrorDetails(var code: String, var category: ErrorCategory, var retryable: Boolean, var message: String, var streamFailure: StreamFailureDetails? = null)

Stable information carried by each error variant.

EventConsentState

enum EventConsentState : Enum<EventConsentState>

EventContentTypeId

data class EventContentTypeId(var authorityId: String, var typeId: String, var versionMajor: UInt)

EventConversationType

enum EventConversationType : Enum<EventConversationType>

EventFilter

data class EventFilter(var kinds: List<EventKind>, var groupIds: List<ByteArray>? = null, var contentTypes: List<EventContentTypeId>? = null, var referencesOwnMessages: Boolean = false)

EventKind

enum EventKind : Enum<EventKind>

EventListener

interface EventListener

EventListenerImpl

open class EventListenerImpl : Disposable, AutoCloseable, EventListener

EventMessageStatus

enum EventMessageStatus : Enum<EventMessageStatus>

EventReader

open class EventReader : Disposable, AutoCloseable, EventReaderInterface

EventReaderInterface

interface EventReaderInterface

FfiConverterTypeConversationId

typealias FfiConverterTypeConversationId = FfiConverterString

FfiConverterTypeInboxId

typealias FfiConverterTypeInboxId = FfiConverterString

FfiConverterTypeInstallationId

typealias FfiConverterTypeInstallationId = FfiConverterString

FfiConverterTypeListenerId

typealias FfiConverterTypeListenerId = FfiConverterULong

FfiConverterTypeMessageId

typealias FfiConverterTypeMessageId = FfiConverterString

FieldKey

sealed class FieldKey

A map or set key.

FieldValue

sealed class FieldValue

A scalar value or map value.

ForkRecoveryOptions

data class ForkRecoveryOptions(var policy: ForkRecoveryPolicy, var groups: List<ConversationId> = listOf(), var disableResponses: Boolean = false, var workerIntervalNs: ULong? = null)

ForkRecoveryPolicy

enum ForkRecoveryPolicy : Enum<ForkRecoveryPolicy>

Group

open class Group : Disposable, AutoCloseable, GroupInterface

GroupInterface

interface GroupInterface

GroupMembershipCapabilities

data class GroupMembershipCapabilities(var contextExtensions: List<MlsExtensionType>, var members: List<InboxCapabilities>)

GroupPermissionMode

sealed class GroupPermissionMode

GroupPermissions

data class GroupPermissions(var policyType: GroupPolicyType, var policySet: PermissionPolicySet)

GroupPolicyType

enum GroupPolicyType : Enum<GroupPolicyType>

GroupRef

data class GroupRef(var groupId: ByteArray)

GroupState

data class GroupState(var common: ConversationState, var name: String, var imageUrl: String, var description: String, var appData: String, var membershipState: MembershipState, var admins: List<InboxId>, var superAdmins: List<InboxId>, var permissions: GroupPermissions)

GroupSyncSummary

data class GroupSyncSummary(var eligible: ULong, var synced: ULong)

GroupUpdated

data class GroupUpdated(var initiatedByInboxId: InboxId, var addedInboxes: List<InboxId>, var removedInboxes: List<InboxId>, var leftInboxes: List<InboxId>, var metadataFieldChanges: List<MetadataFieldChange>, var addedAdminInboxes: List<InboxId>, var removedAdminInboxes: List<InboxId>, var addedSuperAdminInboxes: List<InboxId>, var removedSuperAdminInboxes: List<InboxId>)

GroupUpdatedCodec

class GroupUpdatedCodec : ContentCodec<GroupUpdated>

HandleChanged

data class HandleChanged(var inboxId: InboxId, var handle: String)

The current handle of an inbox changed: the client stored a newer association state for the inbox whose display handle differs.

HandlesConfiguration

data class HandlesConfiguration(var minNameLength: UInt)

Handle settings the deployment applies when it admits a claim. They are for apps, for example to check a name as a user types it. The SDK never fails an operation or omits a handle because of them: the backend's answer when it admits a claim decides.

HmacKey

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

HmacKeysUpdated

class HmacKeysUpdated

IdentityRegistered

data class IdentityRegistered(var inboxId: InboxId, var installationKey: ByteArray)

IdentityStats

data class IdentityStats(var getInboxIds: ULong, var verifySmartContractWalletSignatures: ULong)

InboxCapabilities

data class InboxCapabilities(var inboxId: InboxId, var installations: List<InstallationCapabilities>)

InboxId

typealias InboxId = String

InboxState

data class InboxState(var inboxId: InboxId, var identities: List<PublicIdentity>, var installations: List<Installation>, var recoveryIdentity: PublicIdentity, var creationSignatureKind: SignatureKind?, var handle: String?, var otherHandles: List<String>)

Installation

data class Installation(var id: InstallationId, var createdAt: Timestamp?)

InstallationCapabilities

data class InstallationCapabilities(var installationId: InstallationId, var isOwn: Boolean, var supportedExtensions: List<MlsExtensionType>, var capabilitiesKnown: Boolean)

InstallationId

typealias InstallationId = String

InstallationRef

data class InstallationRef(var installationKey: ByteArray)

InstallationRevoked

data class InstallationRevoked(var installationKey: ByteArray, var isThisInstallation: Boolean)

Intent

data class Intent(var id: String, var actionId: String, var metadataJson: String?)

IntentCodec

class IntentCodec : ContentCodec<Intent>

InternalException

class InternalException(message: String) : Exception

JoinOrigin

enum JoinOrigin : Enum<JoinOrigin>

KeyPackageLifetime

data class KeyPackageLifetime(var notBefore: ULong, var notAfter: ULong)

KeyPackageStatus

data class KeyPackageStatus(var lifetime: KeyPackageLifetime?, var validationError: String?)

Lagged

data class Lagged(var discarded: ULong)

LeaveRequest

data class LeaveRequest(var authenticatedNote: ByteArray?)

LeaveRequestCodec

class LeaveRequestCodec : ContentCodec<LeaveRequest>

LimitsConfiguration

data class LimitsConfiguration(var maxEnvelopeBytes: ULong, var maxRequestBytes: ULong, var maxResponseBytes: ULong, var maxPublishTopics: ULong, var maxQueryTopics: ULong, var maxQueryLimit: ULong, var defaultQueryLimit: ULong, var maxNewestMetadataTopics: ULong, var maxNewestFullTopics: ULong, var maxUpdateAdds: ULong, var maxUpdateRemoves: ULong, var maxStreamTopics: ULong, var maxStaticTopics: ULong, var maxLookupIdentifiers: ULong, var maxScwSignatures: ULong, var maxIdentityEntries: ULong, var maxUpdateFramesPerSecond: UInt, var maxUpdateBurst: UInt, var maxPingFramesPerSecond: UInt, var maxPingBurst: UInt)

ListConversationsOptions

data class ListConversationsOptions(var kind: ConversationKind? = null, var consentStates: List<ConsentState>? = null, var createdAfter: Timestamp? = null, var createdBefore: Timestamp? = null, var lastActivityAfter: Timestamp? = null, var lastActivityBefore: Timestamp? = null, var limit: UInt? = null, var orderBy: ConversationOrder? = null, var includeDuplicateDms: Boolean = false)

ListenerException

sealed class ListenerException : Exception

ListenerId

typealias ListenerId = ULong

ListMessagesOptions

data class ListMessagesOptions(var limit: UInt? = null, var sentBefore: Timestamp? = null, var sentAfter: Timestamp? = null, var insertedBefore: Timestamp? = null, var insertedAfter: Timestamp? = null, var direction: MessageOrder? = null, var sortBy: MessageSortBy? = null, var deliveryStatus: DeliveryStatus? = null, var kind: MessageKind? = null, var contentTypes: List<ContentTypeId>? = null, var excludeContentTypes: List<ContentTypeId>? = null, var excludeSenderInboxIds: List<InboxId>? = null)

LocalAttachment

data class LocalAttachment(var path: String, var createdAt: Timestamp)

A plaintext attachment file this client keeps.

LocalSigningKey

open class LocalSigningKey : Disposable, AutoCloseable, LocalSigningKeyInterface

An exportable Ethereum signing key. Only explicit export methods reveal its private key.

LocalSigningKeyInterface

interface LocalSigningKeyInterface : Signer

An exportable Ethereum signing key. Only explicit export methods reveal its private key.

LockoutChange

enum LockoutChange : Enum<LockoutChange>

LockoutChanged

data class LockoutChanged(var change: LockoutChange)

LoggingOptions

data class LoggingOptions(var level: LogLevel? = null, var structured: Boolean = false, var performance: Boolean = false, var otel: OtelOptions? = null, var resourceAttributes: Map<String, String> = mapOf())

LogLevel

enum LogLevel : Enum<LogLevel>

LogProcessType

enum LogProcessType : Enum<LogProcessType>

LogRecord

data class LogRecord(var level: LogLevel, var target: String, var message: String, var fields: Map<String, String>, var timestamp: Timestamp, var droppedRecords: ULong)

LogRotation

enum LogRotation : Enum<LogRotation>

LogSink

interface LogSink

LogSinkException

sealed class LogSinkException : Exception

LogSinkImpl

open class LogSinkImpl : Disposable, AutoCloseable, LogSink

MapEntry

data class MapEntry(var key: FieldKey, var value: FieldValue)

MapMutation

sealed class MapMutation

One key change to a map field.

MarkdownCodec

class MarkdownCodec : ContentCodec<String>

Member

data class Member(var inboxId: InboxId, var identities: List<PublicIdentity>, var permissionLevel: PermissionLevel, var consentState: ConsentState, var handle: String?, var otherHandles: List<String>)

MembershipChanged

data class MembershipChanged(var groupId: ByteArray, var addedInboxIds: List<InboxId>, var removedInboxIds: List<InboxId>)

MembershipResult

data class MembershipResult(var added: List<InboxId>, var removed: List<InboxId>, var failedInstallationIds: List<InstallationId>)

MembershipState

enum MembershipState : Enum<MembershipState>

Message

class Message(data: MessageData) : MessageFields

A received or stored message. MessageFields holds its fields and equality.

MessageBody

sealed class MessageBody

MessageContent

sealed class MessageContent

MessageData

data class MessageData(var id: MessageId, var clientKey: ULong, var deliveryCursor: String? = null, var conversationId: ConversationId, var topic: String, var senderInboxId: InboxId, var sentAt: Timestamp, var insertedAt: Timestamp, var expiresAt: Timestamp?, var kind: MessageKind, var deliveryStatus: DeliveryStatus, var rawBytes: ByteArray, var contentType: ContentTypeId?, var fallback: String?, var encoded: EncodedContent?, var content: MessageContent, var replyCount: ULong, var reactions: List<ReactionMessage>, var inReplyTo: ReplyParent?)

A message value contains records and enums only.

MessageDeleted

data class MessageDeleted(var groupId: ByteArray, var messageId: ByteArray, var cause: DeletionCause)

MessageFields

abstract class MessageFields

The fields of a received message, and value equality over all of its data. Message adds its decoded content and actions.

MessageHistoryPage

data class MessageHistoryPage(var messages: List<Message>, var firstPosition: MessageHistoryPosition?, var lastPosition: MessageHistoryPosition?, var hasMore: Boolean, var skippedCount: UInt)

A chronological Published page and the raw prefix it consumed. First and last positions follow the requested output direction. Empty messages can still have consumed positions and more history.

MessageHistoryPosition

data class MessageHistoryPosition(var sentAt: Timestamp, var deliveryCursor: String)

A sent-time boundary with a committed database-local delivery position. Keep the cursor opaque. A retained boundary remains valid after deletion. A whole-database restore or another database rejects the cursor.

MessageHistorySnapshot

data class MessageHistorySnapshot(var messages: List<Message>, var cursor: String)

Retained messages and their replay boundary from one database snapshot.

MessageId

typealias MessageId = String

MessageKind

enum MessageKind : Enum<MessageKind>

MessageMetadataEntry

data class MessageMetadataEntry(var sequenceId: ULong, var createdAt: Timestamp)

MessageOrder

enum MessageOrder : Enum<MessageOrder>

MessageReader

open class MessageReader : Disposable, AutoCloseable, MessageReaderInterface

MessageReaderInterface

interface MessageReaderInterface

MessageReaderOptions

data class MessageReaderOptions(var conversationKind: ConversationKind? = null, var consentStates: List<ConsentState>? = null, var from: String? = null)

Fixed selection and replay position for an all-conversation message reader.

MessageReceived

data class MessageReceived(var groupId: ByteArray, var messageId: ByteArray, var contentType: EventContentTypeId?, var senderInboxId: InboxId)

MessageRecoveryPage

data class MessageRecoveryPage(var messages: List<Message>, var firstPosition: MessageRecoveryPosition?, var lastPosition: MessageRecoveryPosition?, var hasMore: Boolean, var skippedCount: UInt)

A chronological pending page and the raw prefix it consumed.

MessageRecoveryPosition

data class MessageRecoveryPosition(var sentAt: Timestamp, var messageCursor: String)

A sent-time boundary with an opaque database-local raw message key. The boundary remains valid after deletion or publication of the row.

MessageRef

data class MessageRef(var groupId: ByteArray, var messageId: ByteArray)

MessageSortBy

enum MessageSortBy : Enum<MessageSortBy>

MessageStatusChanged

data class MessageStatusChanged(var groupId: ByteArray, var messageId: ByteArray, var previous: EventMessageStatus, var current: EventMessageStatus)

MessageStreamOptions

data class MessageStreamOptions(val conversationKind: ConversationKind? = null, val consentStates: List<ConsentState>? = null, val from: String? = null, val onClose: (SDKStreamCloseReason) -> Unit? = null, val onConnectionStateChange: (ConnectionState?, ConnectionState) -> Unit? = null)

MetadataBasePolicy

sealed class MetadataBasePolicy

MetadataChanged

data class MetadataChanged(var groupId: ByteArray, var changed: List<String>)

MetadataComponentType

sealed class MetadataComponentType

The shape of a field's value.

MetadataFieldChange

data class MetadataFieldChange(var fieldName: String, var oldValue: String?, var newValue: String?)

MetadataFieldDescriptor

data class MetadataFieldDescriptor(var field: MetadataFieldRef, var componentType: MetadataComponentType, var permissions: ComponentPermissions, var isUserField: Boolean)

A field of a conversation, with its committed type and policies.

MetadataFieldKind

enum MetadataFieldKind : Enum<MetadataFieldKind>

MetadataFieldRef

data class MetadataFieldRef(var componentId: UShort, var name: String?)

Names a metadata field: its component ID and, when one exists, its well-known or backend catalogue name.

MetadataFieldValue

data class MetadataFieldValue(var field: MetadataFieldRef, var value: MetadataValue?)

A field and its value. The value is absent when the conversation holds none.

MetadataKeyType

enum MetadataKeyType : Enum<MetadataKeyType>

The type of a map or set key.

MetadataPolicy

sealed class MetadataPolicy

A member policy for inserting, updating or deleting a field.

MetadataScalarType

enum MetadataScalarType : Enum<MetadataScalarType>

The type of a scalar field or of a map value.

MetadataValue

sealed class MetadataValue

A field value.

MigrationReport

data class MigrationReport(var archivePath: String, var groupCount: ULong, var messageCount: ULong, var consentCount: ULong)

Counts records in the completed archive, before import deduplication.

MlsConfiguration

data class MlsConfiguration(var maxGroupMembers: ULong, var maxInstallationsPerInbox: ULong, var commitLogEnabled: Boolean?)

MlsExtensionType

sealed class MlsExtensionType

MultiRemoteAttachment

data class MultiRemoteAttachment(var attachments: List<RemoteAttachment>)

MultiRemoteAttachmentCodec

class MultiRemoteAttachmentCodec : ContentCodec<MultiRemoteAttachment>

NotificationChannel

sealed class NotificationChannel

NotificationConfig

data class NotificationConfig(var channel: NotificationChannel, var consentStates: List<ConsentState>? = null, var includeWelcomes: Boolean? = null, var includeSyncGroups: Boolean? = null, var includeCommits: Boolean? = null)

NotificationFailure

enum NotificationFailure : Enum<NotificationFailure>

NotificationOverride

enum NotificationOverride : Enum<NotificationOverride>

NotificationsFailed

data class NotificationsFailed(var cause: String)

NotificationState

sealed class NotificationState

OtelOptions

data class OtelOptions(var endpoint: String, var serviceName: String, var sampleRatio: Double = 1.0)

PendingAttachment

open class PendingAttachment : Disposable, AutoCloseable, PendingAttachmentInterface

A staged attachment and its upload.

PendingAttachmentInterface

interface PendingAttachmentInterface

A staged attachment and its upload.

PendingAttachmentStatus

sealed class PendingAttachmentStatus

The upload state of a pending attachment, read from the database.

PermissionLevel

enum PermissionLevel : Enum<PermissionLevel>

PermissionPolicy

enum PermissionPolicy : Enum<PermissionPolicy>

PermissionPolicySet

data class PermissionPolicySet(var addMember: PermissionPolicy, var removeMember: PermissionPolicy, var addAdmin: PermissionPolicy, var removeAdmin: PermissionPolicy, var updateName: PermissionPolicy, var updateDescription: PermissionPolicy, var updateImage: PermissionPolicy, var updateDisappearing: PermissionPolicy, var updateAppData: PermissionPolicy)

PermissionUpdateKind

enum PermissionUpdateKind : Enum<PermissionUpdateKind>

PreAuthenticate

interface PreAuthenticate

PreAuthenticateException

sealed class PreAuthenticateException : Exception

PreAuthenticateImpl

open class PreAuthenticateImpl : Disposable, AutoCloseable, PreAuthenticate

Preferences

open class Preferences : Disposable, AutoCloseable, PreferencesInterface

PreferencesInterface

interface PreferencesInterface

PrepareMigrationArchiveArgs

data class PrepareMigrationArchiveArgs(var databasePath: String, var databaseKey: ByteArray? = null, var archiveKey: ByteArray, var outputPath: String)

Closed legacy storage and a separate output path. Keep both keys private.

PublicIdentity

data class PublicIdentity(var identifier: String, var kind: PublicIdentityKind)

PublicIdentityKind

enum PublicIdentityKind : Enum<PublicIdentityKind>

Reaction

data class Reaction(var content: String, var action: ReactionAction, var schema: ReactionSchema)

ReactionAction

enum ReactionAction : Enum<ReactionAction>

ReactionMessage

data class ReactionMessage(var id: MessageId, var senderInboxId: InboxId, var sentAt: Timestamp, var deliveryStatus: DeliveryStatus, var reaction: Reaction)

ReactionSchema

enum ReactionSchema : Enum<ReactionSchema>

ReactionV2Codec

class ReactionV2Codec : ContentCodec<ReactionV2Content>

ReactionV2Content

data class ReactionV2Content(var reference: MessageId, var referenceInboxId: InboxId? = null, var reaction: Reaction)

ReadReceiptCodec

class ReadReceiptCodec : ContentCodec<Unit>

RegistrationOptions

data class RegistrationOptions(var auto: Boolean = true, var nonce: ULong? = null)

RejectionCause

enum RejectionCause : Enum<RejectionCause>

RemoteAttachment

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

RemoteAttachmentCodec

class RemoteAttachmentCodec : ContentCodec<RemoteAttachment>

RemovalCause

enum RemovalCause : Enum<RemovalCause>

ReplyCodec

class ReplyCodec : ContentCodec<ReplyContent>

ReplyContent

data class ReplyContent(var reference: MessageId, var referenceInboxId: InboxId? = null, var content: EncodedContent)

ReplyParent

data class ReplyParent(var id: MessageId, var senderInboxId: InboxId, var sentAt: Timestamp, var kind: MessageKind, var deliveryStatus: DeliveryStatus, var rawBytes: ByteArray, var contentType: ContentTypeId?, var fallback: String?, var encoded: EncodedContent?, var content: MessageBody)

RetentionConfiguration

data class RetentionConfiguration(var groupMessageSeconds: ULong, var welcomeSeconds: ULong, var keyPackageSeconds: ULong)

SDKClient

class SDKClient

The host client resolves storage and owns the weak message lookup entry. Generated forwarders in ClientForwarding.kt expose the other Client methods and the Client statics. The generated Client stays private to the runtime.

SDKForeign

object SDKForeign

Turn every host failure into the error declared by its foreign trait.

SDKMessageContent

sealed class SDKMessageContent

SDKReplyContent

sealed class SDKReplyContent

SDKStreamCloseReason

sealed interface SDKStreamCloseReason

SendOptions

data class SendOptions(var shouldPush: Boolean? = null, var optimistic: Boolean = false, var idempotencyKey: String? = null, var compression: Compression? = null)

ServerConfiguration

data class ServerConfiguration(var identifier: String, var serverVersion: String, var minLibxmtpVersion: String, var auth: AuthConfiguration, var retention: RetentionConfiguration, var limits: LimitsConfiguration, var mls: MlsConfiguration, var handles: HandlesConfiguration, var smartContractWalletChains: List<String>, var attachments: AttachmentsConfiguration?, var applicationComponents: List<ApplicationComponentDefinition>)

SetMutation

sealed class SetMutation

One key change to a set field.

Signature

sealed class Signature

SignatureKind

enum SignatureKind : Enum<SignatureKind>

SignatureRequest

open class SignatureRequest : Disposable, AutoCloseable, SignatureRequestInterface

A request for an identity update. The caller adds signatures before applying it.

SignatureRequestInterface

interface SignatureRequestInterface

A request for an identity update. The caller adds signatures before applying it.

Signer

interface Signer

SignerException

sealed class SignerException : Exception

SignerImpl

open class SignerImpl : Disposable, AutoCloseable, Signer

SignerKind

sealed class SignerKind

SigningKeyDescription

data class SigningKeyDescription(var kid: String, var alg: String)

SigningRequest

data class SigningRequest(var text: String)

StandardContent

sealed class StandardContent

A standard value that can be encoded without a client.

StandardContentKind

enum StandardContentKind : Enum<StandardContentKind>

Storage

open class Storage : Disposable, AutoCloseable, StorageInterface

StorageInterface

interface StorageInterface

StorageLocation

sealed class StorageLocation

StorageOptions

data class StorageOptions(var location: StorageLocation, var label: String? = null, var encryptionKey: ByteArray? = null, var pool: StoragePoolOptions? = null, var singleConnection: Boolean = false)

StoragePoolOptions

data class StoragePoolOptions(var min: UInt? = null, var max: UInt? = null)

StreamBarrierCause

data class StreamBarrierCause(var kind: StreamBarrierCauseKind, var code: String?, var message: String, var retryable: Boolean)

Safe cause fields. Use the kind and code for control flow.

StreamBarrierCauseKind

enum StreamBarrierCauseKind : Enum<StreamBarrierCauseKind>

The typed cause of one unfinished topic obligation.

StreamBarrierFailure

data class StreamBarrierFailure(var reason: StreamBarrierReason, var unfinished: List<StreamBarrierTopic>)

Every unfinished topic from one failed barrier.

StreamBarrierReason

enum StreamBarrierReason : Enum<StreamBarrierReason>

Why a barrier stopped waiting. Pending work remains stored.

StreamBarrierTopic

data class StreamBarrierTopic(var topic: ByteArray, var scopeGeneration: ULong? = null, var target: ULong?, var received: ULong, var processed: ULong, var unresolvedWelcomes: List<ULong>, var inactive: Boolean, var cause: StreamBarrierCause?)

One fixed topic obligation and its stored processing progress.

StreamFailureDetails

data class StreamFailureDetails(var kind: StreamFailureKind, var code: String, var message: String, var retryable: Boolean, var intentId: Int?, var publishedIntentIds: List<Int>, var summary: StreamFailureSummary?, var barriers: List<StreamBarrierFailure>)

Typed details from the core error, including all sibling barriers.

StreamFailureKind

enum StreamFailureKind : Enum<StreamFailureKind>

The operation with unfinished fixed processing obligations.

StreamFailureSummary

data class StreamFailureSummary(var messages: ULong, var conversations: ULong, var failed: ULong, var completed: Boolean)

Catch-up progress that remains committed after an incomplete result.

TextCodec

class TextCodec : ContentCodec<String>

Timestamp

data class Timestamp(val ns: Long)

TransactionMetadata

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

TransactionReference

data class TransactionReference(var namespace: String?, var networkId: String, var reference: String, var metadata: TransactionMetadata?)

TransactionReferenceCodec

class TransactionReferenceCodec : ContentCodec<TransactionReference>

UserFieldUpdate

data class UserFieldUpdate(var field: MetadataFieldRef, var value: FieldValue?)

Sets the caller's own value of a user field, or clears it when value is absent.

UserFieldValue

data class UserFieldValue(var field: MetadataFieldRef, var value: FieldValue)

One inbox's value of a user field.

WalletCall

data class WalletCall(var to: String?, var data: String?, var value: String?, var gas: String?, var metadata: WalletCallMetadata?)

WalletCallMetadata

data class WalletCallMetadata(var description: String, var transactionType: String, var extra: Map<String, String>)

WalletSendCalls

data class WalletSendCalls(var version: String, var chainId: String, var from: String, var calls: List<WalletCall>, var capabilities: Map<String, String>?)

WalletSendCallsCodec

class WalletSendCallsCodec : ContentCodec<WalletSendCalls>

WellKnownMetadataField

enum WellKnownMetadataField : Enum<WellKnownMetadataField>

A public well-known metadata field.

WorkerInterval

data class WorkerInterval(var kind: WorkerKind, var intervalNs: ULong?, var jitterNs: ULong?, var enabled: Boolean?)

WorkerKind

enum WorkerKind : Enum<WorkerKind>

WorkerOptions

data class WorkerOptions(var defaultIntervalNs: ULong? = null, var intervals: List<WorkerInterval> = listOf())

XmtpException

sealed class XmtpException : Exception

Errors returned by the SDK façade.

Functions

activatePersistentLibXMTPLogWriter

fun SDKClient.Companion.activatePersistentLibXMTPLogWriter(context: Context, logLevel: LogLevel, rotationSchedule: LogRotation, maxFiles: UInt, processType: LogProcessType = LogProcessType.MAIN)

Write native logs in the app's files directory.

addedByInboxId

fun Conversation.addedByInboxId(): InboxId?

addMembers

suspend fun Group.addMembers(members: List<PublicIdentity>): MembershipResult

appVersion

fun SDKClient.appVersion(): String?