BeginGetCredentialRequest


public final class BeginGetCredentialRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.credentials.BeginGetCredentialRequest


Query stage request for getting user's credentials from a given credential provider.

This request contains a list of BeginGetCredentialOption that have parameters to be used to query credentials, and return 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 Credential will be sent as part of the Intent fired through the PendingIntent.

Summary

Nested classes

class BeginGetCredentialRequest.Builder

Builder for BeginGetCredentialRequest

Inherited constants

Fields

public static final Creator<BeginGetCredentialRequest> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

List<BeginGetCredentialOption> getBeginGetCredentialOptions()

Returns the list of type specific credential options to list credentials for in BeginGetCredentialResponse.

CallingAppInfo getCallingAppInfo()

Returns info pertaining to the app requesting credentials.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 34
public static final Creator<BeginGetCredentialRequest> CREATOR

Public methods

describeContents

Added in API level 34
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getBeginGetCredentialOptions

Added in API level 34
public List<BeginGetCredentialOption> getBeginGetCredentialOptions ()

Returns the list of type specific credential options to list credentials for in BeginGetCredentialResponse.

Returns
List<BeginGetCredentialOption> This value cannot be null.

getCallingAppInfo

Added in API level 34
public CallingAppInfo getCallingAppInfo ()

Returns info pertaining to the app requesting credentials.

Returns
CallingAppInfo This value may be null.

writeToParcel

Added in API level 34
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES