Action


public final class Action
extends Object implements Parcelable

java.lang.Object
   ↳ android.service.credentials.Action


An action defined by the provider that intents into the provider's app for specific user actions.

If user selects this action entry, the corresponding PendingIntent set on the slice as a SliceAction will get invoked.

Summary

Inherited constants

Fields

public static final Creator<Action> CREATOR

Public constructors

Action(Slice slice)

Constructs an action 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 a Slice object containing the display content to be displayed on the UI.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

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

Public constructors

Action

Added in API level 34
public Action (Slice slice)

Constructs an action to be displayed on the UI.

Actions must be used for any provider related operations, such as opening the provider app, intenting straight into certain app activities like 'manage credentials', top level authentication before displaying any content etc.

See details on usage of Action for various actionable entries in BeginCreateCredentialResponse and BeginGetCredentialResponse.

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 Action 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

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

getSlice

Added in API level 34
public Slice getSlice ()

Returns a Slice object containing the display content to be displayed on the UI.

Returns
Slice This value cannot be null.

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