Most visited

Recently visited

Results for

Summary: Methods | Inherited Methods

ContentCaptureSession

public abstract class ContentCaptureSession
extends Object implements AutoCloseable

java.lang.Object
↳	android.view.contentcapture.ContentCaptureSession

Session used when the Android a system-provided content capture service about events associated with views.

Summary

Public methods
`final ContentCaptureSession`	`createContentCaptureSession(ContentCaptureContext context)` Creates a new `ContentCaptureSession`.
`final void`	`destroy()` Destroys this session, flushing out all pending notifications to the service.
`final ContentCaptureContext`	`getContentCaptureContext()` Gets the `ContentCaptureContext` associated with the session.
`final ContentCaptureSessionId`	`getContentCaptureSessionId()` Gets the id used to identify this session.
`AutofillId`	`newAutofillId(AutofillId hostId, long virtualChildId)` Creates a new `AutofillId` for a virtual child, so it can be used to uniquely identify the children in the session.
`final ViewStructure`	`newViewStructure(View view)` Creates a `ViewStructure` for a "standard" view.
`final ViewStructure`	`newVirtualViewStructure(AutofillId parentId, long virtualId)` Creates a `ViewStructure` for a "virtual" view, so it can be passed to `notifyViewAppeared(android.view.ViewStructure)` by the view managing the virtual view hierarchy.
`final void`	`notifySessionPaused()` Notifies the Content Capture Service that a session has paused.
`final void`	`notifySessionResumed()` Notifies the Content Capture Service that a session has resumed.
`final void`	`notifyViewAppeared(ViewStructure node)` Notifies the Content Capture Service that a node has been added to the view structure.
`final void`	`notifyViewDisappeared(AutofillId id)` Notifies the Content Capture Service that a node has been removed from the view structure.
`final void`	`notifyViewInsetsChanged(Insets viewInsets)` Notifies the Intelligence Service that the insets of a view have changed.
`final void`	`notifyViewTextChanged(AutofillId id, CharSequence text)` Notifies the Intelligence Service that the value of a text node has been changed.
`final void`	`notifyViewsDisappeared(AutofillId hostId, long[] virtualIds)` Notifies the Content Capture Service that many nodes has been removed from a virtual view structure.
`final void`	`setContentCaptureContext(ContentCaptureContext context)` Sets the `ContentCaptureContext` associated with the session.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

createContentCaptureSession

public final ContentCaptureSession createContentCaptureSession (ContentCaptureContext context)

Creates a new ContentCaptureSession.

See View#setContentCaptureSession(ContentCaptureSession) for more info.

Parameters
`context`	`ContentCaptureContext`: This value cannot be `null`.

Returns
`ContentCaptureSession`	This value cannot be `null`.

destroy

public final void destroy ()

Destroys this session, flushing out all pending notifications to the service.

Once destroyed, any new notification will be dropped.

getContentCaptureContext

public final ContentCaptureContext getContentCaptureContext ()

Gets the ContentCaptureContext associated with the session.

Returns
`ContentCaptureContext`	context set on constructor or by `setContentCaptureContext(android.view.contentcapture.ContentCaptureContext)`, or `null` if never explicitly set.

getContentCaptureSessionId

public final ContentCaptureSessionId getContentCaptureSessionId ()

Gets the id used to identify this session.

Returns
`ContentCaptureSessionId`	This value cannot be `null`.

newAutofillId

public AutofillId newAutofillId (AutofillId hostId, 
                long virtualChildId)

Creates a new AutofillId for a virtual child, so it can be used to uniquely identify the children in the session.

Parameters
`hostId`	`AutofillId`: id of the non-virtual view hosting the virtual view hierarchy (it can be obtained by calling `ViewStructure#getAutofillId()`). This value cannot be `null`.
`virtualChildId`	`long`: id of the virtual child, relative to the parent.

Returns
`AutofillId`	if for the virtual child This value cannot be `null`.

Throws
`IllegalArgumentException`	if the `parentId` is a virtual child id.

newViewStructure

public final ViewStructure newViewStructure (View view)

Creates a ViewStructure for a "standard" view.

