RemoteEntry
public
final
class
RemoteEntry
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.service.credentials.RemoteEntry |
An entry to be shown on the UI. This entry represents remote execution of a get/create flow whereby credentials are retrieved from, or stored to a remote device.
If user selects this entry, the corresponding PendingIntent
set on the
slice
as a SliceAction
will get invoked.
Once the resulting activity fulfills the required user engagement,
the Activity
result should be set to Activity.RESULT_OK
,
and the result of the operation must be set as the activity result.
For a get flow, invoked through CredentialProviderService#onBeginGetCredential
,
providers must set a GetCredentialResponse
on the activity result,
against the key CredentialProviderService#EXTRA_GET_CREDENTIAL_RESPONSE
.
For a creates flow, invoked through CredentialProviderService#onBeginCreateCredential
,
providers must set a CreateCredentialResponse
on the activity
result against the ket CredentialProviderService#EXTRA_CREATE_CREDENTIAL_RESPONSE
.
Summary
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<RemoteEntry> |
CREATOR
|
Public constructors | |
---|---|
RemoteEntry(Slice slice)
Constructs a RemoteEntry to be displayed on the UI. |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
Slice
|
getSlice()
Returns the content to be displayed with this remote entry on the UI. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
RemoteEntry
public RemoteEntry (Slice slice)
Constructs a RemoteEntry to be displayed on the UI.
Parameters | |
---|---|
slice |
Slice : the slice containing the metadata to be shown on the UI, must be constructed
through the androidx.credentials.provider Jetpack library;
If constructed manually, the slice object must
contain the non-null properties of the
RemoteEntry class populated as slice items
against specific hints as used in the class's toSlice method,
since the Android System uses this library to parse the slice and
extract the required attributes |
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 |
getSlice
public Slice getSlice ()
Returns the content to be displayed with this remote entry on the UI.
Returns | |
---|---|
Slice |
This value cannot be null . |
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 |