Share via


CredentialProviderService.ExtraBeginGetCredentialRequest Field

Definition

Intent extra: The BeginGetCredentialRequest attached with the pendingIntent that is invoked when the user selects an authentication entry (intending to unlock the provider app) on the UI.

[Android.Runtime.Register("EXTRA_BEGIN_GET_CREDENTIAL_REQUEST", ApiSince=34)]
public const string ExtraBeginGetCredentialRequest;
[<Android.Runtime.Register("EXTRA_BEGIN_GET_CREDENTIAL_REQUEST", ApiSince=34)>]
val mutable ExtraBeginGetCredentialRequest : string

Field Value

Attributes

Remarks

Intent extra: The BeginGetCredentialRequest attached with the pendingIntent that is invoked when the user selects an authentication entry (intending to unlock the provider app) on the UI.

When a provider app receives a BeginGetCredentialRequest through the CredentialProviderService#onBeginGetCredential call, it can construct the BeginGetCredentialResponse with either an authentication Action (if the app is locked), or a BeginGetCredentialResponse (if the app is unlocked). In the former case, i.e. the app is locked, user will be shown the authentication action. When selected, the underlying PendingIntent will be invoked which will lead the user to provider's unlock activity. This pending intent will also contain the original BeginGetCredentialRequest to be retrieved and processed after the unlock flow is complete.

After the app is unlocked, the BeginGetCredentialResponse must be constructed using a BeginGetCredentialResponse, which must be set on an Intent as an intent extra against CredentialProviderService#EXTRA_CREDENTIALS_RESPONSE_CONTENT}. This intent should then be set as a result through android.app.Activity#setResult before finishing the activity.

Type: BeginGetCredentialRequest

Java documentation for android.service.credentials.CredentialProviderService.EXTRA_BEGIN_GET_CREDENTIAL_REQUEST.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to