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

# CreateCredentialRequest

*** ** * ** ***

` public final class CreateCredentialRequest `   
` 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.credentials.CreateCredentialRequest |

<br />

*** ** * ** ***

A request to register a specific type of user credential, potentially launching UI flows to collect user consent and any other operation needed.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/credentials/CreateCredentialRequest.Builder` A builder for `https://developer.android.com/reference/android/credentials/CreateCredentialRequest`. |

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

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#alwaysSendAppInfoToProvider()() ` Return true/false value to determine if the calling app info should always be sent to providers (if true), or removed from the query phase (if false). |
| ` int` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#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/credentials/CreateCredentialRequest#getCandidateQueryData()() ` Returns the partial request data that will be sent to the provider during the initial creation candidate query stage. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#getCredentialData()() ` Returns the full credential creation request data. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#getOrigin()() ` Returns the origin of the calling app if set otherwise returns null. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#getType()() ` Returns the requested credential type. |
| ` boolean` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#isSystemProviderRequired()() ` Returns true if the request must only be fulfilled by a system provider, and false otherwise. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/credentials/CreateCredentialRequest#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<CreateCredentialRequest> CREATOR
```

<br />

<br />

## Public methods

### alwaysSendAppInfoToProvider

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

```
public boolean alwaysSendAppInfoToProvider ()
```

Return true/false value to determine if the calling app info should always be sent to providers (if true), or removed from the query phase (if false).

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

### 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 partial request data that will be sent to the provider during the initial creation candidate query stage. For security reason, a provider will receive the request data in two stages. First it gets this partial request that do not contain sensitive user information; it uses this information to provide credential creation candidates that the \[@code CredentialManager\] will show to the user. Next, the full request data, `https://developer.android.com/reference/android/credentials/CreateCredentialRequest#getCredentialData()`, will be sent to a provider only if the user further grants the consent by choosing a candidate from the provider.

<br />

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

### getCredentialData

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

```
public Bundle getCredentialData ()
```

Returns the full credential creation request data. For security reason, a provider will receive the request data in two stages. First it gets a partial request, `https://developer.android.com/reference/android/credentials/CreateCredentialRequest#getCandidateQueryData()` that do not contain sensitive user information; it uses this information to provide credential creation candidates that the \[@code CredentialManager\] will show to the user. Next, this full request data will be sent to a provider only if the user further grants the consent by choosing a candidate from the provider.

<br />

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

### getOrigin

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

```
public String getOrigin ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | <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 /> |

### isSystemProviderRequired

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

```
public boolean isSystemProviderRequired ()
```

Returns true if the request must only be fulfilled by a system provider, and false otherwise.

<br />

| Returns ||
|---|---|
| `boolean` | <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` |