LocusId
class LocusId : Parcelable
An identifier for an unique state (locus) in the application. Should be stable across reboots and backup / restore.
Locus is a new concept introduced on Android Q and it lets the intelligence service provided by the Android System to correlate state between different subsystems such as content capture, shortcuts, and notifications.
For example, if your app provides an activity representing a chat between 2 users (say A and B, this chat state could be represented by:
<code>
LocusId chatId = new LocusId("Chat_A_B");
</code>
And then you should use that chatId by:
NOTE: The LocusId is only used by an on-device intelligence service provided by the Android System, see
ContentCaptureManager for more details.
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 |
|
Default constructor.
|
| Public methods |
| Int |
|
| Boolean |
Indicates whether some other object is "equal to" this one.
|
| String |
Gets the canonical id associated with the locus.
|
| Int |
|
| String |
|
| Unit |
|
Public constructors
LocusId
LocusId(id: String)
Default constructor.
| Parameters |
id |
String: This value cannot be null. |
| Exceptions |
java.lang.IllegalArgumentException |
if id is empty or null. |
Public methods
describeContents
fun describeContents(): Int
equals
fun equals(other: Any?): Boolean
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. |
getId
fun getId(): String
Gets the canonical id associated with the locus.
| Return |
String |
This value cannot be null. |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
toString
fun toString(): String
| Return |
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
parcel: Parcel,
flags: Int
): Unit
Properties
