# TextSelection

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

# TextSelection

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/view/textclassifier/TextSelection "View this page in Kotlin")\|Java

`
public

final

class
TextSelection
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

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

<br />

*** ** * ** ***

Information about where text selection should be.

## Summary

|                                                                                                                      ### Nested classes                                                                                                                      ||
|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [TextSelection.Builder](https://developer.android.com/reference/android/view/textclassifier/TextSelection.Builder) Builder used to build[TextSelection](https://developer.android.com/reference/android/view/textclassifier/TextSelection)objects. |
| ` class` | [TextSelection.Request](https://developer.android.com/reference/android/view/textclassifier/TextSelection.Request) A request object for generating TextSelection.                                                                                  |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](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 `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[TextSelection](https://developer.android.com/reference/android/view/textclassifier/TextSelection)`>` | [CREATOR](https://developer.android.com/reference/android/view/textclassifier/TextSelection#CREATOR) <br /> |

|                                                                                                                                                                                           ### Public methods                                                                                                                                                                                            ||
|-----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                                                          | ` `[describeContents](https://developer.android.com/reference/android/view/textclassifier/TextSelection#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                               |
| ` float`                                                                                                        | ` `[getConfidenceScore](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getConfidenceScore(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` entity) ` Returns the confidence score for the specified entity. |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                           | ` `[getEntity](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getEntity(int))`(int index) ` Returns the entity at the specified index.                                                                                                              |
| ` int`                                                                                                          | ` `[getEntityCount](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getEntityCount())`() ` Returns the number of entities found in the classified text.                                                                                              |
| ` `[Bundle](https://developer.android.com/reference/android/os/Bundle)                                          | ` `[getExtras](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getExtras())`() ` Returns the extended data.                                                                                                                                          |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                           | ` `[getId](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getId())`() ` Returns the id, if one exists, for this object.                                                                                                                             |
| ` int`                                                                                                          | ` `[getSelectionEndIndex](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getSelectionEndIndex())`() ` Returns the end index of the text selection.                                                                                                  |
| ` int`                                                                                                          | ` `[getSelectionStartIndex](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getSelectionStartIndex())`() ` Returns the start index of the text selection.                                                                                            |
| ` `[TextClassification](https://developer.android.com/reference/android/view/textclassifier/TextClassification) | ` `[getTextClassification](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getTextClassification())`() ` Returns the text classification result of the suggested selection span.                                                                     |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                           | ` `[toString](https://developer.android.com/reference/android/view/textclassifier/TextSelection#toString())`() ` Returns a string representation of the object.                                                                                                                        |
| ` void`                                                                                                         | ` `[writeToParcel](https://developer.android.com/reference/android/view/textclassifier/TextSelection#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel.            |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](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` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

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

```
public static final Creator<TextSelection> CREATOR
```

<br />

<br />

## Public methods

### describeContents

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

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         Returns                                                                                                                         ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### getConfidenceScore

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

```
public float getConfidenceScore (String entity)
```

Returns the confidence score for the specified entity. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the classified text.

<br />

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ||
|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `entity` | `String`: Value is[TextClassifier.TYPE_UNKNOWN](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_UNKNOWN),[TextClassifier.TYPE_OTHER](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTHER),[TextClassifier.TYPE_EMAIL](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_EMAIL),[TextClassifier.TYPE_PHONE](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_PHONE),[TextClassifier.TYPE_ADDRESS](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_ADDRESS),[TextClassifier.TYPE_URL](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_URL),[TextClassifier.TYPE_DATE](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE),[TextClassifier.TYPE_DATE_TIME](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE_TIME),[TextClassifier.TYPE_FLIGHT_NUMBER](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_FLIGHT_NUMBER), android.view.textclassifier.TextClassifier.TYPE_DICTIONARY,[TextClassifier.TYPE_OTP](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTP), or[TextClassifier.TYPE_SMS_RETRIEVER_OTP](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_RETRIEVER_OTP) <br /> |

|                         Returns                          ||
|---------|-------------------------------------------------|
| `float` | Value is between 0.0f and 1.0f inclusive <br /> |

### getEntity

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

```
public String getEntity (int index)
```

Returns the entity at the specified index. Entities are ordered from high confidence to low confidence.

<br />

|      Parameters       ||
|---------|--------------|
| `index` | `int` <br /> |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               Returns                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ||
|--------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`. Value is[TextClassifier.TYPE_UNKNOWN](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_UNKNOWN),[TextClassifier.TYPE_OTHER](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTHER),[TextClassifier.TYPE_EMAIL](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_EMAIL),[TextClassifier.TYPE_PHONE](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_PHONE),[TextClassifier.TYPE_ADDRESS](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_ADDRESS),[TextClassifier.TYPE_URL](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_URL),[TextClassifier.TYPE_DATE](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE),[TextClassifier.TYPE_DATE_TIME](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE_TIME),[TextClassifier.TYPE_FLIGHT_NUMBER](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_FLIGHT_NUMBER), android.view.textclassifier.TextClassifier.TYPE_DICTIONARY,[TextClassifier.TYPE_OTP](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTP), or[TextClassifier.TYPE_SMS_RETRIEVER_OTP](https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_RETRIEVER_OTP) <br /> |

|                                                                      Throws                                                                       ||
|----------------------------------------------------------------------------------------------------------|-----------------------------------------|
| [IndexOutOfBoundsException](https://developer.android.com/reference/java/lang/IndexOutOfBoundsException) | if the specified index is out of range. |

**See also:**

- [for the number of entities available.](https://developer.android.com/reference/android/view/textclassifier/TextSelection#getEntityCount())  

### getEntityCount

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

```
public int getEntityCount ()
```

Returns the number of entities found in the classified text.

<br />

|               Returns               ||
|-------|------------------------------|
| `int` | Value is 0 or greater <br /> |

### getExtras

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

```
public Bundle getExtras ()
```

Returns the extended data.

**NOTE:**Do not modify this bundle.

<br />

|                                                 Returns                                                 ||
|---------------------------------------------------------------------|------------------------------------|
| [Bundle](https://developer.android.com/reference/android/os/Bundle) | This value cannot be`null`. <br /> |

### getId

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

```
public String getId ()
```

Returns the id, if one exists, for this object.

<br />

|                                               Returns                                               ||
|--------------------------------------------------------------------|---------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value may be`null`. <br /> |

### getSelectionEndIndex

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

```
public int getSelectionEndIndex ()
```

Returns the end index of the text selection.

<br />

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

### getSelectionStartIndex

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

```
public int getSelectionStartIndex ()
```

Returns the start index of the text selection.

<br />

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

### getTextClassification

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

```
public TextClassification getTextClassification ()
```

Returns the text classification result of the suggested selection span. Enables the text classification by calling[TextSelection.Request.Builder.setIncludeTextClassification(boolean)](https://developer.android.com/reference/android/view/textclassifier/TextSelection.Request.Builder#setIncludeTextClassification(boolean)). If the text classifier does not support it, a`null`is returned.

<br />

|                                                       Returns                                                        ||
|--------------------------------------------------------------------------------------------------------------|--------|
| [TextClassification](https://developer.android.com/reference/android/view/textclassifier/TextClassification) | <br /> |

**See also:**

- [TextSelection.Request.Builder.setIncludeTextClassification(boolean)](https://developer.android.com/reference/android/view/textclassifier/TextSelection.Request.Builder#setIncludeTextClassification(boolean))  

### toString

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

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |

### writeToParcel

Added in[API level 28](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[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |