UpdateGroupRequest

data class UpdateGroupRequest(account: String, groupID: String, title: String?, description: String?, avatar: String?, updateTimer: Int?, addMembers: List<JsonAddress>, removeMembers: List<JsonAddress>, updateRole: GroupMember?, updateAccessControl: GroupAccessControl?, resetLink: Boolean?) : SignaldRequestBodyV1<GroupInfo>

modify a group. Note that only one modification action may be performed at once

Constructors

UpdateGroupRequest

common

fun UpdateGroupRequest(account: String, groupID: String, title: String? = null, description: String? = null, avatar: String? = null, updateTimer: Int? = null, addMembers: List<JsonAddress> = emptyList(), removeMembers: List<JsonAddress> = emptyList(), updateRole: GroupMember? = null, updateAccessControl: GroupAccessControl? = null, resetLink: Boolean? = null)

Functions

submit

common

fun submit(socketCommunicator: SocketCommunicator): GroupInfo

submitSuspend

common

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): GroupInfo

Properties

account

common

val account: String

The identifier of the account to interact withExample: "+12024561414"

addMembers

common

val addMembers: List<JsonAddress>

avatar

common

val avatar: String? = null

Example: "/tmp/image.

description

common

val description: String? = null

A new group description.

groupID

common

val groupID: String

the ID of the group to updateExample: "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE="

id

common

The id to include in the request.

removeMembers

common

val removeMembers: List<JsonAddress>

resetLink

common

val resetLink: Boolean? = null

regenerate the group link password, invalidating the old one

title

common

val title: String? = null

Example: "Parkdale Run Club"

updateAccessControl

common

val updateAccessControl: GroupAccessControl? = null

note that only one of the access controls may be updated per request

updateRole

common

val updateRole: GroupMember? = null

updateTimer

common

val updateTimer: Int? = null

update the group timer.

version

common

val version: String

The version to include in the request.