clientprotocol/org.inthewaves.kotlinsignald.clientprotocol.v1.structures/CreateGroupRequest

CreateGroupRequest

data class CreateGroupRequest(account: String, title: String, avatar: String?, members: List<JsonAddress>, timer: Int?, memberRole: String?) : SignaldRequestBodyV1<JsonGroupV2Info>

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): JsonGroupV2Info

open override fun submit(socketCommunicator: SocketCommunicator, id: String): JsonGroupV2Info

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): JsonGroupV2Info

open suspend override fun submitSuspend(socketCommunicator: SuspendSocketCommunicator, id: String): JsonGroupV2Info

Properties

account

val account: String

The account to interact with

avatar

val avatar: String? = null

Example: "/tmp/image.jpg"

val id: String

The id to include in the request. This is expected to be present in the response JSON.

memberRole

val memberRole: String? = null

The role of all members other than the group creator. Options are ADMINISTRATOR or DEFAULT (case insensitive)

members

val members: List<JsonAddress>

timer

val timer: Int? = null

the message expiration timer

title

val title: String

Example: "Parkdale Run Club"

version

val version: String

The version to include in the request. As this class won't be used to deserialize the response, the Required annotation is being used to force this field to be serialized