Pre-release APIs, grouped under UnstableGroup. The @UnstableApi opt-in is applied once here, so every function on UnstableGroup is covered without a per-function annotation. Call sites must @OptIn(UnstableApi::class); when a function graduates it moves onto Group and the opt-in stops resolving, forcing a migration.

Functions

addAdmin

suspend fun addAdmin(inboxId: InboxId)

addedByInboxId

suspend fun addedByInboxId(): InboxId

addMembers

suspend fun addMembers(inboxIds: List<InboxId>): GroupMembershipResult

addMembersByIdentity

suspend fun addMembersByIdentity(identities: List<PublicIdentity>): GroupMembershipResult

addSuperAdmin

suspend fun addSuperAdmin(inboxId: InboxId)

appData

suspend fun appData(): String

beginningDeliveryCursor

suspend fun beginningDeliveryCursor(): DeliveryCursor

clearDisappearingMessageSettings

suspend fun clearDisappearingMessageSettings()

commitLogForkStatus

fun commitLogForkStatus(): ConversationDebugInfo.CommitLogForkStatus

consentState

suspend fun consentState(): ConsentState

countMessages

suspend fun countMessages(beforeNs: Long? = null, afterNs: Long? = null, deliveryStatus: DecodedMessage.MessageDeliveryStatus = MessageDeliveryStatus.ALL, excludeContentTypes: List<FfiContentType>? = null, excludeSenderInboxIds: List<String>? = null, insertedAfterNs: Long? = null, insertedBeforeNs: Long? = null): Long

creatorInboxId

suspend fun creatorInboxId(): InboxId

deleteMessage

suspend fun deleteMessage(messageId: String): String

Delete a message by its ID.

description

suspend fun description(): String

disappearingMessageSettings

suspend fun disappearingMessageSettings(): DisappearingMessageSettings?

encodeContent

fun <T> encodeContent(content: T, options: SendOptions?): Pair<EncodedContent, MessageVisibilityOptions>

enrichedMessages

suspend fun enrichedMessages(limit: Int? = null, beforeNs: Long? = null, afterNs: Long? = null, direction: DecodedMessage.SortDirection = SortDirection.DESCENDING, deliveryStatus: DecodedMessage.MessageDeliveryStatus = MessageDeliveryStatus.ALL, excludeContentTypes: List<FfiContentType>? = null, excludeSenderInboxIds: List<String>? = null, insertedAfterNs: Long? = null, insertedBeforeNs: Long? = null, sortBy: DecodedMessage.SortBy = SortBy.SENT_TIME): List<DecodedMessageV2>

Get messages with enriched metadata automatically included.

equals

open operator override fun equals(other: Any?): Boolean

getDebugInformation

suspend fun getDebugInformation(): ConversationDebugInfo

getHmacKeys

suspend fun getHmacKeys(): Keystore.GetConversationHmacKeysResponse

getLastReadTimes

suspend fun getLastReadTimes(): Map<InboxId, Long>

hashCode

open override fun hashCode(): Int

imageUrl

suspend fun imageUrl(): String

isActive

suspend fun isActive(): Boolean

isAdmin

suspend fun isAdmin(inboxId: InboxId): Boolean

isCreator

suspend fun isCreator(): Boolean

isDisappearingMessagesEnabled

suspend fun isDisappearingMessagesEnabled(): Boolean

isSuperAdmin

suspend fun isSuperAdmin(inboxId: InboxId): Boolean

lastMessage

suspend fun lastMessage(): DecodedMessage?

leaveGroup

suspend fun leaveGroup()

listAdmins

suspend fun listAdmins(): List<InboxId>

listSuperAdmins

suspend fun listSuperAdmins(): List<InboxId>

members

suspend fun members(): List<Member>

membershipCapabilities

suspend fun membershipCapabilities(): GroupMembershipCapabilities

Snapshot this group's membership capabilities: the group context's extension types plus, per member inbox and installation, the extension types each advertises.

membershipState

suspend fun membershipState(): GroupMembershipState

messageHistorySnapshot

suspend fun messageHistorySnapshot(limit: UInt): MessageHistorySnapshot

messageReader

suspend fun messageReader(from: DeliveryCursor? = null): MessageReader

Supply a cursor to replay independently of default delivery progress.

messages

suspend fun messages(limit: Int? = null, beforeNs: Long? = null, afterNs: Long? = null, direction: DecodedMessage.SortDirection = SortDirection.DESCENDING, deliveryStatus: DecodedMessage.MessageDeliveryStatus = MessageDeliveryStatus.ALL, excludeContentTypes: List<FfiContentType>? = null, excludeSenderInboxIds: List<String>? = null, insertedAfterNs: Long? = null, insertedBeforeNs: Long? = null, sortBy: DecodedMessage.SortBy = SortBy.SENT_TIME): List<DecodedMessage>

Get the raw list of messages from this group.

messagesWithReactions

suspend fun messagesWithReactions(limit: Int? = null, beforeNs: Long? = null, afterNs: Long? = null, direction: DecodedMessage.SortDirection = SortDirection.DESCENDING, deliveryStatus: DecodedMessage.MessageDeliveryStatus = MessageDeliveryStatus.ALL, excludeContentTypes: List<FfiContentType>? = null, excludeSenderInboxIds: List<String>? = null, insertedAfterNs: Long? = null, insertedBeforeNs: Long? = null, sortBy: DecodedMessage.SortBy = SortBy.SENT_TIME): List<DecodedMessage>

name

suspend fun name(): String

notificationsEnabled

suspend fun notificationsEnabled(): Boolean

Read the effective notification value for this conversation.

pausedForVersion

suspend fun pausedForVersion(): String?

peerInboxIds

suspend fun peerInboxIds(): List<InboxId>

permissionPolicySet

suspend fun permissionPolicySet(): PermissionPolicySet

permissions

suspend fun permissions(): FfiGroupPermissions

prepareMessage

suspend fun <T> prepareMessage(content: T, options: SendOptions? = null, noSend: Boolean = false): String

suspend fun prepareMessage(encodedContent: EncodedContent, opts: MessageVisibilityOptions = MessageVisibilityOptions(shouldPush = true), noSend: Boolean = false): String

Prepares a message for sending.

processMessage

suspend fun processMessage(messageBytes: ByteArray): DecodedMessage?

proposalsEnabled

suspend fun proposalsEnabled(): Boolean

Whether this group has migrated to AppData-proposal-based metadata updates. false means the group is still on the legacy GroupContextExtensions path. Prefer this semantic bool over scanning membershipCapabilities for the marker extension.

publishMessage

suspend fun publishMessage(id: String)

Publishes a message that was prepared with noSend = true.

publishMessages

suspend fun publishMessages()

removeAdmin

suspend fun removeAdmin(inboxId: InboxId)

removeMembers