TextLink

Kotlin |Java

class TextLink : Parcelable

kotlin.Any
↳	android.view.textclassifier.TextLinks.TextLink

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

Summary

Inherited constants

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	`describeContents()`
Float	`getConfidenceScore(entityType: String!)` Returns the confidence score for a particular entity type.
Int	`getEnd()` Returns the end index of this link in the original text.
String	`getEntity(index: Int)` 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()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<TextLinks.TextLink!>	`CREATOR`

Public methods

describeContents

Added in API level 28

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getConfidenceScore

Added in API level 28

fun getConfidenceScore(entityType: String!): Float

Returns the confidence score for a particular entity type.

Parameters

entityType String!: the entity type Value is android.view.textclassifier.TextClassifier#TYPE_UNKNOWN, android.view.textclassifier.TextClassifier#TYPE_OTHER, android.view.textclassifier.TextClassifier#TYPE_EMAIL, android.view.textclassifier.TextClassifier#TYPE_PHONE, android.view.textclassifier.TextClassifier#TYPE_ADDRESS, android.view.textclassifier.TextClassifier#TYPE_URL, android.view.textclassifier.TextClassifier#TYPE_DATE, android.view.textclassifier.TextClassifier#TYPE_DATE_TIME, android.view.textclassifier.TextClassifier#TYPE_FLIGHT_NUMBER, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, or android.view.textclassifier.TextClassifier.TYPE_OTP

Parameters
`entityType`	String!: the entity type Value is `android.view.textclassifier.TextClassifier#TYPE_UNKNOWN`, `android.view.textclassifier.TextClassifier#TYPE_OTHER`, `android.view.textclassifier.TextClassifier#TYPE_EMAIL`, `android.view.textclassifier.TextClassifier#TYPE_PHONE`, `android.view.textclassifier.TextClassifier#TYPE_ADDRESS`, `android.view.textclassifier.TextClassifier#TYPE_URL`, `android.view.textclassifier.TextClassifier#TYPE_DATE`, `android.view.textclassifier.TextClassifier#TYPE_DATE_TIME`, `android.view.textclassifier.TextClassifier#TYPE_FLIGHT_NUMBER`, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, or android.view.textclassifier.TextClassifier.TYPE_OTP

Return
`Float`	Value is between 0.0 and 1.0 inclusive

getEnd

Added in API level 28

fun getEnd(): Int

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

Return
`Int`	the end index

getEntity

Added in API level 28

fun getEntity(index: Int): String

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

Return

String the entity type at the provided index This value cannot be null. Value is android.view.textclassifier.TextClassifier#TYPE_UNKNOWN, android.view.textclassifier.TextClassifier#TYPE_OTHER, android.view.textclassifier.TextClassifier#TYPE_EMAIL, android.view.textclassifier.TextClassifier#TYPE_PHONE, android.view.textclassifier.TextClassifier#TYPE_ADDRESS, android.view.textclassifier.TextClassifier#TYPE_URL, android.view.textclassifier.TextClassifier#TYPE_DATE, android.view.textclassifier.TextClassifier#TYPE_DATE_TIME, android.view.textclassifier.TextClassifier#TYPE_FLIGHT_NUMBER, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, or android.view.textclassifier.TextClassifier.TYPE_OTP

Return
`String`	the entity type at the provided index This value cannot be `null`. Value is `android.view.textclassifier.TextClassifier#TYPE_UNKNOWN`, `android.view.textclassifier.TextClassifier#TYPE_OTHER`, `android.view.textclassifier.TextClassifier#TYPE_EMAIL`, `android.view.textclassifier.TextClassifier#TYPE_PHONE`, `android.view.textclassifier.TextClassifier#TYPE_ADDRESS`, `android.view.textclassifier.TextClassifier#TYPE_URL`, `android.view.textclassifier.TextClassifier#TYPE_DATE`, `android.view.textclassifier.TextClassifier#TYPE_DATE_TIME`, `android.view.textclassifier.TextClassifier#TYPE_FLIGHT_NUMBER`, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, or android.view.textclassifier.TextClassifier.TYPE_OTP

getEntityCount

Added in API level 28

fun getEntityCount(): Int

Returns the number of entity types that have confidence scores.

Return
`Int`	the entity count

getExtras

Added in API level 29

fun getExtras(): Bundle

Returns a bundle containing custom data related to this TextLink.

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

getStart

Added in API level 28

fun getStart(): Int

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

Return
`Int`	the start index

toString

Added in API level 28

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 28

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 28

static val CREATOR: Parcelable.Creator<TextLinks.TextLink!>