FfiXmtpClient

open class FfiXmtpClient : Disposable, AutoCloseable, FfiXmtpClientInterface

Constructors

constructor(pointer: Pointer)

constructor(noPointer: NoPointer)

This constructor can be used to instantiate a fake object. Only used for tests. Any attempt to actually use an object constructed this way will fail as there is no connected Rust object.

Types

Companion

object Companion

Functions

addIdentity

open suspend override fun addIdentity(newIdentity: FfiIdentifier): FfiSignatureRequest

Adds a wallet address to the existing client

addressesFromInboxId

open suspend override fun addressesFromInboxId(refreshFromNetwork: Boolean, inboxIds: List<String>): List<FfiInboxState>

apiAggregateStatistics

open override fun apiAggregateStatistics(): String

apiIdentityStatistics

open override fun apiIdentityStatistics(): FfiIdentityStats

apiStatistics

open override fun apiStatistics(): FfiApiStats

applySignatureRequest

open suspend override fun applySignatureRequest(signatureRequest: FfiSignatureRequest)

archiveMetadata

open suspend override fun archiveMetadata(path: String, key: ByteArray): FfiBackupMetadata

Load the metadata for an archive to see what it contains. Reads only the metadata without loading the entire file, so this function is quick.

canMessage

open suspend override fun canMessage(accountIdentifiers: List<FfiIdentifier>): Map<FfiIdentifier, Boolean>

changeRecoveryIdentifier

open suspend override fun changeRecoveryIdentifier(newRecoveryIdentifier: FfiIdentifier): FfiSignatureRequest

@Synchronized

open override fun close()

conversation

open override fun conversation(conversationId: ByteArray): FfiConversation

conversations

open override fun conversations(): FfiConversations

createArchive

open suspend override fun createArchive(path: String, opts: FfiArchiveOptions, key: ByteArray)

Archive application elements to file for later restoration.

dbReconnect

open suspend override fun dbReconnect()

destroy

open override fun destroy()

dmConversation

open override fun dmConversation(targetInboxId: String): FfiConversation

findInboxId

open suspend override fun findInboxId(identifier: FfiIdentifier): String?

getConsentState

open suspend override fun getConsentState(entityType: FfiConsentEntityType, entity: String): FfiConsentState

getKeyPackageStatusesForInstallationIds

open suspend override fun getKeyPackageStatusesForInstallationIds(installationIds: List<ByteArray>): Map<ByteArray, FfiKeyPackageStatus>

getLatestInboxState

open suspend override fun getLatestInboxState(inboxId: String): FfiInboxState

importArchive

open suspend override fun importArchive(path: String, key: ByteArray)

Import a previous archive

inboxId

open override fun inboxId(): String

inboxState

open suspend override fun inboxState(refreshFromNetwork: Boolean): FfiInboxState

installationId

open override fun installationId(): ByteArray

message

open override fun message(messageId: ByteArray): FfiMessage

registerIdentity

open suspend override fun registerIdentity(signatureRequest: FfiSignatureRequest)

releaseDbConnection

open override fun releaseDbConnection()

revokeAllOtherInstallations

open suspend override fun revokeAllOtherInstallations(): FfiSignatureRequest

revokeIdentity

open suspend override fun revokeIdentity(identifier: FfiIdentifier): FfiSignatureRequest

Revokes or removes an identity from the existing client

revokeInstallations

open suspend override fun revokeInstallations(installationIds: List<ByteArray>): FfiSignatureRequest

sendSyncRequest

open suspend override fun sendSyncRequest()

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

setConsentStates

open suspend override fun setConsentStates(records: List<FfiConsent>)

signatureRequest

open override fun signatureRequest(): FfiSignatureRequest?

signWithInstallationKey

open override fun signWithInstallationKey(text: String): ByteArray

A utility function to sign a piece of text with this installation's private key.

syncPreferences

open suspend override fun syncPreferences(): ULong

uniffiClonePointer

fun uniffiClonePointer(): Pointer

uploadDebugArchive

open suspend override fun uploadDebugArchive(serverUrl: String): String

Export an encrypted debug archive to a device sync server to inspect telemetry for debugging purposes.

verifySignedWithInstallationKey

open override fun verifySignedWithInstallationKey(signatureText: String, signatureBytes: ByteArray)

A utility function to easily verify that a piece of text was signed by this installation.

verifySignedWithPublicKey

open override fun verifySignedWithPublicKey(signatureText: String, signatureBytes: ByteArray, publicKey: ByteArray)

A utility function to easily verify that a string has been signed by another libXmtp installation. Only works for verifying libXmtp public context signatures.