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

BanUserRequest

data class BanUserRequest(account: String, groupId: String, users: List<JsonAddress>) : SignaldRequestBodyV1<JsonGroupV2Info>

Bans users from a group. This works even if the users aren't in the group. If they are currently in the group, they will also be removed.

Constructors

BanUserRequest

fun BanUserRequest(account: String, groupId: String, users: List<JsonAddress>)

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.

users

val users: List<JsonAddress>

List of users to ban

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