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

JoinGroupRequest

data class JoinGroupRequest(account: String, uri: String) : SignaldRequestBodyV1<JsonGroupJoinInfo>

Join a group using the a signal.group URL. Note that you must have a profile name set to join groups.

Constructors

JoinGroupRequest

fun JoinGroupRequest(account: String, uri: String)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): JsonGroupJoinInfo

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): JsonGroupJoinInfo

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

Properties

account

val account: String

The account to interact with

val id: String

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

uri

val uri: String

The signal.group URL

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