LocusIdCompat

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:

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

Construct a new LocusIdCompat with the specified id.

Public methods

@Override boolean
@NonNull String

Gets the canonical id associated with the locus.

@Override int
@NonNull @RequiresApi(value = 29) LocusId
static @NonNull @RequiresApi(value = 29) LocusIdCompat

Returns an instance of LocusIdCompat from given LocusId.

@NonNull @Override String

Public constructors

LocusIdCompat

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

@Override
public boolean equals(@Nullable