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

RegisterRequest

data class RegisterRequest(account: String, voice: Boolean?, captcha: String?, server: String?) : SignaldRequestBodyV1<Account>

begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request

Constructors

RegisterRequest

fun RegisterRequest(account: String, voice: Boolean? = null, captcha: String? = null, server: 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

account

val account: String

the e164 phone number to register with

captcha

val captcha: String? = null

See https://signald.org/articles/captcha/

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

voice

val voice: Boolean? = null

set to true to request a voice call instead of an SMS for verification