TextClassification.Request.Builder

public static final class TextClassification.Request.Builder
extends Object

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


A builder for building TextClassification requests.

Summary

Public constructors

TextClassification.Request.Builder(CharSequence text, int startIndex, int endIndex)

Public methods

TextClassification.Request build()

Builds and returns the request object.

TextClassification.Request.Builder setDefaultLocales(LocaleListCompat defaultLocales)
TextClassification.Request.Builder setExtras(Bundle extras)

Sets the extended, vendor specific data.

TextClassification.Request.Builder setReferenceTime(Long referenceTime)

Inherited methods

Public constructors

TextClassification.Request.Builder

public TextClassification.Request.Builder (CharSequence text,
                int startIndex,
                int endIndex)

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

startIndex int: start index of the text to classify

endIndex int: end index of the text to classify

Public methods

build

public TextClassification.Request build ()

Builds and returns the request object.

Returns
TextClassification.Request

setDefaultLocales

public TextClassification.Request.Builder setDefaultLocales (LocaleListCompat defaultLocales)

Parameters
defaultLocales LocaleListCompat: ordered list of locale preferences that may be used to disambiguate the provided text. If no locale preferences exist, set this to null or an empty locale list.

Returns
TextClassification.Request.Builder this builder

setExtras

public TextClassification.Request.Builder setExtras (Bundle extras)

Sets the extended, vendor specific data.

Parameters
extras Bundle

Returns
TextClassification.Request.Builder this builder

setReferenceTime

public TextClassification.Request.Builder setReferenceTime (Long referenceTime)

Parameters
referenceTime Long: reference time based on which relative dates (e.g. "tomorrow") should be interpreted. This should usually be the time when the text was originally composed and should be milliseconds from the epoch of 1970-01-01T00:00:00Z(UTC timezone). For example, if there is a message saying "see you 10 days later", and the message was composed yesterday, text classifier will then realize it is indeed means 9 days later from now and classify the text accordingly. If no reference time is set, now is used.

Returns
TextClassification.Request.Builder this builder