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

WaitForScanRequest

data class WaitForScanRequest(sessionId: String?) : SignaldRequestBodyV1<EmptyResponse>

An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error

Constructors

WaitForScanRequest

fun WaitForScanRequest(sessionId: String? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): EmptyResponse

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): EmptyResponse

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

Properties

val id: String

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

sessionId

val sessionId: String? = null

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