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

GetCredentialRequest

Kotlin |Java

public final class GetCredentialRequest
extends Object implements Parcelable

java.lang.Object
↳	android.credentials.GetCredentialRequest

A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources.

Summary

Nested classes
`class`	`GetCredentialRequest.Builder` A builder for `GetCredentialRequest`.

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<GetCredentialRequest>`	`CREATOR`

Public methods
`boolean`	`alwaysSendAppInfoToProvider()` Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false).
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`List<CredentialOption>`	`getCredentialOptions()` Returns the list of credential options to be requested.
`Bundle`	`getData()` Returns the top request level data.
`String`	`getOrigin()` Returns the origin of the calling app if set otherwise returns null.
`String`	`toString()` Returns a string representation of the object.
`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 Android UpsideDownCake

public static final Creator<GetCredentialRequest> CREATOR

Public methods

alwaysSendAppInfoToProvider

Added in Android UpsideDownCake

public boolean alwaysSendAppInfoToProvider ()

Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false).

Returns
`boolean`

describeContents

Added in Android UpsideDownCake

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`

getCredentialOptions

Added in Android UpsideDownCake

public List<CredentialOption> getCredentialOptions ()

Returns the list of credential options to be requested.

Returns
`List<CredentialOption>`	This value cannot be `null`.

getData

Added in Android UpsideDownCake

public Bundle getData ()

Returns the top request level data.

Returns
`Bundle`	This value cannot be `null`.

getOrigin

Added in Android UpsideDownCake

public String getOrigin ()

Returns the origin of the calling app if set otherwise returns null.

Returns
`String`

toString

Added in Android UpsideDownCake

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

Added in Android UpsideDownCake

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

GetCredentialRequest

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

alwaysSendAppInfoToProvider

describeContents

getCredentialOptions

getData

getOrigin

toString

writeToParcel