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

GetGroupRequest

data class GetGroupRequest(account: String, groupID: String, revision: Int?) : SignaldRequestBodyV1<JsonGroupV2Info>

Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned.

Constructors

GetGroupRequest

fun GetGroupRequest(account: String, groupID: String, revision: Int? = null)

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

groupID

val groupID: String

Example: "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE="

val id: String

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

revision

val revision: Int? = null

the latest known revision, default value (-1) forces fetch from server

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