library/org.xmtp.android.library/Client

Client

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

Constructors

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

Types

object Companion

Functions

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

archiveMetadata

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

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

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

deleteLocalDatabase

suspend fun deleteLocalDatabase(): Boolean

dropLocalDatabaseConnection

suspend fun dropLocalDatabaseConnection()

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

ffiApplySignatureRequest

suspend fun ffiApplySignatureRequest(signatureRequest: SignatureRequest)

ffiRegisterIdentity

suspend fun ffiRegisterIdentity(signatureRequest: SignatureRequest)

ffiRevokeAllOtherInstallations

suspend fun ffiRevokeAllOtherInstallations(): SignatureRequest?

ffiRevokeIdentity

suspend fun ffiRevokeIdentity(publicIdentityToRemove: PublicIdentity): SignatureRequest

ffiRevokeInstallations

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

ffiSignatureRequest

fun ffiSignatureRequest(): SignatureRequest?

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

inboxIdFromIdentity

suspend fun inboxIdFromIdentity(publicIdentity: PublicIdentity): InboxId?

suspend fun inboxState(refreshFromNetwork: Boolean): InboxState

inboxStatesForInboxIds

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

reconnectLocalDatabase

suspend fun reconnectLocalDatabase()

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

revokeAllOtherInstallations

suspend fun revokeAllOtherInstallations(signingKey: SigningKey): Unit?

revokeInstallations

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

sendSyncRequest

suspend fun sendSyncRequest()

Manually trigger a device sync request to sync records from another active device on this account.

signWithInstallationKey

fun signWithInstallationKey(message: String): ByteArray

verifySignature

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

verifySignatureWithInstallationId

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

Properties

val conversations: Conversations

val dbPath: String

debugInformation

val debugInformation: XMTPDebugInformation

val environment: XMTPEnvironment

val inboxId: InboxId

val installationId: String

val libXMTPVersion: String

val preferences: PrivatePreferences

val publicIdentity: PublicIdentity