SmsRetrieverClient

public abstract class SmsRetrieverClient extends GoogleApi<Api.ApiOptions.NoOptions>
implements SmsRetrieverApi

The main entry point for interacting with SmsRetriever.

This does not require a GoogleApiClient. See GoogleApi for more information.

Inherited Field Summary

From class com.google.android.gms.common.api.GoogleApi

protected final GoogleApiManager

zabo

Public Method Summary

abstract Task<Void>	startSmsRetriever() Starts SmsRetriever, which waits for a matching SMS message until timeout (5 minutes).
abstract Task<Void>	startSmsUserConsent(String senderAddress) Starts SmsUserConsent, which waits for an OTP-containing SMS message until timeout (5 minutes).

Inherited Method Summary

From class com.google.android.gms.common.api.GoogleApi

GoogleApiClient	asGoogleApiClient()
ClientSettings.Builder	createClientSettingsBuilder()
Task<Boolean>	disconnectService()
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doBestEffortWrite(T arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doBestEffortWrite(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doRead(T arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doRead(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient> Task<Void>	doRegisterEventListener(RegistrationMethods<A, ?> arg0)
<A extends Api.AnyClient, T extends RegisterListenerMethod<A, ?>, U extends UnregisterListenerMethod<A, ?>> Task<Void>	doRegisterEventListener(T arg0, U arg1)
Task<Boolean>	doUnregisterEventListener(ListenerKey<?> arg0)
<TResult, A extends Api.AnyClient> Task<TResult>	doWrite(TaskApiCall<A, TResult> arg0)
<A extends Api.AnyClient, T extends ApiMethodImpl<? extends Result, A>> T	doWrite(T arg0)
final Api<Api.ApiOptions.NoOptions>	getApi()
ApiKey<Api.ApiOptions.NoOptions>	getApiKey()
Api.ApiOptions.NoOptions	getApiOptions()
Context	getApplicationContext()
final int	getInstanceId()
Looper	getLooper()
<L> ListenerHolder<L>	registerListener(L arg0, String arg1)
zace	zaa(Context arg0, Handler arg1)
Api.Client	zaa(Looper arg0, zaa<Api.ApiOptions.NoOptions> arg1)

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface com.google.android.gms.common.api.HasApiKey

abstract ApiKey<Api.ApiOptions.NoOptions>

getApiKey()

From interface com.google.android.gms.auth.api.phone.SmsRetrieverApi

abstract Task<Void>	startSmsRetriever() Starts SmsRetriever, which waits for a matching SMS message until timeout (5 minutes).
abstract Task<Void>	startSmsUserConsent(String senderAddress) Starts SmsUserConsent, which waits for an OTP-containing SMS message until timeout (5 minutes).

Public Methods

public abstract Task<Void> startSmsRetriever ()

Starts SmsRetriever, which waits for a matching SMS message until timeout (5 minutes). The matching SMS message will be sent via a Broadcast Intent with action SmsRetriever.SMS_RETRIEVED_ACTION. The Intent contains Extras with keys SmsRetriever.EXTRA_SMS_MESSAGE for the retrieved SMS message as a String, and SmsRetriever.EXTRA_STATUS for Status to indicate SUCCESS, DEVELOPER_ERROR, ERROR, or TIMEOUT.

The possible causes for errors are:

• DEVELOPER_ERROR: the caller app has incorrect number of certificates. Only one certificate is allowed.
• ERROR: the AppCode collides with other installed apps.

Returns

• a Task for the call. Attach an OnCompleteListener and then check isSuccessful() to determine if it was successful.

public abstract Task<Void> startSmsUserConsent (String senderAddress)

Starts SmsUserConsent, which waits for an OTP-containing SMS message until timeout (5 minutes). OTP-containing SMS message can be retrieved with two steps.

1. [Get consent Intent] While OTP-containing SMS message comes, a consent Intent will be sent via a Broadcast Intent with action SmsRetriever.SMS_RETRIEVED_ACTION. The Intent contains Extras with keys SmsRetriever.EXTRA_CONSENT_INTENT for the consent Intent and SmsRetriever.EXTRA_STATUS for Status to indicate SUCCESS or TIMEOUT.
2. [Get OTP-containing SMS message] Calls startActivityForResult with consent Intent to launch a consent dialog to get user's approval, then the OTP-containing SMS message can be retrieved from the activity result.

Parameters

senderAddress	address of desired SMS sender, or null to retrieve any sender

Returns

• a Task for the call. Attach an OnCompleteListener and then check isSuccessful() to determine if it was successful.