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/BeginGetCredentialOption#inhconstants) \| [Fields](https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#lfields) \| [Ctors](https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#pubctors) \| [Methods](https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#inhmethods)

# BeginGetCredentialOption

*** ** * ** ***


`
public

final

class
BeginGetCredentialOption
`


`

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

<br />

*** ** * ** ***

A specific type of credential request to be sent to the provider during the query phase of
a get flow. This request contains limited parameters needed to populate a list of
`https://developer.android.com/reference/android/service/credentials/CredentialEntry` on the `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialResponse`.

## 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/BeginGetCredentialOption>` | `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#CREATOR` |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#BeginGetCredentialOption(java.lang.String,%20java.lang.String,%20android.os.Bundle)(https://developer.android.com/reference/java/lang/String id, https://developer.android.com/reference/java/lang/String type, https://developer.android.com/reference/android/os/Bundle candidateQueryData) ` Constructs a `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption`. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#getCandidateQueryData()() ` Returns the request candidate query data, denoting a set of parameters that can be used to populate a candidate list of credentials, as `https://developer.android.com/reference/android/service/credentials/CredentialEntry` on `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialResponse`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#getId()() ` Returns the unique id associated with this request. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#getType()() ` Returns the requested credential type. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption#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<BeginGetCredentialOption> CREATOR
```

<br />

<br />

## Public constructors

### BeginGetCredentialOption

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

```
public BeginGetCredentialOption (String id, 
                String type, 
                Bundle candidateQueryData)
```

Constructs a `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialOption`.

<br />

| Parameters ||
|---|---|
| `id` | `String`: the unique id associated with this option. This value cannot be `null`. <br /> |
| `type` | `String`: the requested credential type. This value cannot be `null`. <br /> |
| `candidateQueryData` | `Bundle`: the request candidateQueryData. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | If id or type is empty. |

## 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` |

### getCandidateQueryData

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

```
public Bundle getCandidateQueryData ()
```

Returns the request candidate query data, denoting a set of parameters
that can be used to populate a candidate list of credentials, as
`https://developer.android.com/reference/android/service/credentials/CredentialEntry` on `https://developer.android.com/reference/android/service/credentials/BeginGetCredentialResponse`. This list
of entries is then presented to the user on a selector.

This data does not contain any sensitive parameters, and will be sent
to all eligible providers.
The complete set of parameters will only be set on the `https://developer.android.com/reference/android/app/PendingIntent`
set on the `https://developer.android.com/reference/android/service/credentials/CredentialEntry` that is selected by the user.

<br />

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

### getId

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

```
public String getId ()
```

Returns the unique id associated with this request. This is for internal use only.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### getType

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

```
public String getType ()
```

Returns the requested credential type.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### toString

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

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <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` |