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 |
---|
Fields | |
---|---|
public
static
final
Creator<CredentialDescription> |
CREATOR
|
Public constructors | |
---|---|
CredentialDescription(String type, Set<String> supportedElementKeys, List<CredentialEntry> credentialEntries)
Constructs a |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object obj)
|
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()
|
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
CredentialDescription
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 CredentialEntry s 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
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
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
public List<CredentialEntry> getCredentialEntries ()
Returns the credential entries to be used in the UI.
Returns | |
---|---|
List<CredentialEntry> |
This value cannot be null . |
getSupportedElementKeys
public Set<String> getSupportedElementKeys ()
Returns the flattened JSON string that will be matched with requests.
Returns | |
---|---|
Set<String> |
This value cannot be null . |
getType
public String getType ()
Returns the type of the Credential described.
Returns | |
---|---|
String |
This value cannot be null . |
hashCode
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
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 |