library/org.xmtp.android.library

Package-level declarations

Types

ApiStats

class ApiStats(apiStats: FfiApiStats)

AppDataChange

data class AppDataChange(val groupId: String, val oldValue: String?, val newValue: String?)

A change to a group's opaque appData, as observed after it was applied.

AppDataChangeHandler

interface AppDataChangeHandler

Notified when a processed message changed a group's appData.

AuthConfiguration

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

What a client must present to be admitted. An app acts on enabled and requiredScopes; the rest is published for operator tooling.

AuthRequiredException

typealias AuthRequiredException = FfiException.AuthRequired

The deployment requires a credential and none was configured (CFG-062).

BackendMismatchException

typealias BackendMismatchException = FfiException.BackendMismatch

This database is bound to one deployment and a different one answered (CFG-051).

CatchUpSummary

data class CatchUpSummary(val messages: Long, val conversations: Long, val completed: Boolean, val failed: Long)

Counts the messages and conversations stored by Client.catchUpToLive. failed counts processing failures. completed is false if processing fails or the run does not reach its targets before the timeout.

ChainNotAcceptedException

typealias ChainNotAcceptedException = FfiException.ChainNotAccepted

The deployment does not verify wallet signatures on that chain (CFG-069, CFG-070).

CipherText

typealias CipherText = CiphertextOuterClass.Ciphertext

Client

class Client(libXMTPClient: FfiXmtpClient, val dbPath: String, val installationId: String, val inboxId: InboxId, val environment: String, val publicIdentity: PublicIdentity)

ClientOptions

data class ClientOptions(val api: ClientOptions.Api, val preAuthenticateToInboxCallback: PreEventCallback? = null, val appContext: Context, val dbEncryptionKey: ByteArray, val dbDirectory: String? = null, val deviceSyncEnabled: Boolean = true, val forkRecoveryOptions: ForkRecoveryOptions? = null, val dbPoolOptions: DbPoolOptions? = null, val waitForRegistrationVisible: VisibilityConfirmationOptions? = null, val unstableChangeCallbacks: UnstableChangeCallbacks? = null)

ClientVersionTooOldException

typealias ClientVersionTooOldException = FfiException.ClientVersionTooOld

The deployment requires a newer libxmtp than this build (CFG-060, CFG-061).

CodecRegistry

data class CodecRegistry(val codecs: MutableMap<String, ContentCodec<*>> = mutableMapOf())

ConfigurationInvalidException

typealias ConfigurationInvalidException = FfiException.ConfigurationInvalid

The deployment published a configuration this client cannot use (CFG-044).

ConfigurationUnavailableException

typealias ConfigurationUnavailableException = FfiException.ConfigurationUnavailable

The deployment did not serve its configuration, or it could not be stored (CFG-041).

ConsentRecord

data class ConsentRecord(val value: String, val entryType: EntryType, val consentType: ConsentState)

ConsentState

enum ConsentState : Enum<ConsentState>

Conversation

sealed class Conversation

Conversations

data class Conversations(var client: Client, ffiConversations: FfiConversations, ffiClient: FfiXmtpClient)

Crypto

class Crypto

DbPoolOptions

data class DbPoolOptions(val maxPoolSize: UInt? = null, val minPoolSize: UInt? = null)

DelicateApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class DelicateApi(val message: String)

DeliveryCursor

typealias DeliveryCursor = FfiDeliveryCursor

class Dm(val client: Client, libXMTPGroup: FfiConversation, ffiLastMessage: FfiMessage? = null, ffiIsCommitLogForked: Boolean? = null)

EncodedContentCompression

enum EncodedContentCompression : Enum<EncodedContentCompression>

EntryType

enum EntryType : Enum<EntryType>

ForkRecoveryOptions

data class ForkRecoveryOptions(val enableRecoveryRequests: ForkRecoveryPolicy, val groupsToRequestRecovery: List<String>, val disableRecoveryResponses: Boolean? = null, val workerIntervalNs: ULong? = null)

ForkRecoveryPolicy

enum ForkRecoveryPolicy : Enum<ForkRecoveryPolicy>

Group

class Group(val client: Client, libXMTPGroup: FfiConversation, ffiLastMessage: FfiMessage? = null, ffiIsCommitLogForked: Boolean? = null)

GroupSyncSummary

data class GroupSyncSummary(val numEligible: ULong, val numSynced: ULong)

IdentityStats

class IdentityStats(identityStats: FfiIdentityStats)

InboxId

typealias InboxId = String

KeyUtil

object KeyUtil

LimitsConfiguration

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

Request shapes the deployment accepts. The client chunks its own work to these values; an app reads them to size its batches.

MessageCatchUpSnapshot

typealias MessageCatchUpSnapshot = FfiMessageCatchUpSnapshot

MessageHistorySnapshot

data class MessageHistorySnapshot(val messages: List<DecodedMessage>, val cursor: DeliveryCursor)

MessageMetadata

typealias MessageMetadata = FfiMessageMetadata

MessageReader

class MessageReader : AutoCloseable

A sequential reader. Close it when finished. Reading a cursor does not acknowledge a message.

MessageVisibilityOptions

data class MessageVisibilityOptions(val shouldPush: Boolean, val idempotencyKey: String? = null)

MlsConfiguration

data class MlsConfiguration(val maxGroupMembers: Long, val maxInstallationsPerInbox: Long, val commitLogEnabled: Boolean?)

Advisory group shapes. The deployment publishes them; the client enforces them.

NotificationChannel

sealed class NotificationChannel

Delivery channel for this installation.

NotificationConfig

class NotificationConfig(val channel: NotificationChannel, val consentStates: List<ConsentState> = listOf(ConsentState.ALLOWED), val includeWelcomes: Boolean = true, val includeSyncGroups: Boolean = false, val includeCommits: Boolean = false)

Notification delivery and conversation rules.

NotificationError

class NotificationError : Exception

A notification failure with a stable error code.

NotificationOverride

enum NotificationOverride : Enum<NotificationOverride>

Reset to the configured consent rules with Default.

NotificationState

sealed class NotificationState

Local notification state. Reading it makes no backend request.

PreEventCallback

typealias PreEventCallback = suspend () -> Unit

PreferenceType

enum PreferenceType : Enum<PreferenceType>

PrivatePreferences

data class PrivatePreferences(var client: Client, ffiClient: FfiXmtpClient)

ProcessType

typealias ProcessType = FfiProcessType

RetentionConfiguration

data class RetentionConfiguration(val groupMessageSeconds: Long, val welcomeSeconds: Long, val keyPackageSeconds: Long)

How long the deployment keeps each payload kind, in seconds.

SendOptions

data class SendOptions(var compression: EncodedContentCompression? = null, var contentType: Content.ContentTypeId? = null, var ephemeral: Boolean = false, var idempotencyKey: String? = null)

ServerConfiguration

data class ServerConfiguration(val identifier: String, val serverVersion: String, val minLibxmtpVersion: String, val auth: AuthConfiguration, val retention: RetentionConfiguration, val limits: LimitsConfiguration, val mls: MlsConfiguration, val smartContractWalletChains: List<String>)

One immutable snapshot of what a deployment published about itself (spec 006 §5.2).

SignedData

data class SignedData(val rawData: ByteArray, val publicKey: ByteArray? = null, val authenticatorData: ByteArray? = null, val clientDataJson: ByteArray? = null)

SignerType

enum SignerType : Enum<SignerType>

SigningKey

interface SigningKey

SigningKeyDescription

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

Public identity of one accepted signing key. Never the key itself.

StreamBarrierCause

typealias StreamBarrierCause = FfiStreamBarrierCause

StreamBarrierCauseKind

typealias StreamBarrierCauseKind = FfiStreamBarrierCauseKind

StreamBarrierFailure

typealias StreamBarrierFailure = FfiStreamBarrierFailure

StreamBarrierReason

typealias StreamBarrierReason = FfiStreamBarrierReason

StreamBarrierTopic

typealias StreamBarrierTopic = FfiStreamBarrierTopic

StreamFailureDetails

typealias StreamFailureDetails = FfiStreamFailureDetails

StreamFailureKind

typealias StreamFailureKind = FfiStreamFailureKind

Topic

sealed class Topic

UnstableApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class UnstableApi(val message: String)

Opt-in marker for pre-release ("unstable") APIs. The API shape may still change and, in some cases, the effect is one-way and irreversible. Call sites must acknowledge with @OptIn(UnstableApi::class); when an API graduates the marker is dropped from it and — once the marker itself is removed — the opt-in fails to compile, forcing a migration to the stable form.

UnstableChangeCallbacks

data class UnstableChangeCallbacks(val appData: AppDataChangeHandler? = null)

Unstable: the set of group-change callbacks to register on a client.

UnstableGroup

class UnstableGroup(libXMTPGroup: FfiConversation)

Pre-release ("unstable") surface for a Group, reached through group.unstable.

Util

class Util

VisibilityConfirmationOptions

data class VisibilityConfirmationOptions(val timeoutMs: ULong? = null)

XMTPDebugInformation

class XMTPDebugInformation(ffiClient: FfiXmtpClient)

XMTPException

class XMTPException(message: String, exception: Exception? = null) : Exception

Properties

streamFailureDetails

val Throwable.streamFailureDetails: StreamFailureDetails?

Structured barrier, publish-confirmation, or catch-up failure details. A null target means target capture failed. Zero is a captured empty target. Cursors and counts retain their full unsigned 64-bit values.

Functions

hexToByteArray

fun String.hexToByteArray(): ByteArray

toHex

fun ByteArray.toHex(): String

validateInboxId

fun validateInboxId(inboxId: InboxId)

validateInboxIds

fun validateInboxIds(inboxIds: List<InboxId>)