TextSelectionEvent

Kotlin |Java

class TextSelectionEvent : TextClassifierEvent, Parcelable

kotlin.Any
↳	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
	`Builder` Builder class for `TextSelectionEvent`.

Inherited constants

From class 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 class 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: 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)". Some implementations may want to release resources at this point.

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.
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Inherited functions

From class TextClassifierEvent

`Int`	`describeContents()`
`IntArray`	`getActionIndices()` Returns the indices of the actions relating to this event. Actions are usually returned by the text classifier in priority order with the most preferred action at index 0. This list gives an indication of the position of the actions that are being reported.
`Array<String!>`	`getEntityTypes()` Returns an array of entity types. e.g. `TextClassifier#TYPE_ADDRESS`.
`Int`	`getEventCategory()` Returns the event category. e.g. `CATEGORY_SELECTION`.
`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. e.g. `TYPE_SELECTION_STARTED`.
`Bundle`	`getExtras()` Returns a bundle containing non-structured extra information about this event. NOTE: Do not modify this bundle.
`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.
`FloatArray`	`getScores()` Returns the scores of the suggestions.
`String`	`toString()`

Properties
static Parcelable.Creator<TextClassifierEvent.TextSelectionEvent!>	`CREATOR`

Public methods

getRelativeSuggestedWordEndIndex

Added in API level 29

fun getRelativeSuggestedWordEndIndex(): Int

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

getRelativeSuggestedWordStartIndex

Added in API level 29

fun getRelativeSuggestedWordStartIndex(): Int

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

getRelativeWordEndIndex

Added in API level 29

fun getRelativeWordEndIndex(): Int

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

getRelativeWordStartIndex

Added in API level 29

fun getRelativeWordStartIndex(): Int

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

writeToParcel

Added in API level 29

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<TextClassifierEvent.TextSelectionEvent!>