library/uniffi.xmtp_sdk/ConversationsInterface

ConversationsInterface

interface ConversationsInterface

Inheritors

Conversations

Types

Companion

object Companion

Functions

beginningDeliveryCursor

abstract suspend fun beginningDeliveryCursor(): String

conversationReader

abstract suspend fun conversationReader(options: ConversationReaderOptions?): ConversationReader

createDm

abstract suspend fun createDm(peer: InboxId, options: CreateDmOptions? = null): Dm

createGroup

abstract suspend fun createGroup(members: List<InboxId>, options: CreateGroupOptions? = null): Group

Find or create a DM with an account identity or a handle. Hosts present this as a createDm overload or union. An account or a handle resolves through the verified resolver before the existing DM is looked up.

createGroupOptimistic

abstract suspend fun createGroupOptimistic(options: CreateGroupOptions? = null): Group

deleteMessage

abstract suspend fun deleteMessage(id: MessageId): MessageId

Delete a message for everyone. Returns the id of the queued deletion message, which publishes with the conversation's next publish. When the message is this installation's and was never sent, it is cancelled instead and the id names the cancelled message; nothing is published.

deleteMessageLocally

abstract suspend fun deleteMessageLocally(id: MessageId)

getById

abstract suspend fun getById(id: ConversationId): Conversation?

getDmByIdentity

abstract suspend fun getDmByIdentity(identity: PublicIdentity): Dm?

The DM with an account or a handle, or None. Either resolves through the verified resolver before the DM is looked up.

getDmByInboxId

abstract suspend fun getDmByInboxId(peer: InboxId): Dm?

getMessageById

abstract suspend fun getMessageById(id: MessageId): Message?

hmacKeys

abstract suspend fun hmacKeys(): Map<String, List<HmacKey>>

list

abstract suspend fun list(options: ListConversationsOptions? = null): List<Conversation>

listDms

abstract suspend fun listDms(options: ListConversationsOptions?): List<Dm>

listGroups

abstract suspend fun listGroups(options: ListConversationsOptions?): List<Group>

messageHistorySnapshot

abstract suspend fun messageHistorySnapshot(limit: UInt, options: MessageReaderOptions? = null): MessageHistorySnapshot

Capture history with kind and consent selection. A replay from cursor is invalid because this call captures a new atomic replay boundary.

messageReader

abstract suspend fun messageReader(options: MessageReaderOptions? = null): MessageReader

reactToMessage

abstract suspend fun reactToMessage(id: MessageId, reaction: Reaction, options: SendOptions? = null): MessageId

replyToMessage

abstract suspend fun replyToMessage(id: MessageId, content: EncodedContent, options: SendOptions? = null): MessageId

sync

abstract suspend fun sync()

Host stream ownership.

syncAll

abstract suspend fun syncAll(consentStates: List<ConsentState>?): GroupSyncSummary