This method should be called after a visible view is laid out; the view then must populate the structure and pass it to notifyViewAppeared(android.view.ViewStructure). Note: views that manage a virtual structure under this view must populate just the node representing this view and return right away, then asynchronously report (not necessarily in the UI thread) when the children nodes appear, disappear or have their text changed by calling ContentCaptureSession#notifyViewAppeared(ViewStructure), ContentCaptureSession#notifyViewDisappeared(AutofillId), and ContentCaptureSession#notifyViewTextChanged(AutofillId, CharSequence) respectively. The structure for the a child must be created using ContentCaptureSession#newVirtualViewStructure(AutofillId, long), and the autofillId for a child can be obtained either through childStructure.getAutofillId() or ContentCaptureSession#newAutofillId(AutofillId, long).

When the virtual view hierarchy represents a web page, you should also:

Call ContentCaptureManager#getContentCaptureConditions() to infer content capture events should be generate for that URL.
Create a new ContentCaptureSession child for every HTML element that renders a new URL (like an IFRAME) and use that session to notify events from that subtree.

Note: the following methods of the structure will be ignored:

Parameters
`view`	`View`: This value cannot be `null`.

Returns
`ViewStructure`	This value cannot be `null`.

newVirtualViewStructure

public final ViewStructure newVirtualViewStructure (AutofillId parentId, 
                long virtualId)

Creates a ViewStructure for a "virtual" view, so it can be passed to notifyViewAppeared(android.view.ViewStructure) by the view managing the virtual view hierarchy.

Parameters
`parentId`	`AutofillId`: id of the virtual view parent (it can be obtained by calling `ViewStructure#getAutofillId()` on the parent). This value cannot be `null`.
`virtualId`	`long`: id of the virtual child, relative to the parent.

Returns
`ViewStructure`	a new `ViewStructure` that can be used for Content Capture purposes. This value cannot be `null`.

notifySessionPaused

public final void notifySessionPaused ()

Notifies the Content Capture Service that a session has paused.

notifySessionResumed

public final void notifySessionResumed ()

Notifies the Content Capture Service that a session has resumed.

notifyViewAppeared

public final void notifyViewAppeared (ViewStructure node)

Notifies the Content Capture Service that a node has been added to the view structure.

Typically called "manually" by views that handle their own virtual view hierarchy, or automatically by the Android System for views that return true on View#onProvideContentCaptureStructure(ViewStructure, int).

Parameters
`node`	`ViewStructure`: node that has been added. This value cannot be `null`.

notifyViewDisappeared

public final void notifyViewDisappeared (AutofillId id)

Notifies the Content Capture Service that a node has been removed from the view structure.

Typically called "manually" by views that handle their own virtual view hierarchy, or automatically by the Android System for standard views.

Parameters
`id`	`AutofillId`: id of the node that has been removed. This value cannot be `null`.

notifyViewInsetsChanged

public final void notifyViewInsetsChanged (Insets viewInsets)

Notifies the Intelligence Service that the insets of a view have changed.

Parameters
`viewInsets`	`Insets`: This value cannot be `null`.

notifyViewTextChanged

public final void notifyViewTextChanged (AutofillId id, 
                CharSequence text)

Notifies the Intelligence Service that the value of a text node has been changed.

Parameters
`id`	`AutofillId`: of the node. This value cannot be `null`.
`text`	`CharSequence`: new text. This value may be `null`.

notifyViewsDisappeared

public final void notifyViewsDisappeared (AutofillId hostId, 
                long[] virtualIds)

Notifies the Content Capture Service that many nodes has been removed from a virtual view structure.

Should only be called by views that handle their own virtual view hierarchy.

Parameters
`hostId`	`AutofillId`: id of the non-virtual view hosting the virtual view hierarchy (it can be obtained by calling `ViewStructure#getAutofillId()`). This value cannot be `null`.
`virtualIds`	`long`: ids of the virtual children. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the `hostId` is an autofill id for a virtual view.
`IllegalArgumentException`	if `virtualIds` is empty

setContentCaptureContext

public final void setContentCaptureContext (ContentCaptureContext context)

Sets the ContentCaptureContext associated with the session.

Typically used to change the context associated with the default session from an activity.

Parameters
`context`	`ContentCaptureContext`: This value may be `null`.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

Interfaces

Classes

Most visited

Recently visited

Results for

ContentCaptureSession

Summary

Public methods

Inherited methods

Public methods

createContentCaptureSession

destroy

getContentCaptureContext

getContentCaptureSessionId

newAutofillId

newViewStructure

newVirtualViewStructure

notifySessionPaused

notifySessionResumed

notifyViewAppeared

notifyViewDisappeared

notifyViewInsetsChanged

notifyViewTextChanged

notifyViewsDisappeared

setContentCaptureContext

toString