SmsCodeRetriever

Kotlin |Java

public final class SmsCodeRetriever

SmsCodeRetriever is a variant of SmsRetriever, and it provides access to Google services that help you retrieve SMS verification codes sent to the user's device, without having to ask for android.permission.READ_SMS or android.permission.RECEIVE_SMS.

To use SmsCodeRetriever in the Android autofill service, obtain an instance of using getAutofillClient or getAutofillClient, and start SMS Code Retriever service by calling startSmsCodeRetriever. To use it in the browser app, you obtain an instance of SmsCodeBrowserClient using getBrowserClient or getBrowserClient instead.

The service first looks for an SMS verification code from messages recently received (up to 1 minute prior). If there is no SMS verification code found from the SMS inbox, it waits for new incoming SMS messages until it finds an SMS verification code or reaches the timeout (about 5 minutes).

Summary

Constants
`static final String`	`EXTRA_SMS_CODE = "com.google.android.gms.auth.api.phone.EXTRA_SMS_CODE"` Intent extra key of the retrieved SMS verification code by the `SmsCodeAutofillClient`.
`static final String`	`EXTRA_SMS_CODE_LINE = "com.google.android.gms.auth.api.phone.EXTRA_SMS_CODE_LINE"` Intent extra key of the retrieved SMS verification code line by `SmsCodeBrowserClient`.
`static final String`	`EXTRA_STATUS = "com.google.android.gms.auth.api.phone.EXTRA_STATUS"` Intent extra key of `Status`, which indicates `RESULT_SUCCESS`, `RESULT_TIMEOUT` or `SmsRetrieverStatusCodes`.
`static final String`	`SMS_CODE_RETRIEVED_ACTION = "com.google.android.gms.auth.api.phone.SMS_CODE_RETRIEVED"` Intent action when an SMS verification code is retrieved.

Public methods
`static SmsCodeAutofillClient`	`getAutofillClient(Activity activity)` Creates a new instance of `SmsCodeAutofillClient` for use in an `Activity`.
`static SmsCodeAutofillClient`	`getAutofillClient(Context context)` Creates a new instance of `SmsCodeAutofillClient` for use in a `Context`.
`static SmsCodeBrowserClient`	`getBrowserClient(Activity activity)` Creates a new instance of `SmsCodeBrowserClient` for use in an `Activity`.
`static SmsCodeBrowserClient`	`getBrowserClient(Context context)` Creates a new instance of `SmsCodeBrowserClient` for use in a `Context`.

Constants

EXTRA_SMS_CODE

public static final String EXTRA_SMS_CODE = "com.google.android.gms.auth.api.phone.EXTRA_SMS_CODE"

Intent extra key of the retrieved SMS verification code by the SmsCodeAutofillClient.

EXTRA_SMS_CODE_LINE

public static final String EXTRA_SMS_CODE_LINE = "com.google.android.gms.auth.api.phone.EXTRA_SMS_CODE_LINE"

Intent extra key of the retrieved SMS verification code line by SmsCodeBrowserClient.

EXTRA_STATUS

public static final String EXTRA_STATUS = "com.google.android.gms.auth.api.phone.EXTRA_STATUS"

Intent extra key of Status, which indicates RESULT_SUCCESS, RESULT_TIMEOUT or SmsRetrieverStatusCodes.

SMS_CODE_RETRIEVED_ACTION

public static final String SMS_CODE_RETRIEVED_ACTION = "com.google.android.gms.auth.api.phone.SMS_CODE_RETRIEVED"

Intent action when an SMS verification code is retrieved.

Public methods

getAutofillClient

public static SmsCodeAutofillClient getAutofillClient(Activity activity)

Creates a new instance of SmsCodeAutofillClient for use in an Activity. This SmsCodeAutofillClient is intended to be used by the current user-designated autofill service only.

getAutofillClient

public static SmsCodeAutofillClient getAutofillClient(Context context)

Creates a new instance of SmsCodeAutofillClient for use in a Context. This SmsCodeAutofillClient is intended to be used by the current user-designated autofill service only.

getBrowserClient

public static SmsCodeBrowserClient getBrowserClient(Activity activity)

Creates a new instance of SmsCodeBrowserClient for use in an Activity. This SmsCodeBrowserClient is intended to be used by the default browser app only.

getBrowserClient

public static SmsCodeBrowserClient getBrowserClient(Context context)

Creates a new instance of SmsCodeBrowserClient for use in a Context. This SmsCodeBrowserClient is intended to be used by the default browser app only.