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

FinishLinkRequest

data class FinishLinkRequest(overwrite: Boolean?, deviceName: String?, sessionId: String?) : SignaldRequestBodyV1<Account>

After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link.

Constructors

FinishLinkRequest

fun FinishLinkRequest(overwrite: Boolean? = null, deviceName: String? = null, sessionId: String? = null)

Functions

submit

fun submit(socketCommunicator: SocketCommunicator): Account

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

submitSuspend

suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): Account

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

Properties

deviceName

val deviceName: String? = null

val id: String

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

overwrite

val overwrite: Boolean? = null

overwrite existing account data if the phone number conflicts. false by default

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