Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#inhconstants) \| [Fields](https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#lfields) \| [Ctors](https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#pubctors) \| [Methods](https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#inhmethods)

# GetCredentialRequest

*** ** * ** ***

` public final class GetCredentialRequest `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.service.credentials.GetCredentialRequest |

<br />

*** ** * ** ***

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

A credential provider will receive this request once the user selects a given `https://developer.android.com/reference/android/service/credentials/CredentialEntry`, or `https://developer.android.com/reference/android/service/credentials/RemoteEntry` on the selector, that was sourced from provider's initial response to `https://developer.android.com/reference/android/service/credentials/CredentialProviderService#onBeginGetCredential(android.service.credentials.BeginGetCredentialRequest,%20android.os.CancellationSignal,%20android.os.OutcomeReceiver<android.service.credentials.BeginGetCredentialResponse,android.credentials.GetCredentialException>)`.

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/service/credentials/GetCredentialRequest>` | `https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#GetCredentialRequest(android.service.credentials.CallingAppInfo,%20java.util.List<android.credentials.CredentialOption>)(https://developer.android.com/reference/android/service/credentials/CallingAppInfo callingAppInfo, https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/credentials/CredentialOption> credentialOptions) ` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/service/credentials/CallingAppInfo` | ` https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#getCallingAppInfo()() ` Returns info pertaining to the app requesting credentials. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/credentials/CredentialOption>` | ` https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#getCredentialOptions()() ` Returns a list of options containing parameters needed to return a given type of credential. |
| ` void` | ` https://developer.android.com/reference/android/service/credentials/GetCredentialRequest#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<GetCredentialRequest> CREATOR
```

<br />

<br />

## Public constructors

### GetCredentialRequest

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

<br />

| Parameters ||
|---|---|
| `callingAppInfo` | `CallingAppInfo`: This value cannot be `null`. <br /> |
| `credentialOptions` | `List`: This value cannot be `null`. <br /> |

## Public methods

### describeContents

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getCallingAppInfo

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CallingAppInfo getCallingAppInfo ()
```

Returns info pertaining to the app requesting credentials.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/service/credentials/CallingAppInfo` | This value cannot be `null`. <br /> |

### getCredentialOptions

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/service/credentials/CredentialEntry` and the credential provider receives a `https://developer.android.com/reference/android/service/credentials/GetCredentialRequest`, this list is expected to contain a single `https://developer.android.com/reference/android/credentials/CredentialOption` only. A `https://developer.android.com/reference/android/service/credentials/CredentialEntry` is always created for a given `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption`, and hence when the user selects it, the provider receives a corresponding `https://developer.android.com/reference/android/credentials/CredentialOption` that contains all the required parameters to actually retrieve the credential. When the user selects a `https://developer.android.com/reference/android/service/credentials/RemoteEntry` and the credential provider receives a `https://developer.android.com/reference/android/service/credentials/GetCredentialRequest`, this list may contain greater than a single `https://developer.android.com/reference/android/credentials/CredentialOption`, representing the number of options specified by the developer in the original `https://developer.android.com/reference/android/credentials/GetCredentialRequest`. This is because a `https://developer.android.com/reference/android/service/credentials/RemoteEntry` indicates that the entire request will be processed on a different device and is not tied to a particular option.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/credentials/CredentialOption>` | This value cannot be `null`. <br /> |

### writeToParcel

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |