Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.credentials.CreateCredentialRequest.Builder

A builder for CreateCredentialRequest.

Summary

Public constructors
`Builder(type: String, credentialData: Bundle, candidateQueryData: Bundle)`

Public methods
CreateCredentialRequest	`build()` Builds a `GetCredentialRequest`.
CreateCredentialRequest.Builder	`setAlwaysSendAppInfoToProvider(value: Boolean)` Sets a true/false value to determine if the calling app info should be removed from the request that is sent to the providers.
CreateCredentialRequest.Builder	`setIsSystemProviderRequired(value: Boolean)` Sets whether the request must only be fulfilled by a system provider.
CreateCredentialRequest.Builder	`setOrigin(origin: String)` Sets the origin of the calling app.

Public constructors

Builder

Added in API level 34

Builder(
    type: String, 
    credentialData: Bundle, 
    candidateQueryData: Bundle)

Parameters
`type`	String: the type of the credential to be stored This value cannot be `null`.
`credentialData`	Bundle: the full credential creation request data, which must at minimum contain the required fields observed at the androidx.credentials.CreateCredentialRequest Bundle conversion static methods, because they are required for properly displaying the system credential selector UI This value cannot be `null`.
`candidateQueryData`	Bundle: the partial request data that will be sent to the provider during the initial creation candidate query stage This value cannot be `null`.

Public methods

build

Added in API level 34

fun build(): CreateCredentialRequest

Builds a GetCredentialRequest.

Return
`CreateCredentialRequest`	This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	If credentialOptions is empty.

setAlwaysSendAppInfoToProvider

Added in API level 34

fun setAlwaysSendAppInfoToProvider(value: Boolean): CreateCredentialRequest.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
`CreateCredentialRequest.Builder`	This value cannot be `null`.

setIsSystemProviderRequired

Added in API level 34

fun setIsSystemProviderRequired(value: Boolean): CreateCredentialRequest.Builder

Sets whether the request must only be fulfilled by a system provider. This defaults to false

Return
`CreateCredentialRequest.Builder`	This value cannot be `null`.

setOrigin

Added in API level 34

fun setOrigin(origin: String): CreateCredentialRequest.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
`CreateCredentialRequest.Builder`	This value cannot be `null`.