Added in API level 34

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

BeginGetCredentialRequest

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

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
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

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