Added in API level 34

Builder

class Builder
kotlin.Any
   ↳ android.credentials.GetCredentialRequest.Builder

A builder for GetCredentialRequest.

Summary

Public constructors
Builder(data: Bundle)
Public methods
GetCredentialRequest.Builder

Adds a specific type of CredentialOption.
GetCredentialRequest

Builds a GetCredentialRequest.
GetCredentialRequest.Builder

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

Sets the list of CredentialOption.
GetCredentialRequest.Builder
setOrigin(origin: String)

Sets the origin of the calling app.

Public constructors

Builder

Added in API level 34
Builder(data: Bundle)
Parameters
data Bundle: the top request level data This value cannot be null.

Public methods

addCredentialOption

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

Adds a specific type of CredentialOption.

Parameters
credentialOption CredentialOption: This value cannot be null.
Return
GetCredentialRequest.Builder This value cannot be null.

build

Added in API level 34
fun build(): GetCredentialRequest

Builds a GetCredentialRequest.

Return
GetCredentialRequest This value cannot be null.
Exceptions
java.lang.IllegalArgumentException If credentialOptions is empty.

setAlwaysSendAppInfoToProvider

Added in API level 34
fun setAlwaysSendAppInfoToProvider(value: Boolean): GetCredentialRequest.Builder

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 android.service.credentials.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.

Return
GetCredentialRequest.Builder This value cannot be null.

setCredentialOptions

Added in API level 34
fun setCredentialOptions(credentialOptions: MutableList<CredentialOption!>): GetCredentialRequest.Builder

Sets the list of CredentialOption.

Parameters
credentialOptions MutableList<CredentialOption!>: This value cannot be null.
Return
GetCredentialRequest.Builder This value cannot be null.

setOrigin

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

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 android.Manifest.permission#CREDENTIAL_MANAGER_SET_ORIGIN

Parameters
origin String: This value cannot be null.
Return
GetCredentialRequest.Builder This value cannot be null.