Credential

Kotlin |Java

class Credential : Parcelable

kotlin.Any
↳	android.credentials.Credential

Represents a user credential that can be used to authenticate to your app.

Summary

Constants
static String	`TYPE_PASSWORD_CREDENTIAL` The type value for password credential related operations.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public constructors
`Credential(type: String, data: Bundle)` Constructs a `Credential`.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Bundle	`getData()` Returns the credential data.
String	`getType()` Returns the credential type.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Credential!>	`CREATOR`

Constants

TYPE_PASSWORD_CREDENTIAL

Added in API level 34

static val TYPE_PASSWORD_CREDENTIAL: String

The type value for password credential related operations.

Value: "android.credentials.TYPE_PASSWORD_CREDENTIAL"

Public constructors

Credential

Added in API level 34

Credential(
    type: String, 
    data: Bundle)

Constructs a Credential.

Parameters
`type`	String: the type of the credential returned. This value cannot be `null`.
`data`	Bundle: the data associated with the credential returned. This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	If type is empty.

Public methods

describeContents

Added in API level 34

fun describeContents(): Int

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.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getData

Added in API level 34

fun getData(): Bundle

Returns the credential data.

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

getType

Added in API level 34

fun getType(): String

Returns the credential type.

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

toString

Added in API level 34

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 34

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<Credential!>