GetCredentialRequest.CredentialOptions Property

Definition

Returns a list of options containing parameters needed to return a given type of credential.

public System.Collections.Generic.IList<Android.Credentials.CredentialOption> CredentialOptions { [Android.Runtime.Register("getCredentialOptions", "()Ljava/util/List;", "", ApiSince=34)] get; }
[<get: Android.Runtime.Register("getCredentialOptions", "()Ljava/util/List;", "", ApiSince=34)>]
member this.CredentialOptions : System.Collections.Generic.IList<Android.Credentials.CredentialOption>

Property Value

Attributes

Remarks

Returns a list of options containing parameters needed to return a given type of credential. This is part of the request that the credential provider receives after the user has selected an entry on a selector UI.

When the user selects a CredentialEntry and the credential provider receives a GetCredentialRequest, this list is expected to contain a single CredentialOption only. A CredentialEntry is always created for a given BeginGetCredentialOption, and hence when the user selects it, the provider receives a corresponding CredentialOption that contains all the required parameters to actually retrieve the credential.

When the user selects a RemoteEntry and the credential provider receives a GetCredentialRequest, this list may contain greater than a single CredentialOption, representing the number of options specified by the developer in the original android.credentials.GetCredentialRequest. This is because a RemoteEntry indicates that the entire request will be processed on a different device and is not tied to a particular option.

Java documentation for android.service.credentials.GetCredentialRequest.getCredentialOptions().

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