GetSignInWithGoogleOption

Kotlin |Java

public final class GetSignInWithGoogleOption extends GetCustomCredentialOption

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

---

A request to retrieve user's Google ID Token from an explicit 'Sign in with Google' button.

Credential Provider that wishes to serve this credential type must check if the incoming GetCustomCredentialOption has type GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_CREDENTIAL and the corresponding requestData and candidateQueryData must have the key GoogleIdTokenCredential.BUNDLE_KEY_GOOGLE_ID_TOKEN_SUBTYPE with the value set as GoogleIdTokenCredential.TYPE_GOOGLE_ID_TOKEN_SIWG_CREDENTIAL

Throws
java.lang.IllegalArgumentException java.lang.IllegalArgumentException	If serverClientId is empty
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	If any error encountered in creating GetSignInWithGoogleOption from bundle.

Summary

Nested types
public final class GetSignInWithGoogleOption.Builder Builder class for GetSignInWithGoogleOption
public static class GetSignInWithGoogleOption.Companion

Public constructors
GetSignInWithGoogleOption(     @NonNull String serverClientId,     String hostedDomainFilter,     String nonce )

Public methods
static final @NonNull GetSignInWithGoogleOption	createFrom(@NonNull Bundle data) Helper function to create GetSignInWithGoogleOption out of given Bundle.
final String	getHostedDomainFilter() hosted domain filter (e.g. myuniveristy.edu)
final String	getNonce() the nonce to use during ID token generation
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 boolean isAutoSelectAllowed() final boolean isSystemProviderRequired()

Public constructors

GetSignInWithGoogleOption

public GetSignInWithGoogleOption(
    @NonNull String serverClientId,
    String hostedDomainFilter,
    String nonce
)

Public methods

createFrom

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

Helper function to create GetSignInWithGoogleOption out of given Bundle.

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

getHostedDomainFilter

public final String getHostedDomainFilter()

hosted domain filter (e.g. myuniveristy.edu)

getNonce

public final String getNonce()

the nonce to use during ID token generation

getServerClientId

public final @NonNull String getServerClientId()

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