Action

Kotlin |Java

class Action : Parcelable

kotlin.Any
↳	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 androidx.slice.core.SliceAction will get invoked.

Summary

Inherited constants

From class Parcelable

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: 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)". Some implementations may want to release resources at this point.

Public constructors
`Action(slice: Slice)` Constructs an action to be displayed on the UI.

Public methods
Int	`describeContents()`
Slice	`getSlice()` Returns a `Slice` object containing the display content to be displayed on the UI.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Action!>	`CREATOR`

Public constructors

Action

Added in API level 34

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 androidx.credentials.provider.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

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 androidx.credentials.provider.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

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getSlice

Added in API level 34

fun getSlice(): Slice

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

Return
`Slice`	This value cannot be `null`.

writeToParcel

Added in API level 34

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<Action!>