GetGoogleIdOption

Kotlin |Java

public final class GetGoogleIdOption extends GetCustomCredentialOption

java.lang.Object
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

A request to retrieve user's Google ID Token.

Throws
java.lang.IllegalArgumentException	If serverClientId is empty
java.lang.IllegalArgumentException	If both filterByAuthorizedAccounts and requestVerifiedPhoneNumber are true.
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	If any error encountered in creating GetGoogleIdOption from bundle.

Summary

Nested types
public final class GetGoogleIdOption.Builder A Builder for GetGoogleIdOption.

Public constructors
GetGoogleIdOption(     @NonNull String serverClientId,     String nonce,     boolean filterByAuthorizedAccounts,     String linkedServiceId,     List<@NonNull String> idTokenDepositionScopes,     boolean requestVerifiedPhoneNumber,     boolean autoSelectEnabled,     List<@NonNull Claim> claims,     String hostedDomainFilter )

Public methods
static final @NonNull GetGoogleIdOption	createFrom(@NonNull Bundle data) Helper function to create GetGoogleIdOption out of given Bundle.
final boolean	getAutoSelectEnabled() sets the auto-select behavior in the request. sign-ups.
final List<@NonNull Claim>	getClaims()
final boolean	getFilterByAuthorizedAccounts() whether to only allow the user to select from Google accounts that are already authorized to sign in to your application, default value is true
final String	getHostedDomainFilter() the domain to filter by (e.g., "example.com")
final List<@NonNull String>	getIdTokenDepositionScopes() Oauth scopes that Google will need to deposit a Google ID token to your application's backend server.
final String	getLinkedServiceId() service ID used when linking accounts to a Google account
final String	getNonce() the nonce to use during ID token generation
final boolean	getRequestVerifiedPhoneNumber() whether to request for a verified phone number during sign-ups.
final @NonNull String	getServerClientId() the client ID of the server to which the ID token will be issued

Inherited methods
From androidx.credentials.CredentialOption final @NonNull Set<@NonNull ComponentName> getAllowedProviders() final @NonNull Bundle getCandidateQueryData() final @NonNull Bundle getRequestData() final @NonNull String getType() final int getTypePriorityHint() final boolean isAutoSelectAllowed() final boolean isSystemProviderRequired()

Public constructors

GetGoogleIdOption

public GetGoogleIdOption(
    @NonNull String serverClientId,
    String nonce,
    boolean filterByAuthorizedAccounts,
    String linkedServiceId,
    List<@NonNull String> idTokenDepositionScopes,
    boolean requestVerifiedPhoneNumber,
    boolean autoSelectEnabled,
    List<@NonNull Claim> claims,
    String hostedDomainFilter
)

Public methods

createFrom

public static final @NonNull GetGoogleIdOption createFrom(@NonNull Bundle data)

Helper function to create GetGoogleIdOption out of given Bundle.

Parameters
@NonNull Bundle data	Bunble that contains all the necessary information about GetGoogleIdOption.

getAutoSelectEnabled

public final boolean getAutoSelectEnabled()

sets the auto-select behavior in the request. sign-ups.

getClaims

public final List<@NonNull Claim> getClaims()

getFilterByAuthorizedAccounts

public final boolean getFilterByAuthorizedAccounts()

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

getHostedDomainFilter

public final String getHostedDomainFilter()

the domain to filter by (e.g., "example.com")

getIdTokenDepositionScopes

public final List<@NonNull String> getIdTokenDepositionScopes()

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.

getLinkedServiceId

public final String getLinkedServiceId()

service ID used when linking accounts to a Google account

getNonce

public final String getNonce()

the nonce to use during ID token generation

getRequestVerifiedPhoneNumber

public final boolean getRequestVerifiedPhoneNumber()

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

getServerClientId

public final @NonNull String getServerClientId()

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