Builder

class Builder
kotlin.Any
   ↳ androidx.textclassifier.TextLinks.Request.Builder

A builder for building TextLinks requests.

Summary

Public constructors

<init>(@NonNull text: CharSequence)

Public methods

TextLinks.Request

Builds and returns the request object.

TextLinks.Request.Builder
setDefaultLocales(@Nullable defaultLocales: LocaleListCompat?)

TextLinks.Request.Builder
setEntityConfig(@Nullable entityConfig: TextClassifier.EntityConfig?)

Sets the entity configuration to use.

TextLinks.Request.Builder
setExtras(@Nullable extras: Bundle?)

Sets the extended, vendor specific data.

TextLinks.Request.Builder
setReferenceTime(@Nullable referenceTime: Long?)

Public constructors

<init>

Builder(@NonNull text: CharSequence)

Public methods

build

@NonNull fun build(): TextLinks.Request

Builds and returns the request object.

setDefaultLocales

@NonNull fun setDefaultLocales(@Nullable defaultLocales: LocaleListCompat?): TextLinks.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
TextLinks.Request.Builder: this builder

setEntityConfig

@NonNull fun setEntityConfig(@Nullable entityConfig: TextClassifier.EntityConfig?): TextLinks.Request.Builder

Sets the entity configuration to use. This determines what types of entities the TextClassifier will look for. Set to null for the default entity config and the TextClassifier will automatically determine what links to generate.

Return
TextLinks.Request.Builder: this builder

setExtras

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

Sets the extended, vendor specific data.

setReferenceTime

@NonNull fun setReferenceTime(@Nullable referenceTime: Long?): TextLinks.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 generate a link accordingly. If no reference time or null is set, now is used.
Return
TextLinks.Request.Builder: this builder