library/org.xmtp.android.library/Group

Group

class Group(val client: Client, libXMTPGroup: FfiConversation, ffiLastMessage: FfiMessage? = null, ffiIsCommitLogForked: Boolean? = null)

Constructors

constructor(client: Client, libXMTPGroup: FfiConversation, ffiLastMessage: FfiMessage? = null, ffiIsCommitLogForked: Boolean? = null)

Functions

suspend fun addAdmin(inboxId: InboxId)

suspend fun addedByInboxId(): InboxId

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

addMembersByIdentity

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

suspend fun addSuperAdmin(inboxId: InboxId)

clearDisappearingMessageSettings

suspend fun clearDisappearingMessageSettings()

commitLogForkStatus

fun commitLogForkStatus(): ConversationDebugInfo.CommitLogForkStatus

suspend fun consentState(): ConsentState

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

suspend fun creatorInboxId(): InboxId

suspend fun description(): String

disappearingMessageSettings

suspend fun disappearingMessageSettings(): DisappearingMessageSettings?

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): List<DecodedMessageV2>

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

getDebugInformation

suspend fun getDebugInformation(): ConversationDebugInfo

suspend fun getHmacKeys(): Keystore.GetConversationHmacKeysResponse

getLastReadTimes

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

fun getPushTopics(): List<String>

open override fun hashCode(): Int

suspend fun imageUrl(): String

suspend fun isActive(): Boolean

suspend fun isAdmin(inboxId: InboxId): Boolean

suspend fun isCreator(): Boolean

isDisappearingMessagesEnabled

suspend fun isDisappearingMessagesEnabled(): Boolean

suspend fun isSuperAdmin(inboxId: InboxId): Boolean

suspend fun lastMessage(): DecodedMessage?

suspend fun listAdmins(): List<InboxId>

listSuperAdmins

suspend fun listSuperAdmins(): List<InboxId>

suspend fun members(): List<Member>

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): List<DecodedMessage>

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): List<DecodedMessage>

suspend fun name(): String

pausedForVersion

suspend fun pausedForVersion(): String?

suspend fun peerInboxIds(): List<InboxId>

permissionPolicySet

suspend fun permissionPolicySet(): PermissionPolicySet

suspend fun permissions(): FfiGroupPermissions

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

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

suspend fun processMessage(messageBytes: ByteArray): DecodedMessage?

publishMessages

suspend fun publishMessages()

suspend fun removeAdmin(inboxId: InboxId)

suspend fun removeMembers(inboxIds: List<InboxId>)

removeMembersByIdentity

suspend fun removeMembersByIdentity(identities: List<PublicIdentity>)

removeSuperAdmin

suspend fun removeSuperAdmin(inboxId: InboxId)

suspend fun send(text: String): String

suspend fun <T> send(content: T, options: SendOptions? = null): String

suspend fun send(encodedContent: EncodedContent, opts: MessageVisibilityOptions = MessageVisibilityOptions(shouldPush = true)): String

fun streamMessages(onClose: () -> Unit? = null): Flow<DecodedMessage>

suspend fun sync()

updateAddAdminPermission

suspend fun updateAddAdminPermission(newPermissionOption: PermissionOption)

updateAddMemberPermission

suspend fun updateAddMemberPermission(newPermissionOption: PermissionOption)

updateConsentState

suspend fun updateConsentState(state: ConsentState)

updateDescription

suspend fun updateDescription(description: String)

updateDescriptionPermission

suspend fun updateDescriptionPermission(newPermissionOption: PermissionOption)

updateDisappearingMessageSettings

suspend fun updateDisappearingMessageSettings(disappearingMessageSettings: DisappearingMessageSettings?)

suspend fun updateImageUrl(imageUrl: String)

updateImageUrlPermission

suspend fun updateImageUrlPermission(newPermissionOption: PermissionOption)

suspend fun updateName(name: String)

updateNamePermission

suspend fun updateNamePermission(newPermissionOption: PermissionOption)

updateRemoveAdminPermission

suspend fun updateRemoveAdminPermission(newPermissionOption: PermissionOption)

updateRemoveMemberPermission

suspend fun updateRemoveMemberPermission(newPermissionOption: PermissionOption)

Properties

val client: Client

val createdAt: Date

val createdAtNs: Long

val ~~description~~: String

disappearingMessageSettings

val ~~disappearingMessageSettings~~: DisappearingMessageSettings?

val ~~imageUrl~~: String

isDisappearingMessagesEnabled

val ~~isDisappearingMessagesEnabled~~: Boolean

val lastActivityNs: Long

val ~~name~~: String

val topic: String