GetCredentialRequest
public
final
class
GetCredentialRequest
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.credentials.GetCredentialRequest |
A request to retrieve the user credential, potentially launching UI flows to let the user pick from different credential sources.
Summary
Nested classes | |
---|---|
class |
GetCredentialRequest.Builder
A builder for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<GetCredentialRequest> |
CREATOR
|
Public methods | |
---|---|
boolean
|
alwaysSendAppInfoToProvider()
Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false). |
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
List<CredentialOption>
|
getCredentialOptions()
Returns the list of credential options to be requested. |
Bundle
|
getData()
Returns the top request level data. |
String
|
getOrigin()
Returns the origin of the calling app if set otherwise returns null. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public methods
alwaysSendAppInfoToProvider
public boolean alwaysSendAppInfoToProvider ()
Returns a value to determine if the calling app info should be always sent to the provider in every phase (if true), or should be removed from the query phase, and only sent as part of the request in the final phase, after the user has made a selection on the UI (if false).
Returns | |
---|---|
boolean |
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 |
getCredentialOptions
public List<CredentialOption> getCredentialOptions ()
Returns the list of credential options to be requested.
Returns | |
---|---|
List<CredentialOption> |
This value cannot be null . |
getData
public Bundle getData ()
Returns the top request level data.
Returns | |
---|---|
Bundle |
This value cannot be null . |
getOrigin
public String getOrigin ()
Returns the origin of the calling app if set otherwise returns null.
Returns | |
---|---|
String |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the 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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.