LocusIdCompat

public final class LocusIdCompat
extends Object

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 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 ShortcutInfoCompat (through ShortcutInfoCompat.Builder.setLocusId(chatId)), if you provide a launcher shortcut for that chat conversation.
• Associating it with the ContentCaptureContext of the root view of the chat conversation activity (through View.getContentCaptureSession(), then new ContentCaptureContext.Builder(chatId).build() and 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.

Summary

Public constructors

public LocusIdCompat (String id)

Public methods

public boolean equals (Object obj)

public String getId ()

public int hashCode ()

public LocusId toLocusId ()

public static LocusIdCompat toLocusIdCompat (LocusId locusId)

public String toString ()