library/org.xmtp.android.library/Group

Group

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

Constructors

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

Functions

suspend fun addAdmin(inboxId: String)

fun addedByInboxId(): String

suspend fun addMembers(addresses: List<String>)

addMembersByInboxId

suspend fun addMembersByInboxId(inboxIds: List<String>)

suspend fun addSuperAdmin(inboxId: String)

clearDisappearingMessageSettings

suspend fun clearDisappearingMessageSettings()

fun consentState(): ConsentState

suspend fun creatorInboxId(): String

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

fun isActive(): Boolean

fun isAdmin(inboxId: String): Boolean

suspend fun isCreator(): Boolean

fun isSuperAdmin(inboxId: String): Boolean

suspend fun lastMessage(): Message?

suspend fun listAdmins(): List<String>

listSuperAdmins

suspend fun listSuperAdmins(): List<String>

suspend fun members(): List<Member>

suspend fun messages(limit: Int? = null, beforeNs: Long? = null, afterNs: Long? = null, direction: Message.SortDirection = SortDirection.DESCENDING, deliveryStatus: Message.MessageDeliveryStatus = MessageDeliveryStatus.ALL): List<Message>

messagesWithReactions

suspend fun messagesWithReactions(limit: Int? = null, beforeNs: Long? = null, afterNs: Long? = null, direction: Message.SortDirection = SortDirection.DESCENDING, deliveryStatus: Message.MessageDeliveryStatus = MessageDeliveryStatus.ALL): List<Message>

suspend fun peerInboxIds(): List<String>

permissionPolicySet

fun permissionPolicySet(): PermissionPolicySet

fun prepareMessage(encodedContent: EncodedContent): String

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

suspend fun processMessage(messageBytes: ByteArray): Message?

publishMessages

suspend fun publishMessages()

suspend fun removeAdmin(inboxId: String)

suspend fun removeMembers(addresses: List<String>)

removeMembersByInboxId

suspend fun removeMembersByInboxId(inboxIds: List<String>)

removeSuperAdmin

suspend fun removeSuperAdmin(inboxId: String)

suspend fun send(text: String): String

suspend fun send(encodedContent: EncodedContent): String

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

fun streamMessages(): Flow<Message>

suspend fun sync()

updateAddAdminPermission

suspend fun updateAddAdminPermission(newPermissionOption: PermissionOption)

updateAddMemberPermission

suspend fun updateAddMemberPermission(newPermissionOption: PermissionOption)

updateConsentState

fun updateConsentState(state: ConsentState)

updateDisappearingMessageSettings

suspend fun updateDisappearingMessageSettings(disappearingMessageSettings: DisappearingMessageSettings?)

updateGroupDescription

suspend fun updateGroupDescription(description: String)

updateGroupDescriptionPermission

suspend fun updateGroupDescriptionPermission(newPermissionOption: PermissionOption)

updateGroupImageUrlSquare

suspend fun updateGroupImageUrlSquare(imageUrl: String)

updateGroupImageUrlSquarePermission

suspend fun updateGroupImageUrlSquarePermission(newPermissionOption: PermissionOption)

updateGroupName

suspend fun updateGroupName(name: String)

updateGroupNamePermission

suspend fun updateGroupNamePermission(newPermissionOption: PermissionOption)

updateRemoveAdminPermission

suspend fun updateRemoveAdminPermission(newPermissionOption: PermissionOption)

updateRemoveMemberPermission

suspend fun updateRemoveMemberPermission(newPermissionOption: PermissionOption)

Properties

val client: Client

val createdAt: Date

val description: String

disappearingMessageSettings

val disappearingMessageSettings: DisappearingMessageSettings?

val imageUrlSquare: String

isDisappearingMessagesEnabled

val isDisappearingMessagesEnabled: Boolean

val name: String

val topic: String