GetCredentialRequest

Kotlin |Java

public final class GetCredentialRequest
extends Object implements Parcelable

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

Request for getting user's credential from a given credential provider.

A credential provider will receive this request once the user selects a given CredentialEntry, or RemoteEntry on the selector, that was sourced from provider's initial response to CredentialProviderService.onBeginGetCredential.

Summary

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 constructors
`GetCredentialRequest(CallingAppInfo callingAppInfo, List<CredentialOption> credentialOptions)`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`CallingAppInfo`	`getCallingAppInfo()` Returns info pertaining to the app requesting credentials.
`List<CredentialOption>`	`getCredentialOptions()` Returns a list of options containing parameters needed to return a given type of credential.
`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<GetCredentialRequest> CREATOR

Public constructors

GetCredentialRequest

Added in API level 34

public GetCredentialRequest (CallingAppInfo callingAppInfo, 
                List<CredentialOption> credentialOptions)

Parameters
`callingAppInfo`	`CallingAppInfo`: This value cannot be `null`.
`credentialOptions`	`List`: This value cannot be `null`.

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`

getCallingAppInfo

Added in API level 34

public CallingAppInfo getCallingAppInfo ()

Returns info pertaining to the app requesting credentials.

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

getCredentialOptions

Added in API level 34

public List<CredentialOption> getCredentialOptions ()

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 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.

Returns
`List<CredentialOption>`	This value cannot 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