CredentialDescription


public final class CredentialDescription
extends Object implements Parcelable

java.lang.Object
   ↳ android.credentials.CredentialDescription


Represents the type and contained data fields of a Credential.

Summary

Inherited constants

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<CredentialDescription> CREATOR

Public constructors

CredentialDescription(String type, Set<String> supportedElementKeys, List<CredentialEntry> credentialEntries)

Constructs a CredentialDescription.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

getType() and getSupportedElementKeys() are enough for equality check.

List<CredentialEntry> getCredentialEntries()

Returns the credential entries to be used in the UI.

Set<String> getSupportedElementKeys()

Returns the flattened JSON string that will be matched with requests.

String getType()

Returns the type of the Credential described.

int hashCode()

getType() and getSupportedElementKeys() are enough for hashing.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

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.

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 API level 34
public static final Creator<CredentialDescription> CREATOR

Public constructors

CredentialDescription

Added in API level 34
public CredentialDescription (String type, 
                Set<String> supportedElementKeys, 
                List<CredentialEntry> credentialEntries)

Constructs a CredentialDescription.

Parameters
type String: the type of the credential returned. This value cannot be null.

supportedElementKeys Set: Keys of elements to match with Credential requests. This value cannot be null.

credentialEntries List: a list of CredentialEntrys that are to be shown on the account selector if a credential matches with this description. Each entry contains information to be displayed within an entry on the UI, as well as a PendingIntent that will be invoked if the user selects this entry. 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

equals

Added in API level 34
public boolean equals (Object obj)

getType() and getSupportedElementKeys() are enough for equality check.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCredentialEntries

Added in API level 34
public List<CredentialEntry> getCredentialEntries ()

Returns the credential entries to be used in the UI.

Returns
List<CredentialEntry> This value cannot be null.

getSupportedElementKeys

Added in API level 34
public Set<String> getSupportedElementKeys ()

Returns the flattened JSON string that will be matched with requests.

Returns
Set<String> This value cannot be null.

getType

Added in API level 34
public String getType ()

Returns the type of the Credential described.

Returns
String This value cannot be null.

hashCode

Added in API level 34
public int hashCode ()

getType() and getSupportedElementKeys() are enough for hashing. Constructor enforces CredentialEntry to have the same type and Slice contained by the entry can not be hashed.

Returns
int a hash code value for this 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