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

# TextLinks.TextLink

*** ** * ** ***


`
public
static
final

class
TextLinks.TextLink
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

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

<br />

*** ** * ** ***

A link, identifying a substring of text and possible entity types for it.

## Summary

| ### Inherited constants |
|---|
| 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/TextLinks.TextLink>` | `https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` float` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getConfidenceScore(java.lang.String)(https://developer.android.com/reference/java/lang/String entityType) ` Returns the confidence score for a particular entity type. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getEnd()() ` Returns the end index of this link in the original text. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getEntity(int)(int index) ` Returns the entity type at a given index. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getEntityCount()() ` Returns the number of entity types that have confidence scores. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getExtras()() ` Returns a bundle containing custom data related to this TextLink. |
| ` int` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#getStart()() ` Returns the start index of this link in the original text. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/view/textclassifier/TextLinks.TextLink#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/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 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<TextLinks.TextLink> 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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`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 - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getConfidenceScore

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

```
public float getConfidenceScore (String entityType)
```

Returns the confidence score for a particular entity type.

<br />

| Parameters ||
|---|---|
| `entityType` | `String`: the entity type. Value is one of the following: - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_UNKNOWN` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTHER` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_EMAIL` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_PHONE` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_ADDRESS` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_URL` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE_TIME` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_FLIGHT_NUMBER` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTP` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_RETRIEVER_OTP` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_WEB_OTP` |

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

### getEnd

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

```
public int getEnd ()
```

Returns the end index of this link in the original text.

<br />

| Returns ||
|---|---|
| `int` | the end index <br /> |

### getEntity

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

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

Returns the entity type at a given index. Entity types are sorted by confidence.

<br />

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

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | the entity type at the provided index. This value cannot be `null`. Value is one of the following: - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_UNKNOWN` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTHER` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_EMAIL` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_PHONE` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_ADDRESS` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_URL` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_DATE_TIME` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_FLIGHT_NUMBER` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_OTP` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_RETRIEVER_OTP` - `https://developer.android.com/reference/android/view/textclassifier/TextClassifier#TYPE_SMS_WEB_OTP` |

### getEntityCount

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

```
public int getEntityCount ()
```

Returns the number of entity types that have confidence scores.

<br />

| Returns ||
|---|---|
| `int` | the entity count <br /> |

### getExtras

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

```
public Bundle getExtras ()
```

Returns a bundle containing custom data related to this TextLink.

<br />

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

### getStart

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

```
public int getStart ()
```

Returns the start index of this link in the original text.

<br />

| Returns ||
|---|---|
| `int` | the start index <br /> |

### toString

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

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `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 `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` |