library/org.xmtp.android.library/Client

Client

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

Constructors

Client

constructor(libXMTPClient: FfiXmtpClient, dbPath: String, installationId: String, inboxId: InboxId, environment: String, publicIdentity: PublicIdentity)

Types

Companion

object Companion

Properties

conversations

val conversations: Conversations

dbPath

val dbPath: String

debugInformation

val debugInformation: XMTPDebugInformation

environment

val environment: String

inboxId

val inboxId: InboxId

installationId

val installationId: String

isInMemory

val isInMemory: Boolean

true when this client is backed by an in-memory database. In that case deleteLocalDatabase, dropLocalDatabaseConnection and reconnectLocalDatabase are no-ops and the underlying state is discarded when the client is garbage collected.

libXMTPVersion

val libXMTPVersion: String

preferences

val preferences: PrivatePreferences

publicIdentity

val publicIdentity: PublicIdentity

Functions

addAccount

suspend fun addAccount(newAccount: SigningKey, allowReassignInboxId: Boolean = false)

archiveMetadata

suspend fun archiveMetadata(path: String, encryptionKey: ByteArray): ArchiveMetadata

canMessage

suspend fun canMessage(identities: List<PublicIdentity>): Map<String, Boolean>

catchUpToLive

suspend fun catchUpToLive(timeoutMs: Long? = null): CatchUpSummary

Bring the local store current with the network, then stop — for background fetch and cold start, where holding a live stream is wasted because the wire is about to go away.

createArchive

suspend fun createArchive(path: String, encryptionKey: ByteArray, opts: ArchiveOptions = ArchiveOptions()): FfiBackupMetadata

deleteLocalDatabase

suspend fun deleteLocalDatabase()

disableNotifications

suspend fun disableNotifications()

Disable notifications. Per-conversation overrides remain stored.

dropLocalDatabaseConnection

suspend fun dropLocalDatabaseConnection()

enableNotifications

suspend fun enableNotifications(config: NotificationConfig): NotificationState

Enable notifications and register the delivery channel.

ffiAddIdentity

suspend fun ffiAddIdentity(publicIdentityToAdd: PublicIdentity, allowReassignInboxId: Boolean = false): SignatureRequest

ffiApplySignatureRequest

suspend fun ffiApplySignatureRequest(signatureRequest: SignatureRequest)

ffiRegisterIdentity

suspend fun ffiRegisterIdentity(signatureRequest: SignatureRequest, visibilityConfirmationOptions: VisibilityConfirmationOptions? = null)

ffiRevokeAllOtherInstallations

suspend fun ffiRevokeAllOtherInstallations(): SignatureRequest?

ffiRevokeIdentity

suspend fun ffiRevokeIdentity(publicIdentityToRemove: PublicIdentity): SignatureRequest

ffiRevokeInstallations

suspend fun ffiRevokeInstallations(ids: List<ByteArray>): SignatureRequest

ffiSignatureRequest

fun ffiSignatureRequest(): SignatureRequest?

importArchive

suspend fun importArchive(path: String, encryptionKey: ByteArray)

inboxIdFromIdentity

suspend fun inboxIdFromIdentity(publicIdentity: PublicIdentity): InboxId?

inboxState

suspend fun inboxState(refreshFromNetwork: Boolean): InboxState

inboxStatesForInboxIds

suspend fun inboxStatesForInboxIds(refreshFromNetwork: Boolean, inboxIds: List<InboxId>): List<InboxState>

notificationState

suspend fun notificationState(): NotificationState

Read the local state without a backend request.

reconnectLocalDatabase

suspend fun reconnectLocalDatabase()

refreshServerConfiguration

suspend fun refreshServerConfiguration(): ServerConfiguration

Fetch this deployment's configuration now, rewrite the stored copy, and return what the deployment answered (spec 006 CFG-082).

removeAccount

suspend fun removeAccount(recoverAccount: SigningKey, publicIdentityToRemove: PublicIdentity)

revokeAllOtherInstallations

suspend fun revokeAllOtherInstallations(signingKey: SigningKey): Unit?

revokeInstallations

suspend fun revokeInstallations(signingKey: SigningKey, installationIds: List<String>)

serverConfiguration

fun serverConfiguration(): ServerConfiguration

What this deployment published about itself, as resolved when this client was built (spec 006 CFG-030, CFG-080).

signWithInstallationKey

fun signWithInstallationKey(message: String): ByteArray

syncAllDeviceSyncGroups

suspend fun syncAllDeviceSyncGroups(): GroupSyncSummary

Manually sync all device sync groups.

verifySignature

fun verifySignature(message: String, signature: ByteArray): Boolean

verifySignatureWithInstallationId

fun verifySignatureWithInstallationId(message: String, signature: ByteArray, installationId: String): Boolean