library/org.xmtp.android.library/Client

Client

Constructors

constructor(address: String, libXMTPClient: FfiXmtpClient, dbPath: String, installationId: String, inboxId: String, environment: XMTPEnvironment)

constructor()

Types

Companion

object Companion

Functions

addAccount

suspend fun addAccount(newAccount: SigningKey)

build

suspend fun build(address: String, options: ClientOptions): Client

canMessage

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

create

suspend fun create(account: SigningKey, options: ClientOptions): Client

deleteLocalDatabase

fun deleteLocalDatabase()

dropLocalDatabaseConnection

fun ~~dropLocalDatabaseConnection~~()

findConversation

fun findConversation(conversationId: String): Conversation?

findConversationByTopic

fun findConversationByTopic(topic: String): Conversation?

findDmByAddress

suspend fun findDmByAddress(address: String): Dm?

findDmByInboxId

fun findDmByInboxId(inboxId: String): Dm?

findGroup

fun findGroup(groupId: String): Group?

findMessage

fun findMessage(messageId: String): Message?

inboxIdFromAddress

suspend fun inboxIdFromAddress(address: String): String?

inboxState

suspend fun inboxState(refreshFromNetwork: Boolean): InboxState

inboxStatesForInboxIds

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

reconnectLocalDatabase

suspend fun reconnectLocalDatabase()

removeAccount

suspend fun removeAccount(recoverAccount: SigningKey, addressToRemove: String)

requestMessageHistorySync

suspend fun requestMessageHistorySync()

revokeAllOtherInstallations

suspend fun revokeAllOtherInstallations(signingKey: SigningKey)

signWithInstallationKey

fun signWithInstallationKey(message: String): ByteArray

syncConsent

suspend fun syncConsent()

verifySignature

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

verifySignatureWithInstallationId

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

Properties

address

lateinit var address: String

conversations

lateinit var conversations: Conversations

dbPath

lateinit var dbPath: String

environment

lateinit var environment: XMTPEnvironment

inboxId

lateinit var inboxId: String

installationId

lateinit var installationId: String

libXMTPVersion

val libXMTPVersion: String

logger

var logger: XMTPLogger

preferences

lateinit var preferences: PrivatePreferences