RegisterRequest

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

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
Link copied to clipboard
common
fun RegisterRequest(account: String, voice: Boolean? = null, captcha: String? = null, server: String? = null)
Content copied to clipboard

Functions

submit
Link copied to clipboard
common
fun submit(socketCommunicator: SocketCommunicator): Account
Content copied to clipboard
submitSuspend
Link copied to clipboard
common
suspend fun submitSuspend(socketCommunicator: SuspendSocketCommunicator): Account
Content copied to clipboard

Properties

account
Link copied to clipboard
common
val account: String
Content copied to clipboard
the e164 phone number to register withExample: "+12024561414"
captcha
Link copied to clipboard
common
val captcha: String? = null
Content copied to clipboard
See https://signald.
id
Link copied to clipboard
common
val id: String
Content copied to clipboard
The id to include in the request.
server
Link copied to clipboard
common
val server: String? = null
Content copied to clipboard
The identifier of the server to use.
version
Link copied to clipboard
common
val version: String
Content copied to clipboard
The version to include in the request.
voice
Link copied to clipboard
common
val voice: Boolean? = null
Content copied to clipboard
set to true to request a voice call instead of an SMS for verification