Added in API level 29

TextClassifierEvent.TextSelectionEvent

Kotlin |Java

public static final class TextClassifierEvent.TextSelectionEvent
extends TextClassifierEvent implements Parcelable

java.lang.Object
↳	android.view.textclassifier.TextClassifierEvent
	↳	android.view.textclassifier.TextClassifierEvent.TextSelectionEvent

This class represents events that are related to the smart text selection feature.

     // User started a selection. e.g. "York" in text "New York City, NY".
     new TextSelectionEvent.Builder(TYPE_SELECTION_STARTED)
         .setEventContext(classificationContext)
         .setEventIndex(0)
         .build();

     // System smart-selects a recognized entity. e.g. "New York City".
     new TextSelectionEvent.Builder(TYPE_SMART_SELECTION_MULTI)
         .setEventContext(classificationContext)
         .setResultId(textSelection.getId())
         .setRelativeWordStartIndex(-1) // Goes back one word to "New" from "York".
         .setRelativeWordEndIndex(2)    // Goes forward 2 words from "York" to start of ",".
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setEventIndex(1)
         .build();

     // User resets the selection to the original selection. i.e. "York".
     new TextSelectionEvent.Builder(TYPE_SELECTION_RESET)
         .setEventContext(classificationContext)
         .setResultId(textSelection.getId())
         .setRelativeSuggestedWordStartIndex(-1) // Repeated from above.
         .setRelativeSuggestedWordEndIndex(2)    // Repeated from above.
         .setRelativeWordStartIndex(0)           // Original selection is always at (0, 1].
         .setRelativeWordEndIndex(1)
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setEventIndex(2)
         .build();

     // User modified the selection. e.g. "New".
     new TextSelectionEvent.Builder(TYPE_SELECTION_MODIFIED)
         .setEventContext(classificationContext)
         .setResultId(textSelection.getId())
         .setRelativeSuggestedWordStartIndex(-1) // Repeated from above.
         .setRelativeSuggestedWordEndIndex(2)    // Repeated from above.
         .setRelativeWordStartIndex(-1)          // Goes backward one word from "York" to
         "New".
         .setRelativeWordEndIndex(0)             // Goes backward one word to exclude "York".
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setEventIndex(3)
         .build();

     // Smart (contextual) actions (at indices, 0, 1, 2) presented to the user.
     // e.g. "Map", "Ride share", "Explore".
     new TextSelectionEvent.Builder(TYPE_ACTIONS_SHOWN)
         .setEventContext(classificationContext)
         .setResultId(textClassification.getId())
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setActionIndices(0, 1, 2)
         .setEventIndex(4)
         .build();

     // User chooses the "Copy" action.
     new TextSelectionEvent.Builder(TYPE_COPY_ACTION)
         .setEventContext(classificationContext)
         .setResultId(textClassification.getId())
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setEventIndex(5)
         .build();

     // User chooses smart action at index 1. i.e. "Ride share".
     new TextSelectionEvent.Builder(TYPE_SMART_ACTION)
         .setEventContext(classificationContext)
         .setResultId(textClassification.getId())
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setActionIndices(1)
         .setEventIndex(5)
         .build();

     // Selection dismissed.
     new TextSelectionEvent.Builder(TYPE_SELECTION_DESTROYED)
         .setEventContext(classificationContext)
         .setResultId(textClassification.getId())
         .setEntityTypes(textClassification.getEntity(0))
         .setScore(textClassification.getConfidenceScore(entityType))
         .setEventIndex(6)
         .build();

Summary

Nested classes
`class`	`TextClassifierEvent.TextSelectionEvent.Builder` Builder class for `TextSelectionEvent`.

Inherited constants

From class android.view.textclassifier.TextClassifierEvent

