SliceSpec
public final class SliceSpec
extends Object
implements Parcelable
java.lang.Object | |
↳ | android.app.slice.SliceSpec |
This class was deprecated in API level 35.
Slice framework has been deprecated, it will not receive any updates from ERROR(/android.os.Build.VANILLA_ICE_CREAM)
and forward. If you are looking for a framework that sends displayable data from one app to another, consider using AppSearchManager
.
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 SliceSpec
s provided canRender(SliceSpec)
.
See also:
Summary
Inherited constants |
---|
Fields | |
---|---|
public static final Creator<SliceSpec> | CREATOR
|
Public constructors | |
---|---|
SliceSpec(String type, int revision) |
Public methods | |
---|---|
boolean | canRender(SliceSpec candidate) Indicates that this spec can be used to render the specified spec. |
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean | equals(Object obj) 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() Returns a string representation of the object. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
SliceSpec
public SliceSpec (String type, int revision)
Parameters | |
---|---|
type | String : This value cannot be null . |
revision | int |
Public methods
canRender
public boolean canRender (SliceSpec candidate)
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 . |
Returns | |
---|---|
boolean | true if versions are compatible. |
See also:
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 |
equals
public boolean equals (Object obj)
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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 | Object : This value may be null . |
Returns | |
---|---|
boolean | true if this object is the same as the obj argument; false otherwise. |
getRevision
public int getRevision ()
Gets the revision of the version.
Returns | |
---|---|
int |
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 : 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.PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |