library/org.xmtp.android.library/Client/Companion

Companion

object Companion

Properties

codecRegistry

var codecRegistry: CodecRegistry

IN_MEMORY_DB_PATH

const val IN_MEMORY_DB_PATH: String

Sentinel value assigned to Client.dbPath when the client was created via createInMemory. No file exists at this path.

manageStreamLifecycle

@JvmStatic

var manageStreamLifecycle: Boolean

Process-wide control for automatic stream-lifecycle management. When true (the default), the first Client created registers a androidx.lifecycle.ProcessLifecycleOwner observer that parks the shared streaming wire while the app is backgrounded and revives it on foreground. The streaming wire is shared across every client in the process, so this is a process-global setting, not per-client: set it to false before creating your first client to opt out (e.g. to manage the lifecycle yourself).

Functions

activatePersistentLibXMTPLogWriter

fun activatePersistentLibXMTPLogWriter(appContext: Context, logLevel: FfiLogLevel, rotationSchedule: FfiLogRotation, maxFiles: Int, processType: ProcessType = FfiProcessType.MAIN)

build

suspend fun build(publicIdentity: PublicIdentity, options: ClientOptions, inboxId: InboxId? = null): Client

canMessage

suspend fun canMessage(identities: List<PublicIdentity>, api: ClientOptions.Api): Map<String, Boolean>

clearXMTPLogs

fun clearXMTPLogs(appContext: Context): Int

connectToApiBackend

suspend fun connectToApiBackend(api: ClientOptions.Api): XmtpApiClient

create

suspend fun create(account: SigningKey, options: ClientOptions): Client

createInMemory

suspend fun createInMemory(account: SigningKey, options: ClientOptions): Client

Creates a Client backed by an in-memory SQLCipher database.

deactivatePersistentLibXMTPLogWriter

fun deactivatePersistentLibXMTPLogWriter()

fetchServerConfiguration

suspend fun fetchServerConfiguration(api: ClientOptions.Api): ServerConfiguration

fetchServerConfiguration for an already-built ClientOptions.Api.

suspend fun fetchServerConfiguration(backendUrl: String, appVersion: String? = null): ServerConfiguration

Read a deployment's configuration with no database, no client, and no credential (spec 006 CFG-081).

ffiApplySignatureRequest

suspend fun ffiApplySignatureRequest(api: ClientOptions.Api, signatureRequest: SignatureRequest)

ffiCreateClient

suspend fun ffiCreateClient(publicIdentity: PublicIdentity, clientOptions: ClientOptions): Client

ffiRevokeInstallations

suspend fun ffiRevokeInstallations(api: ClientOptions.Api, publicIdentity: PublicIdentity, inboxId: InboxId, installationIds: List<String>): SignatureRequest

getNewestMessageMetadata

suspend fun getNewestMessageMetadata(groupIds: List<String>, api: ClientOptions.Api): Map<String, MessageMetadata>

getOrCreateInboxId

suspend fun getOrCreateInboxId(api: ClientOptions.Api, publicIdentity: PublicIdentity): InboxId

getXMTPLogFilePaths

fun getXMTPLogFilePaths(appContext: Context): List<String>

inboxStatesForInboxIds

suspend fun inboxStatesForInboxIds(inboxIds: List<InboxId>, api: ClientOptions.Api): List<InboxState>

keyPackageStatusesForInstallationIds

suspend fun keyPackageStatusesForInstallationIds(installationIds: List<String>, api: ClientOptions.Api): Map<String, FfiKeyPackageStatus>

fun register(codec: ContentCodec<*>)

revokeInstallations

suspend fun revokeInstallations(api: ClientOptions.Api, signingKey: SigningKey, inboxId: InboxId, installationIds: List<String>)

setLibXMTPNativeLogLevel

fun setLibXMTPNativeLogLevel(logLevel: FfiLogLevel)

Sets the log level for the native log layer (logcat on Android). Use FfiLogLevel.TRACE to capture span/activity events. Independent of the persistent file log writer.