Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#lfields) \| [Inherited Fields](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#inhfields) \| [Methods](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#inhmethods)

# TextClassifierEvent.TextSelectionEvent

*** ** * ** ***

` public static final class TextClassifierEvent.TextSelectionEvent `   
` ` ` extends https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.view.textclassifier.TextClassifierEvent](https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent) ||
|   | ↳ | android.view.textclassifier.TextClassifierEvent.TextSelectionEvent |

<br />

*** ** * ** ***

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

<br />

```
    // 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();
```

<br />

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent.Builder` Builder class for `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent`. |

### Inherited constants

From class `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent` `int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#CATEGORY_CONVERSATION_ACTIONS`

Conversation actions
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#CATEGORY_LANGUAGE_DETECTION`

Language detection
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#CATEGORY_LINKIFY`

Linkify
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#CATEGORY_SELECTION`

Smart selection
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_ACTIONS_GENERATED`

TextClassifier generated some actions
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_ACTIONS_SHOWN`

Smart actions shown to the user.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_AUTO_SELECTION`

Something else other than user or the default TextClassifier triggered a selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_COPY_ACTION`

User clicked on Copy action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_CUT_ACTION`

User clicked on Cut action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_LINKS_GENERATED`

Some text links were generated.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_LINK_CLICKED`

User clicked a link.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_MANUAL_REPLY`

User composed a reply.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_OTHER_ACTION`

User clicked on a custom action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_OVERTYPE`

User typed over the selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_PASTE_ACTION`

User clicked on Paste action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECTION_DESTROYED`

Selection is destroyed.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECTION_DRAG`

User dragged+dropped the selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECTION_MODIFIED`

User modified an existing selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECTION_RESET`

User reset the smart selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECTION_STARTED`

User started a new selection.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SELECT_ALL`

User clicked on Select All action
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SHARE_ACTION`

User clicked on Share action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SMART_ACTION`

User clicked on a Smart action.
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SMART_SELECTION_MULTI`

Smart selection triggered spanning multiple tokens (words).
`int` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#TYPE_SMART_SELECTION_SINGLE`

Smart selection triggered for a single token (word).
From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent>` | `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#CREATOR` <br /> |

### Inherited fields

From class `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent` ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent>` `https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#CREATOR`

<br />

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#getRelativeSuggestedWordEndIndex()() ` Returns the relative word (exclusive) index of the end of the smart selection. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#getRelativeSuggestedWordStartIndex()() ` Returns the relative word index of the start of the smart selection. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#getRelativeWordEndIndex()() ` Returns the relative word (exclusive) index of the end of the selection. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#getRelativeWordStartIndex()() ` Returns the relative word index of the start of the selection. |
| ` void` | ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent.TextSelectionEvent#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent ` ` int` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` int[]` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getActionIndices()() `

Returns the indices of the actions relating to this event.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getEntityTypes()() `

Returns an array of entity types.
` int` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getEventCategory()() `

Returns the event category.
` https://developer.android.com/reference/android/view/textclassifier/TextClassificationContext` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getEventContext()() `

Returns the event context.
` int` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getEventIndex()() `

Returns the index of this event in the series of event it belongs to.
` int` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getEventType()() `

Returns the event type.
` https://developer.android.com/reference/android/os/Bundle` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getExtras()() `

Returns a bundle containing non-structured extra information about this event.
` https://developer.android.com/reference/android/icu/util/ULocale` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getLocale()() `

Returns the detected locale.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getModelName()() `

Returns the model name.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getResultId()() `

Returns the id of the text classifier result related to this event.
` float[]` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#getScores()() `

Returns the scores of the suggestions.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#toString()() `

Returns a string representation of the object.
` void` ` https://developer.android.com/reference/android/view/textclassifier/TextClassifierEvent#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

<br />

## Public methods

### getRelativeSuggestedWordEndIndex

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRelativeSuggestedWordEndIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getRelativeSuggestedWordStartIndex

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRelativeSuggestedWordStartIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getRelativeWordEndIndex

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRelativeWordEndIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### getRelativeWordStartIndex

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRelativeWordStartIndex ()
```

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

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### writeToParcel

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |