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

VerifyRequest

data class VerifyRequest(account: String, code: String) : SignaldRequestBodyV1<Account>

verify an account's phone number with a code after registering, completing the account creation process

Constructors

VerifyRequest

fun VerifyRequest(account: String, code: String)

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

account

val account: String

the e164 phone number being verified

code

val code: String

the verification code, dash (-) optional

val id: String

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

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