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

GenerateLinkingURIRequest

data class GenerateLinkingURIRequest(server: String?) : SignaldRequestBodyV1<LinkingURI>

Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request.

Constructors

fun GenerateLinkingURIRequest(server: String? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): LinkingURI

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): LinkingURI

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

Properties

val id: String

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

server

val server: String? = null

The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)

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