GenerateLinkingURIRequest

data class GenerateLinkingURIRequest(server: String?) : SignaldRequestBodyV1<GenerateLinkingUri, 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

GenerateLinkingURIRequest
Link copied to clipboard
common
fun GenerateLinkingURIRequest(server: String? = null)

Functions

getTypedResponseOrNull
Link copied to clipboard
common
open override fun getTypedResponseOrNull(responseWrapper: JsonMessageWrapper<*>): LinkingURI?
A function to resolve the response body by verifying the type of the response and returning a non-null value iff the wrapper and data is the right type.
submit
Link copied to clipboard
common
fun submit(socketCommunicator: SocketCommunicator): LinkingURI

Properties

id
Link copied to clipboard
common
val id: String
The id to include in the request.
server
Link copied to clipboard
common
val server: String? = null
The identifier of the server to use.
version
Link copied to clipboard
common
val version: String
The version to include in the request.