Interface PhoneNumberAuthenticationSettings

Contains settings for the authentication of the user's phone number.

interface PhoneNumberAuthenticationSettings {
    @type: "phoneNumberAuthenticationSettings";
    allow_flash_call?: boolean;
    allow_missed_call?: boolean;
    allow_sms_retriever_api?: boolean;
    authentication_tokens: string[];
    firebase_authentication_settings: FirebaseAuthenticationSettings;
    has_unknown_phone_number?: boolean;
    is_current_phone_number?: boolean;
}

Properties

@type allow_flash_call? allow_missed_call? allow_sms_retriever_api? authentication_tokens firebase_authentication_settings has_unknown_phone_number? is_current_phone_number?

Properties

@type

@type: "phoneNumberAuthenticationSettings"

Optional allow_flash_call

allow_flash_call?: boolean

Pass true if the authentication code may be sent via a flash call to the specified phone number.

Optional allow_missed_call

allow_missed_call?: boolean

Pass true if the authentication code may be sent via a missed call to the specified phone number.

Optional allow_sms_retriever_api

allow_sms_retriever_api?: boolean

For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services >= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details.

authentication_tokens

authentication_tokens: string[]

List of up to 20 authentication tokens, recently received in updateOption("authentication_token") in previously logged out sessions.

firebase_authentication_settings

firebase_authentication_settings: FirebaseAuthenticationSettings

For official Android and iOS applications only; pass null otherwise. Settings for Firebase Authentication.

Optional has_unknown_phone_number

has_unknown_phone_number?: boolean

Pass true if there is a SIM card in the current device, but it is not possible to check whether phone number matches.

Optional is_current_phone_number

is_current_phone_number?: boolean

Pass true if the authenticated phone number is used on the current device.

Settings

Member Visibility

Theme

On This Page

@typeallow_flash_callallow_missed_callallow_sms_retriever_apiauthentication_tokensfirebase_authentication_settingshas_unknown_phone_numberis_current_phone_number