TextClassifier

EXTRA_FROM_TEXT_CLASSIFIER

static val EXTRA_FROM_TEXT_CLASSIFIER: String

Extra that is included on activity intents coming from a TextClassifier when it suggests actions to its caller.

All TextClassifier implementations should make sure this extra exists in their generated intents.

Value: "android.view.textclassifier.extra.FROM_TEXT_CLASSIFIER"

HINT_TEXT_IS_EDITABLE

static val HINT_TEXT_IS_EDITABLE: String

Designates that the text in question is editable. *

Value: "android.text_is_editable"

HINT_TEXT_IS_NOT_EDITABLE

static val HINT_TEXT_IS_NOT_EDITABLE: String

Designates that the text in question is not editable. *

Value: "android.text_is_not_editable"

TYPE_ADDRESS

static val TYPE_ADDRESS: String

Physical address.

Value: "address"

TYPE_DATE

static val TYPE_DATE: String

Time reference that is no more specific than a date. May be absolute such as "01/01/2000" or relative like "tomorrow". *

Value: "date"

TYPE_DATE_TIME

static val TYPE_DATE_TIME: String

Time reference that includes a specific time. May be absolute such as "01/01/2000 5:30pm" or relative like "tomorrow at 5:30pm". *

Value: "datetime"

TYPE_EMAIL

static val TYPE_EMAIL: String

E-mail address (e.g. "noreply@android.com").

Value: "email"

TYPE_FLIGHT_NUMBER

static val TYPE_FLIGHT_NUMBER: String

Flight number in IATA format.

Value: "flight"

TYPE_OTHER

static val TYPE_OTHER: String

The classifier ran, but didn't recognize a known entity.

Value: "other"

TYPE_PHONE

static val TYPE_PHONE: String

Phone number (e.g. "555-123 456").

Value: "phone"

TYPE_UNKNOWN

static val TYPE_UNKNOWN: String

The TextClassifier failed to run.

Value: ""

TYPE_URL

static val TYPE_URL: String

Web URL.

Value: "url"

WIDGET_TYPE_CLIPBOARD

static val WIDGET_TYPE_CLIPBOARD: String

The text classification context is for use with the system clipboard.

Value: "clipboard"

WIDGET_TYPE_CUSTOM_EDITTEXT

static val WIDGET_TYPE_CUSTOM_EDITTEXT: String

The widget involved in the text classification context is a custom editable text widget.

Value: "customedit"

WIDGET_TYPE_CUSTOM_TEXTVIEW

static val WIDGET_TYPE_CUSTOM_TEXTVIEW: String

The widget involved in the text classification context is a custom text widget.

Value: "customview"

WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW

static val WIDGET_TYPE_CUSTOM_UNSELECTABLE_TEXTVIEW: String

The widget involved in the text classification context is a custom non-selectable text widget.

Value: "nosel-customview"

WIDGET_TYPE_EDITTEXT

static val WIDGET_TYPE_EDITTEXT: String

The widget involved in the text classification context is a standard android.widget.EditText.

Value: "edittext"

WIDGET_TYPE_EDIT_WEBVIEW

static val WIDGET_TYPE_EDIT_WEBVIEW: String

The widget involved in the text classification context is a standard editable android.webkit.WebView.

Value: "edit-webview"

WIDGET_TYPE_NOTIFICATION

static val WIDGET_TYPE_NOTIFICATION: String

The widget involved in the text classification context is a notification

Value: "notification"

WIDGET_TYPE_TEXTVIEW

static val WIDGET_TYPE_TEXTVIEW: String

The widget involved in the text classification context is a standard android.widget.TextView.

Value: "textview"

WIDGET_TYPE_UNKNOWN

static val WIDGET_TYPE_UNKNOWN: String

The widget involved in the text classification context is of an unknown/unspecified type.

Value: "unknown"

WIDGET_TYPE_UNSELECTABLE_TEXTVIEW

static val WIDGET_TYPE_UNSELECTABLE_TEXTVIEW: String

The widget involved in the text classification context is a standard non-selectable android.widget.TextView.

Value: "nosel-textview"

WIDGET_TYPE_WEBVIEW

static val WIDGET_TYPE_WEBVIEW: String

The widget involved in the text classification context is a standard android.webkit.WebView.

Value: "webview"

classifyText

open fun classifyText(request: TextClassification.Request): TextClassification

Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text.

NOTE: Call on a worker thread.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

classifyText

open fun classifyText(
    text: CharSequence, 
    startIndex: Int, 
    endIndex: Int, 
    defaultLocales: LocaleList?
): TextClassification

Classifies the specified text and returns a TextClassification object that can be used to generate a widget for handling the classified text.

NOTE: Call on a worker thread.

NOTE: Do not implement. The default implementation of this method calls classifyText(android.view.textclassifier.TextClassification.Request). If that method calls this method, a stack overflow error will happen.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

destroy

open fun destroy(): Unit

Destroys this TextClassifier.

NOTE: If a TextClassifier has been destroyed, calls to its methods should throw an IllegalStateException. See isDestroyed().

Subsequent calls to this method are no-ops.

detectLanguage

open fun detectLanguage(request: TextLanguage.Request): TextLanguage

Detects the language of the text in the given request.

NOTE: Call on a worker thread.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

generateLinks

open fun generateLinks(request: TextLinks.Request): TextLinks

Generates and returns a TextLinks that may be applied to the text to annotate it with links information.

NOTE: Call on a worker thread.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

getMaxGenerateLinksTextLength

open fun getMaxGenerateLinksTextLength(): Int

Returns the maximal length of text that can be processed by generateLinks.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

isDestroyed

open fun isDestroyed(): Boolean

Returns whether or not this TextClassifier has been destroyed.

NOTE: If a TextClassifier has been destroyed, caller should not interact with the classifier and an attempt to do so would throw an IllegalStateException. However, this method should never throw an IllegalStateException.

onSelectionEvent

open fun onSelectionEvent(event: SelectionEvent): Unit

NOTE: Use onTextClassifierEvent(android.view.textclassifier.TextClassifierEvent) instead.

Reports a selection event.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().

onTextClassifierEvent

open fun onTextClassifierEvent(event: TextClassifierEvent): Unit

Reports a text classifier event.

NOTE: Call on a worker thread.

suggestConversationActions

open fun suggestConversationActions(request: ConversationActions.Request): ConversationActions

Suggests and returns a list of actions according to the given conversation.
This method may take several seconds to complete, so it should only be called from a worker thread.

suggestSelection

open fun suggestSelection(request: TextSelection.Request): TextSelection

Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. The entity types are ordered from highest to lowest scoring.

NOTE: Call on a worker thread.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().
This method may take several seconds to complete, so it should only be called from a worker thread.

suggestSelection

open fun suggestSelection(
    text: CharSequence, 
    selectionStartIndex: Int, 
    selectionEndIndex: Int, 
    defaultLocales: LocaleList?
): TextSelection

Returns suggested text selection start and end indices, recognized entity types, and their associated confidence scores. The entity types are ordered from highest to lowest scoring.

NOTE: Call on a worker thread.

NOTE: If a TextClassifier has been destroyed, calls to this method should throw an IllegalStateException. See isDestroyed().

NOTE: Do not implement. The default implementation of this method calls suggestSelection(android.view.textclassifier.TextSelection.Request). If that method calls this method, a stack overflow error will happen.
This method may take several seconds to complete, so it should only be called from a worker thread.

NO_OP

static val NO_OP: TextClassifier!

No-op TextClassifier. This may be used to turn off TextClassifier features.