BeginCreateCustomCredentialRequest

open class BeginCreateCustomCredentialRequest : BeginCreateCredentialRequest

kotlin.Any
   ↳ androidx.credentials.provider.BeginCreateCredentialRequest
     ↳ androidx.credentials.provider.BeginCreateCustomCredentialRequest

Base custom begin create request class for registering a credential.

If you get a BeginCreateCustomCredentialRequest instead of a type-safe request class such as BeginCreatePasswordCredentialRequest, BeginCreatePublicKeyCredentialRequest, etc., then as a credential provider, you should check if you have any other library of interest that supports this custom type of credential request, and if so use its parsing utilities to resolve to a type-safe class within that library.

Note : Credential providers are not expected to utilize the constructor in this class for any production flow. This constructor must only be used for testing purposes.

Throws
kotlin.IllegalArgumentException

If type is empty
kotlin.NullPointerException

If type, or candidateQueryData is null

Summary

Public constructors
BeginCreateCustomCredentialRequest(
    type: String,
    candidateQueryData: Bundle,
    callingAppInfo: CallingAppInfo?
)

constructs an instance of BeginCreateCustomCredentialRequest

Inherited properties
From androidx.credentials.provider.BeginCreateCredentialRequest
CallingAppInfo?
Bundle
String

Public constructors

BeginCreateCustomCredentialRequest

Added in 1.2.0
BeginCreateCustomCredentialRequest(
    type: String,
    candidateQueryData: Bundle,
    callingAppInfo: CallingAppInfo?
)

constructs an instance of BeginCreateCustomCredentialRequest

Parameters
type: String

the credential type determined by the credential-type-specific subclass for custom use cases
candidateQueryData: Bundle

the partial request data in the Bundle format that will be sent to the provider during the initial candidate query stage, which should not contain sensitive user credential information (note: bundle keys in the form of androidx.credentials.* are reserved for internal library use)
callingAppInfo: CallingAppInfo?

info pertaining to the app that is requesting for credentials retrieval or creation