Builder

Kotlin |Java

class Builder

kotlin.Any
↳	androidx.textclassifier.TextClassification.Request.Builder

A builder for building TextClassification requests.

Summary

Public constructors
<init>(@NonNull text: CharSequence, @IntRange(0) startIndex: Int, @IntRange(0) endIndex: Int)

Public methods
TextClassification.Request	build() Builds and returns the request object.
TextClassification.Request.Builder	setDefaultLocales(@Nullable defaultLocales: LocaleListCompat?)
TextClassification.Request.Builder	setExtras(@Nullable extras: Bundle?) Sets the extended, vendor specific data.
TextClassification.Request.Builder	setReferenceTime(@Nullable referenceTime: Long?)

Public constructors

<init>

Builder(
    @NonNull text: CharSequence, 
    @IntRange(0) startIndex: Int, 
    @IntRange(0) endIndex: Int)

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

@NonNull fun build(): TextClassification.Request

Builds and returns the request object.

setDefaultLocales

@NonNull fun setDefaultLocales(@Nullable defaultLocales: LocaleListCompat?): TextClassification.Request.Builder

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.

Return
TextClassification.Request.Builder	this builder

setExtras

@NonNull fun setExtras(@Nullable extras: Bundle?): TextClassification.Request.Builder

Sets the extended, vendor specific data.

Return
TextClassification.Request.Builder	this builder

setReferenceTime

@NonNull fun setReferenceTime(@Nullable referenceTime: Long?): TextClassification.Request.Builder

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.

Return
TextClassification.Request.Builder	this builder