library/uniffi.xmtp_sdk/SDKClient

SDKClient

class SDKClient

The host client resolves storage and owns the weak message lookup entry. Generated forwarders in ClientForwarding.kt expose the other Client methods and the Client statics. The generated Client stays private to the runtime.

Types

object Companion

Properties

val conversations: Conversations

Functions

fun SDKClient.appVersion(): String?

fun SDKClient.archives(): Archives

fun SDKClient.attachments(): Attachments

availableHandles

suspend fun SDKClient.availableHandles(name: String): List<String>

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

suspend fun SDKClient.catchUpToLive(timeoutMs: ULong?): CatchUpSummary

changeRecoveryIdentifier

suspend fun SDKClient.changeRecoveryIdentifier(signer: Signer, identity: PublicIdentity)

suspend fun SDKClient.claimHandle(handle: String)

suspend fun SDKClient.decodeContent(encoded: EncodedContent): MessageContent

fun SDKClient.diagnostics(): Diagnostics

disableNotifications

suspend fun SDKClient.disableNotifications()

enableNotifications

suspend fun SDKClient.enableNotifications(config: NotificationConfig): NotificationState

suspend fun end()

suspend fun SDKClient.events(filter: EventFilter): Flow<ClientEvent>

Read one event only when the flow collector requests it.

fun SDKClient.identity(): PublicIdentity

fun SDKClient.inboxId(): InboxId

suspend fun SDKClient.inboxIdFor(identity: PublicIdentity): InboxId?

suspend fun SDKClient.inboxState(refreshFromNetwork: Boolean): InboxState

suspend fun SDKClient.inboxStates(ids: List<InboxId>, refreshFromNetwork: Boolean): List<InboxState>

fun SDKClient.installationId(): InstallationId

installationIdBytes

fun SDKClient.installationIdBytes(): ByteArray

fun SDKClient.isInMemory(): Boolean

suspend fun SDKClient.isRegistered(): Boolean

keyPackageStatuses

suspend fun SDKClient.keyPackageStatuses(ids: List<InstallationId>): Map<String, KeyPackageStatus>

latestInboxUpdatesCount

suspend fun SDKClient.latestInboxUpdatesCount(ids: List<InboxId>, refreshFromNetwork: Boolean): Map<String, ULong>

fun SDKClient.libxmtpVersion(): String

notificationState

fun SDKClient.notificationState(): NotificationState

fun SDKClient.options(): ClientOptions

ownInboxUpdatesCount

suspend fun SDKClient.ownInboxUpdatesCount(refreshFromNetwork: Boolean): ULong

fun SDKClient.preferences(): Preferences

refreshServerConfiguration

suspend fun SDKClient.refreshServerConfiguration(): ServerConfiguration

suspend fun SDKClient.register()

suspend fun SDKClient.removeAccount(recoverySigner: Signer, identity: PublicIdentity)

revokeAllOtherInstallations

suspend fun SDKClient.revokeAllOtherInstallations(signer: Signer)

revokeInstallations

suspend fun SDKClient.revokeInstallations(signer: Signer, ids: List<InstallationId>)

serverConfiguration

fun SDKClient.serverConfiguration(): ServerConfiguration

suspend fun SDKClient.setCredential(credential: Credential)

signWithInstallationKey

suspend fun SDKClient.signWithInstallationKey(text: String): ByteArray

suspend fun SDKClient.startListener(filter: EventFilter, onEvent: suspend (ClientEvent) -> Unit): ListenerId

suspend fun SDKClient.stopListener(id: ListenerId)

fun storage(): Storage

fun SDKClient.storagePath(): String?

syncAllDeviceSyncGroups

suspend fun SDKClient.syncAllDeviceSyncGroups(): GroupSyncSummary

unsafeAddAccount

suspend fun SDKClient.unsafeAddAccount(signer: Signer, allowInboxReassign: Boolean)

unsafeAddAccountSignatureRequest

suspend fun SDKClient.unsafeAddAccountSignatureRequest(identity: PublicIdentity, allowInboxReassign: Boolean): SignatureRequest

unsafeApplySignatureRequest

suspend fun SDKClient.unsafeApplySignatureRequest(request: SignatureRequest)

unsafeChangeRecoveryIdentifierSignatureRequest

suspend fun SDKClient.unsafeChangeRecoveryIdentifierSignatureRequest(identity: PublicIdentity): SignatureRequest

unsafeCreateInboxSignatureRequest

suspend fun SDKClient.unsafeCreateInboxSignatureRequest(): SignatureRequest?

unsafeRemoveAccountSignatureRequest

suspend fun SDKClient.unsafeRemoveAccountSignatureRequest(identity: PublicIdentity): SignatureRequest

unsafeRevokeAllOtherInstallationsSignatureRequest

suspend fun SDKClient.unsafeRevokeAllOtherInstallationsSignatureRequest(): SignatureRequest?

unsafeRevokeInstallationsSignatureRequest

suspend fun SDKClient.unsafeRevokeInstallationsSignatureRequest(ids: List<InstallationId>): SignatureRequest

verifySignedWithInstallationKey

suspend fun SDKClient.verifySignedWithInstallationKey(text: String, signature: ByteArray): Boolean