`int`	`CATEGORY_CONVERSATION_ACTIONS` Conversation actions
`int`	`CATEGORY_LANGUAGE_DETECTION` Language detection
`int`	`CATEGORY_LINKIFY` Linkify
`int`	`CATEGORY_SELECTION` Smart selection
`int`	`TYPE_ACTIONS_GENERATED` TextClassifier generated some actions
`int`	`TYPE_ACTIONS_SHOWN` Smart actions shown to the user.
`int`	`TYPE_AUTO_SELECTION` Something else other than user or the default TextClassifier triggered a selection.
`int`	`TYPE_COPY_ACTION` User clicked on Copy action.
`int`	`TYPE_CUT_ACTION` User clicked on Cut action.
`int`	`TYPE_LINKS_GENERATED` Some text links were generated.
`int`	`TYPE_LINK_CLICKED` User clicked a link.
`int`	`TYPE_MANUAL_REPLY` User composed a reply.
`int`	`TYPE_OTHER_ACTION` User clicked on a custom action.
`int`	`TYPE_OVERTYPE` User typed over the selection.
`int`	`TYPE_PASTE_ACTION` User clicked on Paste action.
`int`	`TYPE_SELECTION_DESTROYED` Selection is destroyed.
`int`	`TYPE_SELECTION_DRAG` User dragged+dropped the selection.
`int`	`TYPE_SELECTION_MODIFIED` User modified an existing selection.
`int`	`TYPE_SELECTION_RESET` User reset the smart selection.
`int`	`TYPE_SELECTION_STARTED` User started a new selection.
`int`	`TYPE_SELECT_ALL` User clicked on Select All action
`int`	`TYPE_SHARE_ACTION` User clicked on Share action.
`int`	`TYPE_SMART_ACTION` User clicked on a Smart action.
`int`	`TYPE_SMART_SELECTION_MULTI` Smart selection triggered spanning multiple tokens (words).
`int`	`TYPE_SMART_SELECTION_SINGLE` Smart selection triggered for a single token (word).

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<TextClassifierEvent.TextSelectionEvent>`	`CREATOR`

Inherited fields

From class android.view.textclassifier.TextClassifierEvent


    public
    static
    final
    Creator<TextClassifierEvent>

CREATOR

Public methods
`int`	`getRelativeSuggestedWordEndIndex()` Returns the relative word (exclusive) index of the end of the smart selection.
`int`	`getRelativeSuggestedWordStartIndex()` Returns the relative word index of the start of the smart selection.
`int`	`getRelativeWordEndIndex()` Returns the relative word (exclusive) index of the end of the selection.
`int`	`getRelativeWordStartIndex()` Returns the relative word index of the start of the selection.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          android.view.textclassifier.TextClassifierEvent

`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int[]`	`getActionIndices()` Returns the indices of the actions relating to this event.
`String[]`	`getEntityTypes()` Returns an array of entity types.
`int`	`getEventCategory()` Returns the event category.
`TextClassificationContext`	`getEventContext()` Returns the event context.
`int`	`getEventIndex()` Returns the index of this event in the series of event it belongs to.
`int`	`getEventType()` Returns the event type.
`Bundle`	`getExtras()` Returns a bundle containing non-structured extra information about this event.
`ULocale`	`getLocale()` Returns the detected locale.
`String`	`getModelName()` Returns the model name.
`String`	`getResultId()` Returns the id of the text classifier result related to this event.
`float[]`	`getScores()` Returns the scores of the suggestions.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 29

public static final Creator<TextClassifierEvent.TextSelectionEvent> CREATOR

Public methods

getRelativeSuggestedWordEndIndex

Added in API level 29

public int getRelativeSuggestedWordEndIndex ()

Returns the relative word (exclusive) index of the end of the smart selection.

Returns
`int`

getRelativeSuggestedWordStartIndex

Added in API level 29

public int getRelativeSuggestedWordStartIndex ()

Returns the relative word index of the start of the smart selection.

Returns
`int`

getRelativeWordEndIndex

Added in API level 29

public int getRelativeWordEndIndex ()

Returns the relative word (exclusive) index of the end of the selection.

Returns
`int`

getRelativeWordStartIndex

Added in API level 29

public int getRelativeWordStartIndex ()

Returns the relative word index of the start of the selection.

Returns
`int`

writeToParcel

Added in API level 29

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

TextClassifierEvent.TextSelectionEvent

Summary

Nested classes

Inherited constants

Fields

Inherited fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

getRelativeSuggestedWordEndIndex

getRelativeSuggestedWordStartIndex

getRelativeWordEndIndex

getRelativeWordStartIndex

writeToParcel