LocusId Class

Reference

Definition

Namespace:: Android.Content

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

An identifier for an unique state (locus) in the application.

[Android.Runtime.Register("android/content/LocusId", ApiSince=29, DoNotGenerateAcw=true)]
public sealed class LocusId : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/content/LocusId", ApiSince=29, DoNotGenerateAcw=true)>]
type LocusId = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

Object
LocusId

Attributes: RegisterAttribute

Implements: IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

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.os.Build.VERSION_CODES#Q 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:

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

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

Java documentation for android.content.LocusId.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

LocusId(String)

Default constructor.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Creator
Handle	The handle to the underlying Android instance. (Inherited from Object)
Id	Gets the canonical `id` associated with the locus.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
DescribeContents()
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Share via