CredentialsClient | Doclava
public class

CredentialsClient

extends GoogleApi<Auth.AuthCredentialsOptions>
java.lang.Object
   ↳ com.google.android.gms.common.api.GoogleApi<com.google.android.gms.auth.api.Auth.AuthCredentialsOptions>
     ↳ com.google.android.gms.auth.api.credentials.CredentialsClient

Class Overview

Entry point for requesting a credential and indicating whether sign-in was successful using the credential.

Summary

Public Methods
Task<Void> delete(Credential credential)
Deletes a credential that is no longer valid for signing into the app.
Task<Void> disableAutoSignIn()
Disables auto sign-in for the calling app on the current device only, until a successful call to save(Credential) is subsequently made.
PendingIntent getHintPickerIntent(HintRequest request)
Provides an intent to directly display the hint picker to the user, to aid in new account creation.
Task<CredentialRequestResponse> request(CredentialRequest request)
Tries to suggest a zero-click sign-in account.
Task<Void> save(Credential credential)
Saves a credential that was used to sign in to the app.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public Task<Void> delete (Credential credential)

Deletes a credential that is no longer valid for signing into the app.

Parameters
credential Credential
Returns
Task<Void>

public Task<Void> disableAutoSignIn ()

Disables auto sign-in for the calling app on the current device only, until a successful call to save(Credential) is subsequently made. This is intended to be called when a user logs out of the app, to prevent a possible auto sign-in loop if the app's activity immediately calls the request(CredentialRequest) method in its login activity.

Returns
Task<Void>

public PendingIntent getHintPickerIntent (HintRequest request)

Provides an intent to directly display the hint picker to the user, to aid in new account creation.

WARNING: The identifier string of the credential returned by the hint picker should be treated as unverified. Do not accept plain user IDs for authentication -- they have not been verified and could be spoofed. If a Json Web Token is available (getIdTokens()) on the object returned from this request, it may contain a claim that the identifier has been verified by Google and this token can be passed to your backend server for validation and used for verification purposes.

Parameters
request HintRequest
Returns
PendingIntent

public Task<CredentialRequestResponse> request (CredentialRequest request)

Tries to suggest a zero-click sign-in account. Only call this if your app does not currently know who is signed in.

Parameters
request CredentialRequest
Returns
Task<CredentialRequestResponse>

public Task<Void> save (Credential credential)

Saves a credential that was used to sign in to the app. If disableAutoSignIn() was previously called and the save operation succeeds, auto sign-in will be re-enabled if the user's settings permit this.

Note: On Android O and above devices save requests that require showing a save confirmation may be cancelled in favor of the active Autofill service's save dialog. This behavior may be overridden by using forceEnableSaveDialog(). Please see the overview documentation for more details on providing the best user experience when targeting Android O and above.

Parameters
credential Credential
Returns
Task<Void>