# BeginGetCustomCredentialOption

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/provider/BeginGetCustomCredentialOption.kt+class:androidx.credentials.provider.BeginGetCustomCredentialOption) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

*** ** * ** ***


```
public class BeginGetCustomCredentialOption extends BeginGetCredentialOption
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.credentials.provider.BeginGetCredentialOption](https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption) ||
|   | ↳ | [androidx.credentials.provider.BeginGetCustomCredentialOption](https://developer.android.com/reference/androidx/credentials/provider/BeginGetCustomCredentialOption) |

*** ** * ** ***

Allows extending custom versions of BeginGetCredentialOptions for unique use cases.

If you get a `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCustomCredentialOption` instead of a type-safe option class such as `https://developer.android.com/reference/androidx/credentials/provider/BeginGetPasswordOption`, `https://developer.android.com/reference/androidx/credentials/provider/BeginGetPublicKeyCredentialOption`, etc., then you should check if you have any other library at interest that supports this custom `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCustomCredentialOption#(kotlin.String,kotlin.String,android.os.Bundle)` of credential option, and if so use its parsing utilities to resolve to a type-safe class within that library.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | If `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCustomCredentialOption#(kotlin.String,kotlin.String,android.os.Bundle)` is null or, empty |

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCustomCredentialOption#BeginGetCustomCredentialOption(kotlin.String,kotlin.String,android.os.Bundle)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html id, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html type, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html candidateQueryData )` |

| ### Inherited methods |
|---|
| From [androidx.credentials.provider.BeginGetCredentialOption](https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption) |---|---| | `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption#getCandidateQueryData()()` the parameters needed to retrieve the credentials, in the form of the raw `https://developer.android.com/reference/android/os/Bundle.html` - can typically be ignored by the credential provider as the required properties are already parse into the structured subclasses | | `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption#getId()()` unique id representing this particular option, to be used while constructing the `https://developer.android.com/reference/androidx/credentials/provider/CredentialEntry` to be set on `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialResponse` | | `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/provider/BeginGetCredentialOption#getType()()` the type of the credential to be retrieved against this option, e.g. a `https://developer.android.com/reference/androidx/credentials/provider/BeginGetPasswordOption` will have type `https://developer.android.com/reference/androidx/credentials/PasswordCredential#TYPE_PASSWORD_CREDENTIAL()` | |

## Public constructors

### BeginGetCustomCredentialOption

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public BeginGetCustomCredentialOption(
    @NonNull String id,
    @NonNull String type,
    @NonNull Bundle candidateQueryData
)
```