GetCredentialRequest.Builder


public static final class GetCredentialRequest.Builder
extends Object

java.lang.Object
   ↳ android.credentials.GetCredentialRequest.Builder


A builder for GetCredentialRequest.

Summary

Public constructors

Builder(Bundle data)

Public methods

GetCredentialRequest.Builder addCredentialOption(CredentialOption credentialOption)

Adds a specific type of CredentialOption.

GetCredentialRequest build()

Builds a GetCredentialRequest.

GetCredentialRequest.Builder setAlwaysSendAppInfoToProvider(boolean value)

Sets a true/false value to determine if the calling app info should be removed from the request that is sent to the providers.

GetCredentialRequest.Builder setCredentialOptions(List<CredentialOption> credentialOptions)

Sets the list of CredentialOption.

GetCredentialRequest.Builder setOrigin(String origin)

Sets the origin of the calling app.

Inherited methods

Public constructors

Builder

Added in API level 34
public Builder (Bundle data)

Parameters
data Bundle: the top request level data This value cannot be null.

Public methods

addCredentialOption

Added in API level 34
public GetCredentialRequest.Builder addCredentialOption (CredentialOption credentialOption)

Adds a specific type of CredentialOption.

Parameters
credentialOption CredentialOption: This value cannot be null.

Returns
GetCredentialRequest.Builder This value cannot be null.

build

Added in API level 34
public GetCredentialRequest build ()

Builds a GetCredentialRequest.

Returns
GetCredentialRequest This value cannot be null.

Throws
IllegalArgumentException If credentialOptions is empty.

setAlwaysSendAppInfoToProvider

Added in API level 34
public GetCredentialRequest.Builder setAlwaysSendAppInfoToProvider (boolean value)

Sets a true/false value to determine if the calling app info should be removed from the request that is sent to the providers. Developers must set this to false if they wish to remove the CallingAppInfo from the query phases requests that providers receive. Note that the calling app info will still be sent in the final phase after the user has made a selection on the UI. If not set, the default value will be true and the calling app info will be propagated to the providers in every phase.

Parameters
value boolean

Returns
GetCredentialRequest.Builder This value cannot be null.

setCredentialOptions

Added in API level 34
public GetCredentialRequest.Builder setCredentialOptions (List<CredentialOption> credentialOptions)

Sets the list of CredentialOption.

Parameters
credentialOptions List: This value cannot be null.

Returns
GetCredentialRequest.Builder This value cannot be null.

setOrigin

Added in API level 34
public GetCredentialRequest.Builder setOrigin (String origin)

Sets the origin of the calling app. Callers of this special setter (e.g. browsers) can set this origin for an app different from their own, to be able to get credentials on behalf of that app. The permission check only happens later when this instance is passed and processed by the Credential Manager.
Requires Manifest.permission.CREDENTIAL_MANAGER_SET_ORIGIN

Parameters
origin String: This value cannot be null.

Returns
GetCredentialRequest.Builder This value cannot be null.