GetGroupRequest

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

Query the server for the latest state of a known group. If no account in signald is a member of the group (anymore), an error with error_type: 'UnknownGroupException' is returned.

Constructors

GetGroupRequest
Link copied to clipboard
common
fun GetGroupRequest(account: String, groupID: String, revision: Int? = null)
Content copied to clipboard

Functions

submit
Link copied to clipboard
common
fun submit(socketCommunicator: SocketCommunicator): JsonGroupV2Info
Content copied to clipboard
submitSuspend
Link copied to clipboard
common
suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): JsonGroupV2Info
Content copied to clipboard

Properties

account
Link copied to clipboard
common
val account: String
Content copied to clipboard
The account to interact withExample: "+12024561414"
groupID
Link copied to clipboard
common
val groupID: String
Content copied to clipboard
Example: "EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE="
id
Link copied to clipboard
common
val id: String
Content copied to clipboard
The id to include in the request.
revision
Link copied to clipboard
common
val revision: Int? = null
Content copied to clipboard
the latest known revision, default value (-1) forces fetch from server
version
Link copied to clipboard
common
val version: String
Content copied to clipboard
The version to include in the request.