Link Search Menu Expand Document

Constructor: codeSettings

Back to constructors index

Settings used by telegram servers for sending the confirm code.

Example implementations: telegram for android, tdlib.

Attributes:

NameTypeRequiredDescription
allow_flashcallBoolOptionalWhether to allow phone verification via phone calls.
current_numberBoolOptionalPass true if the phone number is used on the current device. Ignored if allow_flashcall is not set.
allow_app_hashBoolOptionalIf a token that will be included in eventually sent SMSs is required: required in newer versions of android, to use the android SMS receiver APIs
allow_missed_callBoolOptionalWhether this device supports receiving the code using the auth.codeTypeMissedCall method
allow_firebaseBoolOptionalWhether Firebase auth is supported
unknown_numberBoolOptional
logout_tokensArray of bytesOptionalPreviously stored future auth tokens, see the documentation for more info »
tokenstringOptionalUsed only by official iOS apps for Firebase auth: device token for apple push.
app_sandboxBoolOptionalUsed only by official iOS apps for firebase auth: whether a sandbox-certificate will be used during transmission of the push notification.

Type: CodeSettings

Example:

$codeSettings = ['_' => 'codeSettings', 'allow_flashcall' => Bool, 'current_number' => Bool, 'allow_app_hash' => Bool, 'allow_missed_call' => Bool, 'allow_firebase' => Bool, 'unknown_number' => Bool, 'logout_tokens' => ['bytes', 'bytes'], 'token' => 'string', 'app_sandbox' => Bool];