TextClassification.Request

Artifact: androidx.textclassifier:textclassifier

Kotlin |Java

class TextClassification.Request

A request object for generating TextClassification.

Summary

Nested types
`class TextClassification.Request.Builder` This class is deprecated. Use `android.view.textclassifier.TextClassification.Builder` instead.

Nested types

class TextClassification.Request.Builder

This class is deprecated.

Use android.view.textclassifier.TextClassification.Builder instead.

Public functions
`java-static TextClassification.Request!`	`createFromBundle(bundle: Bundle)` Extracts a Request from a bundle that was added using `toBundle`.
`LocaleListCompat?`	`getDefaultLocales()`
`@IntRange(from = 0) Int`	`getEndIndex()` Returns end index of the text to classify.
`Bundle`	`getExtras()` Returns the extended, vendor specific data.
`Long?`	`getReferenceTime()`
`@IntRange(from = 0) Int`	`getStartIndex()` Returns start index of the text to classify.
`CharSequence`	`getText()` Returns the text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex)
`Bundle`	`toBundle()` Adds this Request to a Bundle that can be read back with the same parameters to `createFromBundle`.

Public functions

createFromBundle

java-static fun createFromBundle(bundle: Bundle): TextClassification.Request!

Extracts a Request from a bundle that was added using toBundle.

getDefaultLocales

fun getDefaultLocales(): LocaleListCompat?

Returns
`LocaleListCompat?`	ordered list of locale preferences that can be used to disambiguate the provided text.

getEndIndex

fun getEndIndex(): @IntRange(from = 0) Int

Returns end index of the text to classify.

getExtras

fun getExtras(): Bundle

Returns the extended, vendor specific data.

NOTE: Each call to this method returns a new bundle copy so clients should prefer to hold a reference to the returned bundle rather than frequently calling this method. Avoid updating the content of this bundle. On pre-O devices, the values in the Bundle are not deep copied.

getReferenceTime

fun getReferenceTime(): Long?

Returns
`Long?`	reference time based on which relative dates (e.g. "tomorrow") should be interpreted. This should be milliseconds from the epoch of 1970-01-01T00:00:00Z(UTC timezone).

getStartIndex

fun getStartIndex(): @IntRange(from = 0) Int

Returns start index of the text to classify.

getText

fun getText(): CharSequence

Returns the text providing context for the text to classify (which is specified by the sub sequence starting at startIndex and ending at endIndex)

toBundle

fun toBundle(): Bundle

Adds this Request to a Bundle that can be read back with the same parameters to createFromBundle.