Added in API level 28
Deprecated in API level 35

SliceSpec

Kotlin |Java

class SliceSpec : Parcelable

kotlin.Any
↳	android.app.slice.SliceSpec

Class describing the structure of the data contained within a slice.

A data version contains a string which describes the type of structure and a revision which denotes this specific implementation. Revisions are expected to be backwards compatible and monotonically increasing. Meaning if a SliceSpec has the same type and an equal or lesser revision, it is expected to be compatible.

Apps rendering slices will provide a list of supported versions to the OS which will also be given to the app. Apps should only return a Slice with a SliceSpec that one of the supported SliceSpecs provided canRender.

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
`SliceSpec(type: String, revision: Int)`

Public methods
Boolean	`canRender(candidate: SliceSpec)` Indicates that this spec can be used to render the specified spec.
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Int	`getRevision()` Gets the revision of the version.
String!	`getType()` Gets the type of the version.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

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

Public constructors

SliceSpec

Added in API level 28

SliceSpec(
    type: String, 
    revision: Int)

Parameters
`type`	String: This value cannot be `null`.

Public methods

canRender

Added in API level 28

fun canRender(candidate: SliceSpec): Boolean

Deprecated: Deprecated in Java.

Indicates that this spec can be used to render the specified spec.

Rendering support is not bi-directional (e.g. Spec v3 can render Spec v2, but Spec v2 cannot render Spec v3).

Parameters
`candidate`	SliceSpec: candidate format of data. This value cannot be `null`.

Return
`Boolean`	true if versions are compatible.

See Also

describeContents

Added in API level 28

fun describeContents(): Int

Deprecated: Deprecated in Java.

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`

equals

Added in API level 28

fun equals(other: Any?): Boolean

Deprecated: Deprecated in Java.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getRevision

Added in API level 28

fun getRevision(): Int

Deprecated: Deprecated in Java.

Gets the revision of the version.

getType

Added in API level 28

fun getType(): String!

Deprecated: Deprecated in Java.

Gets the type of the version.

toString

Added in API level 28

fun toString(): String

Deprecated: Deprecated in Java.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 28

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

Deprecated: Deprecated in Java.

Parameters
`dest`	Parcel: The Parcel in which the object should be written. 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 28

static val CREATOR: Parcelable.Creator<SliceSpec!>

Deprecated: Deprecated in Java.