Share via

CredentialProviderService.OnBeginGetCredential Method

  • Reference

Definition

Namespace:
Android.Service.Credentials
Assembly:
Mono.Android.dll

Called by the android system to retrieve user credentials from the connected provider service.

[Android.Runtime.Register("onBeginGetCredential", "(Landroid/service/credentials/BeginGetCredentialRequest;Landroid/os/CancellationSignal;Landroid/os/OutcomeReceiver;)V", "GetOnBeginGetCredential_Landroid_service_credentials_BeginGetCredentialRequest_Landroid_os_CancellationSignal_Landroid_os_OutcomeReceiver_Handler", ApiSince=34)]
public abstract void OnBeginGetCredential (Android.Service.Credentials.BeginGetCredentialRequest request, Android.OS.CancellationSignal cancellationSignal, Android.OS.IOutcomeReceiver callback);
[<Android.Runtime.Register("onBeginGetCredential", "(Landroid/service/credentials/BeginGetCredentialRequest;Landroid/os/CancellationSignal;Landroid/os/OutcomeReceiver;)V", "GetOnBeginGetCredential_Landroid_service_credentials_BeginGetCredentialRequest_Landroid_os_CancellationSignal_Landroid_os_OutcomeReceiver_Handler", ApiSince=34)>]
abstract member OnBeginGetCredential : Android.Service.Credentials.BeginGetCredentialRequest * Android.OS.CancellationSignal * Android.OS.IOutcomeReceiver -> unit

Parameters

request
BeginGetCredentialRequest

the request for the provider to handle

cancellationSignal
CancellationSignal

signal for providers to listen to any cancellation requests from the android system

callback
IOutcomeReceiver

object used to relay the response of the credentials request

Attributes
RegisterAttribute

Remarks

Called by the android system to retrieve user credentials from the connected provider service.

This API denotes a query stage request for getting user's credentials from a given credential provider. The request contains a list of BeginGetCredentialOption that have parameters to be used for populating candidate credentials, as a list of CredentialEntry to be set on the BeginGetCredentialResponse. This list is then shown to the user on a selector.

If a PendingIntent is set on a CredentialEntry, and the user selects that entry, a GetCredentialRequest with all parameters needed to get the actual android.credentials.Credential will be sent as part of the Intent fired through the PendingIntent.

Java documentation for android.service.credentials.CredentialProviderService.onBeginGetCredential(android.service.credentials.BeginGetCredentialRequest, android.os.CancellationSignal, android.os.OutcomeReceiver<android.service.credentials.BeginGetCredentialResponse, android.credentials.GetCredentialException>).

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