BeginSignInRequest.GoogleIdTokenRequestOptions.Builder

public static final class BeginSignInRequest.GoogleIdTokenRequestOptions.Builder extends Object

Builder for BeginSignInRequest.GoogleIdTokenRequestOptions.

Public Constructor Summary

Public Method Summary

BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	associateLinkedAccounts(String linkedServiceId, List<String> idTokenDepositionScopes) Sets whether to support sign-in using Google accounts that are linked to your users' accounts.
BeginSignInRequest.GoogleIdTokenRequestOptions	build() Returns the built `BeginSignInRequest.GoogleIdTokenRequestOptions`.
BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	setFilterByAuthorizedAccounts(boolean filterByAuthorizedAccounts) Sets whether to only allow the user to select from Google accounts that are already authorized to sign in to your application.
BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	setNonce(String nonce) Sets the nonce to use when generating a Google ID token.
BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	setRequestVerifiedPhoneNumber(boolean requestVerifiedPhoneNumber) This method is deprecated. No replacement.
BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	setServerClientId(String serverClientId) Sets the server's client ID to use as the audience for Google ID tokens generated during the sign-in.
BeginSignInRequest.GoogleIdTokenRequestOptions.Builder	setSupported(boolean supported) Sets whether Google ID token-backed credentials should be returned by the API.

Inherited Method Summary

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()

Public Constructors

public Builder ()

Public Methods

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder associateLinkedAccounts (String linkedServiceId, List<String> idTokenDepositionScopes)

Sets whether to support sign-in using Google accounts that are linked to your users' accounts.

When such a credential is selected, a Google ID token for the Google account that the selected account is linked to, will first be deposited to your server and then returned to you. Similar to the regular sign-in, your backend could use the ID token to sign the user in. Note that, the ID token deposition will only happen the first time signing in, using this credential. Subsequent sign-ins will not require a deposition, since the ID token will already have been associated with your user's account.

Parameters

linkedServiceId	service ID used when linking accounts to a Google account.
idTokenDepositionScopes	Oauth scopes that Google will need to deposit a Google ID token to your application's backend server. This is optional and can be set to null. Only required if Google requires particular scopes to be able to deposit the ID token.

public BeginSignInRequest.GoogleIdTokenRequestOptions build ()

Returns the built BeginSignInRequest.GoogleIdTokenRequestOptions.

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder setFilterByAuthorizedAccounts (boolean filterByAuthorizedAccounts)

Sets whether to only allow the user to select from Google accounts that are already authorized to sign in to your application. The default value is true.

If true, the user will not be able to select any Google account that would otherwise require explicit authorization to share basic profile/email data with your application. This may reduce some friction in the sign-in user journey, and guarantees that the returned credential is for a "returning user", but limits the user's freedom to choose among all the Google accounts on the device.

Parameters

filterByAuthorizedAccounts	whether to only allow the user to select from Google accounts that are already authorized to sign in to your application

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder setNonce (String nonce)

Sets the nonce to use when generating a Google ID token.

Parameters

nonce	the nonce to use during ID token generation

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder setRequestVerifiedPhoneNumber (boolean requestVerifiedPhoneNumber)

This method is deprecated.
No replacement.

Sets whether to request for a verified phone number during sign-ups.

In order to use this feature, the BeginSignInRequest.GoogleIdTokenRequestOptions.filterByAuthorizedAccounts() field must be explicitly set to false, because this feature is only available during sign-ups.

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder setServerClientId (String serverClientId)

Sets the server's client ID to use as the audience for Google ID tokens generated during the sign-in.

Parameters

serverClientId	the client ID of the server to which the ID token will be issued

public BeginSignInRequest.GoogleIdTokenRequestOptions.Builder setSupported (boolean supported)

Sets whether Google ID token-backed credentials should be returned by the API.

Parameters

supported	whether Google ID token-backed credentials should be returned