TextClassification.Request

public static final class TextClassification.Request
extends Object

java.lang.Object
   ↳ androidx.textclassifier.TextClassification.Request

A request object for generating TextClassification.

Summary

Nested classes

class TextClassification.Request.Builder

A builder for building TextClassification requests. 

Public methods

static TextClassification.Request createFromBundle(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).

Inherited methods

Public methods

createFromBundle

public static TextClassification.Request createFromBundle (Bundle bundle)

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

Parameters
bundle Bundle

Returns
TextClassification.Request

getDefaultLocales

public LocaleListCompat getDefaultLocales ()

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

getEndIndex

public int getEndIndex ()

Returns end index of the text to classify.

Returns
int

getExtras

public Bundle getExtras ()

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.

Returns
Bundle

getReferenceTime

public Long getReferenceTime ()

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

public int getStartIndex ()

Returns start index of the text to classify.

Returns
int

getText

public 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)

Returns
CharSequence

toBundle

public Bundle toBundle ()

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

Returns
Bundle