Credential

public final class Credential
extends Object implements Parcelable

java.lang.Object
   ↳ android.credentials.Credential


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

Summary

Constants

String TYPE_PASSWORD_CREDENTIAL

The type value for password credential related operations.

Inherited constants

Fields

public static final Creator<Credential> CREATOR

Public constructors

Credential(String type, Bundle data)

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.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

TYPE_PASSWORD_CREDENTIAL

Added in API level 34
public static final String TYPE_PASSWORD_CREDENTIAL

The type value for password credential related operations.

Constant Value: "android.credentials.TYPE_PASSWORD_CREDENTIAL"

Fields

CREATOR

Added in API level 34
public static final Creator<Credential> CREATOR

Public constructors

Credential

Added in API level 34
public Credential (String type, 
                Bundle data)

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.

Throws
IllegalArgumentException If type is empty.

Public methods

describeContents

Added in API level 34
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

getData

Added in API level 34
public Bundle getData ()

Returns the credential data.

Returns
Bundle This value cannot be null.

getType

Added in API level 34
public String getType ()

Returns the credential type.

Returns
String This value cannot be null.

toString

Added in API level 34
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 34
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