LocusId

Kotlin |Java

class LocusId : Parcelable

kotlin.Any
↳	android.content.LocusId

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:

Setting it in the chat notification (through Notification.Builder.setLocusId(chatId)).
Setting it into the android.content.pm.ShortcutInfo (through ShortcutInfo.Builder.setLocusId(chatId)), if you provide a launcher shortcut for that chat conversation.
Associating it with the android.view.contentcapture.ContentCaptureContext of the root view of the chat conversation activity (through android.view.View#getContentCaptureSession(), then new ContentCaptureContext.Builder(chatId).build() and android.view.contentcapture.ContentCaptureSession#setContentCaptureContext( * android.view.contentcapture.ContentCaptureContext) - see ContentCaptureManager for more info about content capture).
Configuring your app to launch the chat conversation through the Intent.ACTION_VIEW_LOCUS intent.

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
`LocusId(id: String)` Default constructor.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
String	`getId()` Gets the canonical `id` associated with the locus.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(parcel: Parcel, flags: Int)`

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

Public constructors

LocusId

Added in API level 29

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

Added in API level 29

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`

equals

Added in API level 29

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

Added in API level 29

fun getId(): String

Gets the canonical id associated with the locus.

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

hashCode

Added in API level 29

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 29

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 29

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

Parameters
`dest`	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 29

static val CREATOR: Parcelable.Creator<LocusId!>