Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

BeginGetCredentialOption

Kotlin |Java

public final class BeginGetCredentialOption
extends Object implements Parcelable

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

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 CredentialEntry on the BeginGetCredentialResponse.

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<BeginGetCredentialOption>`	`CREATOR`

Public constructors
`BeginGetCredentialOption(String id, String type, Bundle candidateQueryData)` Constructs a `BeginGetCredentialOption`.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`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 `CredentialEntry` on `BeginGetCredentialResponse`.
`String`	`getId()` Returns the unique id associated with this request.
`String`	`getType()` Returns the requested credential type.
`String`	`toString()` Returns a string representation of the object.
`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 Android UpsideDownCake

public static final Creator<BeginGetCredentialOption> CREATOR

Public constructors

BeginGetCredentialOption

Added in Android UpsideDownCake

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

Constructs a BeginGetCredentialOption.

Parameters
`id`	`String`: the unique id associated with this option This value cannot be `null`.
`type`	`String`: the requested credential type This value cannot be `null`.
`candidateQueryData`	`Bundle`: the request candidateQueryData This value cannot be `null`.

Throws
`IllegalArgumentException`	If id or type is empty.

Public methods

describeContents

Added in Android UpsideDownCake

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`

getCandidateQueryData

Added in Android UpsideDownCake

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 CredentialEntry on 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 PendingIntent set on the CredentialEntry that is selected by the user.

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

getId

Added in Android UpsideDownCake

public String getId ()

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

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

getType

Added in Android UpsideDownCake

public String getType ()

Returns the requested credential type.

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

toString

Added in Android UpsideDownCake

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

Added in Android UpsideDownCake

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