Added in API level 28

Summary: Inherited Constants | Fields | Methods | Inherited Methods

TextLinks.TextLink

Kotlin |Java

public static final class TextLinks.TextLink
extends Object implements Parcelable

java.lang.Object
↳	android.view.textclassifier.TextLinks.TextLink

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

Summary

Inherited constants

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<TextLinks.TextLink>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`float`	`getConfidenceScore(String entityType)` Returns the confidence score for a particular entity type.
`int`	`getEnd()` Returns the end index of this link in the original text.
`String`	`getEntity(int index)` Returns the entity type at a given index.
`int`	`getEntityCount()` Returns the number of entity types that have confidence scores.
`Bundle`	`getExtras()` Returns a bundle containing custom data related to this TextLink.
`int`	`getStart()` Returns the start index of this link in the original text.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

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 28

public static final Creator<TextLinks.TextLink> CREATOR

Public methods

describeContents

Added in API level 28

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(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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`

getConfidenceScore

Added in API level 28

public float getConfidenceScore (String entityType)

Returns the confidence score for a particular entity type.

Parameters

Parameters
`entityType`	`String`: the entity type. Value is one of the following: `TextClassifier.TYPE_UNKNOWN` `TextClassifier.TYPE_OTHER` `TextClassifier.TYPE_EMAIL` `TextClassifier.TYPE_PHONE` `TextClassifier.TYPE_ADDRESS` `TextClassifier.TYPE_URL` `TextClassifier.TYPE_DATE` `TextClassifier.TYPE_DATE_TIME` `TextClassifier.TYPE_FLIGHT_NUMBER` `TextClassifier.TYPE_OTP` `TextClassifier.TYPE_SMS_RETRIEVER_OTP` `TextClassifier.TYPE_SMS_WEB_OTP`

entityType

String: the entity type.
Value is one of the following:

Returns
`float`	Value is between 0.0f and 1.0f inclusive

getEnd

Added in API level 28

public int getEnd ()

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

Returns
`int`	the end index

getEntity

Added in API level 28

public String getEntity (int index)

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

Parameters
`index`	`int`

Returns

Returns
`String`	the entity type at the provided index. This value cannot be `null`. Value is one of the following: `TextClassifier.TYPE_UNKNOWN` `TextClassifier.TYPE_OTHER` `TextClassifier.TYPE_EMAIL` `TextClassifier.TYPE_PHONE` `TextClassifier.TYPE_ADDRESS` `TextClassifier.TYPE_URL` `TextClassifier.TYPE_DATE` `TextClassifier.TYPE_DATE_TIME` `TextClassifier.TYPE_FLIGHT_NUMBER` `TextClassifier.TYPE_OTP` `TextClassifier.TYPE_SMS_RETRIEVER_OTP` `TextClassifier.TYPE_SMS_WEB_OTP`

String

the entity type at the provided index.
This value cannot be null.
Value is one of the following:

getEntityCount

Added in API level 28

public int getEntityCount ()

Returns the number of entity types that have confidence scores.

Returns
`int`	the entity count

getExtras

Added in API level 29

public Bundle getExtras ()

Returns a bundle containing custom data related to this TextLink.

Returns
`Bundle`	This value cannot be `null`.

getStart

Added in API level 28

public int getStart ()

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

Returns
`int`	the start index

toString

Added in API level 28

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 28

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 the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

TextLinks.TextLink

Summary

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getConfidenceScore

getEnd

getEntity

getEntityCount

getExtras

getStart

toString

writeToParcel

More Android

Discover

Android Devices

Releases

Documentation and Downloads

Support