library/uniffi.xmtp_sdk/Conversations

Conversations

open class Conversations : Disposable, AutoCloseable, ConversationsInterface

Properties

uniffiIsDestroyed

val uniffiIsDestroyed: Boolean

Whether the current object has been destroyed and its reference is gone in the Rust side.

Functions

beginningDeliveryCursor

open suspend override fun beginningDeliveryCursor(): String

@Synchronized

open override fun close()

conversationReader

open suspend override fun conversationReader(options: ConversationReaderOptions?): ConversationReader

createDm

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

createDm

suspend fun Conversations.createDm(peer: PublicIdentity, options: CreateDmOptions? = null): Dm

createGroup

open suspend override 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.

createGroup

suspend fun Conversations.createGroup(members: List<PublicIdentity>, options: CreateGroupOptions? = null): Group

createGroupOptimistic

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

deleteMessage

open suspend override 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

open suspend override fun deleteMessageLocally(id: MessageId)

destroy

open override fun destroy()

getById

open suspend override fun getById(id: ConversationId): Conversation?

getDmByIdentity

open suspend override 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

open suspend override fun getDmByInboxId(peer: InboxId): Dm?

getMessageById

open suspend override fun getMessageById(id: MessageId): Message?

hmacKeys

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

list

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

listDms

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

listGroups

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

messageHistorySnapshot

open suspend override 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

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

reactToMessage

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

replyToMessage

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

stream

fun Conversations.stream(options: ConversationStreamOptions = ConversationStreamOptions()): Flow<Conversation>

This cold Flow holds its client. Each collection opens a conversation reader.

streamAllMessages

fun Conversations.streamAllMessages(options: MessageStreamOptions = MessageStreamOptions()): Flow<Message>

This cold Flow holds its client before and between collections. Each collection opens a reader. With direct sequential collection, the next read acknowledges the previous message after the collector returns. A buffer or asynchronous operator can let acknowledgement start before downstream work finishes. Cancellation cannot undo an acknowledgement that has started.

sync

open suspend override fun sync()

Host stream ownership.

syncAll

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