LocusIdCompat

Added in 1.5.0

Kotlin |Java

public final class LocusIdCompat

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 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:

LocusIdCompat chatId = new LocusIdCompat("Chat_A_B");

And then you should use that chatId by:

Setting it in the chat notification (through NotificationCompat.Builder.setLocusId(chatId)).
Setting it into the androidx.core.content.pm.ShortcutInfoCompat (through ShortcutInfoCompat.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 getContentCaptureSession, then new ContentCaptureContext.Builder(chatId).build() and setContentCaptureContext - see android.view.contentcapture.ContentCaptureManager for more info about content capture).
Configuring your app to launch the chat conversation through the ACTION_VIEW_LOCUS intent.

NOTE: The LocusId is only used by a on-device intelligence service provided by the Android System, see android.view.contentcapture.ContentCaptureManager for more details.

Summary

Public constructors
`LocusIdCompat(@NonNull String id)` Construct a new LocusIdCompat with the specified id.

Public methods
`boolean`	`equals(@Nullable Object obj)`
`@NonNull String`	`getId()` Gets the canonical `id` associated with the locus.
`int`	`hashCode()`
`@NonNull LocusId`	`@RequiresApi(value = 29) toLocusId()`
`static @NonNull LocusIdCompat`	`@RequiresApi(value = 29) toLocusIdCompat(@NonNull LocusId locusId)` Returns an instance of LocusIdCompat from given `LocusId`.
`@NonNull String`	`toString()`

Public constructors

LocusIdCompat

Added in 1.5.0

public LocusIdCompat(@NonNull String id)

Construct a new LocusIdCompat with the specified id.

Throws
`java.lang.IllegalArgumentException`	if `id` is empty or `null`.

Public methods

equals

public boolean equals(@Nullable Object obj)

getId

Added in 1.5.0

public @NonNull String getId()

Gets the canonical id associated with the locus.

hashCode

public int hashCode()

toLocusId

Added in 1.5.0

@RequiresApi(value = 29)
public @NonNull LocusId toLocusId()

Returns
`@NonNull LocusId`	`LocusId` object from this compat object.

toLocusIdCompat

Added in 1.5.0

@RequiresApi(value = 29)
public static @NonNull LocusIdCompat toLocusIdCompat(@NonNull LocusId locusId)

Returns an instance of LocusIdCompat from given LocusId.

toString

public @NonNull String toString()