The handles for name that no inbox holds, the name itself first. name is a handle as a user typed it; its ASCII capitals become lowercase. A name with a code checks only that handle. A name without a code checks itself and 100 random codes in one lookup. Text outside the handle grammar fails with InvalidArgument, before any request. The SDK applies no other rule, so a claim of a returned handle can still fail with HandleNotAllowed. An unregistered client can call it.

canMessage

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

Returns one entry per core identity. Keys use ethereum:<core text>, passkey:<lowercase core hex>, or handle:<canonical handle>. A handle is available when the backend names an inbox for it.

catchUpToLive

open suspend override fun catchUpToLive(timeoutMs: ULong?): CatchUpSummary

changeRecoveryIdentifier

open suspend override fun changeRecoveryIdentifier(signer: Signer, identity: PublicIdentity)

claimHandle

open suspend override fun claimHandle(handle: String)

Claim handle for this inbox, signed by this installation's key. It becomes the inbox's current handle, including when the inbox claimed it before. Fails with HandleTaken, HandleNotAllowed, HandleTooSoon, or HandleLimitReached, none of them retryable, and with InvalidArgument for text outside the handle grammar.

clientKey

open override fun clientKey(): ULong

Host runtimes use this key to find the owner of a lifted message.

@Synchronized

open override fun close()

conversations

open override fun conversations(): Conversations

decodeContent

open suspend override fun decodeContent(encoded: EncodedContent): MessageContent

destroy

open override fun destroy()

diagnostics

open override fun diagnostics(): Diagnostics

disableNotifications

open suspend override fun disableNotifications()

enableNotifications

open suspend override fun enableNotifications(config: NotificationConfig): NotificationState

end

open suspend override fun end()

events

open suspend override fun events(filter: EventFilter): EventReader

identity

open override fun identity(): PublicIdentity

inboxId

open override fun inboxId(): InboxId

inboxIdFor

open suspend override fun inboxIdFor(identity: PublicIdentity): InboxId?

The inbox of an account or a handle, or None. A handle resolves only when the inbox the backend names holds it in its own identity log, and an old handle of an inbox still resolves to it. This never derives an inbox ID from a handle.

inboxState

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

inboxStates

open suspend override fun inboxStates(ids: List<InboxId>, refreshFromNetwork: Boolean): List<InboxState>

installationId

open override fun installationId(): InstallationId

installationIdBytes

open override fun installationIdBytes(): ByteArray

isInMemory

open override fun isInMemory(): Boolean

isRegistered

open suspend override fun isRegistered(): Boolean

keyPackageStatuses

open suspend override fun keyPackageStatuses(ids: List<InstallationId>): Map<String, KeyPackageStatus>

latestInboxUpdatesCount

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

libxmtpVersion

open override fun libxmtpVersion(): String

notificationState

open override fun notificationState(): NotificationState

options

open override fun options(): ClientOptions

The options this client was built with, without its secrets: the static credential, the credential source, and the storage encryption key are None. Any holder of the client can read these options, and the browser worker copies them to the page.

ownInboxUpdatesCount

open suspend override fun ownInboxUpdatesCount(refreshFromNetwork: Boolean): ULong

preferences

open override fun preferences(): Preferences

refreshServerConfiguration

open suspend override fun refreshServerConfiguration(): ServerConfiguration

open suspend override fun register()

removeAccount

open suspend override fun removeAccount(recoverySigner: Signer, identity: PublicIdentity)

revokeAllOtherInstallations

open suspend override fun revokeAllOtherInstallations(signer: Signer)

revokeInstallations

open suspend override fun revokeInstallations(signer: Signer, ids: List<InstallationId>)

serverConfiguration

open override fun serverConfiguration(): ServerConfiguration

setCredential

open suspend override fun setCredential(credential: Credential)

signWithInstallationKey

open suspend override fun signWithInstallationKey(text: String): ByteArray

startListener

open suspend override fun startListener(filter: EventFilter, listener: EventListener): ListenerId

stopListener

open suspend override fun stopListener(id: ListenerId)

storage

open override fun storage(): Storage

storagePath

open override fun storagePath(): String?

syncAllDeviceSyncGroups

open suspend override fun syncAllDeviceSyncGroups(): GroupSyncSummary

unsafeAddAccount

open suspend override fun unsafeAddAccount(signer: Signer, allowInboxReassign: Boolean)

unsafeAddAccountSignatureRequest

open suspend override fun unsafeAddAccountSignatureRequest(identity: PublicIdentity, allowInboxReassign: Boolean): SignatureRequest

unsafeApplySignatureRequest

open suspend override fun unsafeApplySignatureRequest(request: SignatureRequest)

unsafeChangeRecoveryIdentifierSignatureRequest

open suspend override fun unsafeChangeRecoveryIdentifierSignatureRequest(identity: PublicIdentity): SignatureRequest

unsafeCreateInboxSignatureRequest

open suspend override fun unsafeCreateInboxSignatureRequest(): SignatureRequest?

unsafeRemoveAccountSignatureRequest

open suspend override fun unsafeRemoveAccountSignatureRequest(identity: PublicIdentity): SignatureRequest

unsafeRevokeAllOtherInstallationsSignatureRequest

open suspend override fun unsafeRevokeAllOtherInstallationsSignatureRequest(): SignatureRequest?

unsafeRevokeInstallationsSignatureRequest

open suspend override fun unsafeRevokeInstallationsSignatureRequest(ids: List<InstallationId>): SignatureRequest

verifySignedWithInstallationKey

open suspend override fun verifySignedWithInstallationKey(text: String, signature: ByteArray): Boolean