Request

Kotlin |Java

class Request

kotlin.Any
↳	androidx.textclassifier.TextClassification.Request

A request object for generating TextClassification.

Summary

Nested classes
	`Builder` A builder for building TextClassification requests.

Public methods
static TextClassification.Request!	`createFromBundle(@NonNull bundle: Bundle)` Extracts a Request from a bundle that was added using `toBundle()`.
LocaleListCompat?	`getDefaultLocales()`
Int	`getEndIndex()` Returns end index of the text to classify.
Bundle	`getExtras()` Returns the extended, vendor specific data.
Long?	`getReferenceTime()`
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(Bundle)`.

Public methods

createFromBundle

static fun createFromBundle(@NonNull bundle: Bundle): TextClassification.Request!

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

getDefaultLocales

@Nullable fun getDefaultLocales(): LocaleListCompat?

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

getEndIndex

@IntRange(0) fun getEndIndex(): Int

Returns end index of the text to classify.

getExtras

@NonNull 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

@Nullable fun getReferenceTime(): Long?

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

@IntRange(0) fun getStartIndex(): Int

Returns start index of the text to classify.

getText

@NonNull 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

@NonNull fun toBundle(): Bundle

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