TextLinks.Request.Builder

public static final class TextLinks.Request.Builder
extends Object

java.lang.Object
   ↳ android.view.textclassifier.TextLinks.Request.Builder


A builder for building TextLinks requests.

Summary

Public constructors

Builder(CharSequence text)

Public methods

TextLinks.Request build()

Builds and returns the request object.

TextLinks.Request.Builder setDefaultLocales(LocaleList defaultLocales)

Sets ordered list of locale preferences that may be used to disambiguate the provided text.

TextLinks.Request.Builder setEntityConfig(TextClassifier.EntityConfig entityConfig)

Sets the entity configuration to use.

TextLinks.Request.Builder setExtras(Bundle extras)

Sets the extended data.

TextLinks.Request.Builder setReferenceTime(ZonedDateTime referenceTime)

Sets the reference time based on which relative dates (e.g.

Inherited methods

Public constructors

Builder

Added in API level 28
public Builder (CharSequence text)

Parameters
text CharSequence: This value cannot be null.

Public methods

build

Added in API level 28
public TextLinks.Request build ()

Builds and returns the request object.

Returns
TextLinks.Request This value cannot be null.

setDefaultLocales

Added in API level 28
public TextLinks.Request.Builder setDefaultLocales (LocaleList defaultLocales)

Sets ordered list of locale preferences that may be used to disambiguate the provided text.

Parameters
defaultLocales LocaleList: 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
TextLinks.Request.Builder this builder This value cannot be null.

setEntityConfig

Added in API level 28
public TextLinks.Request.Builder setEntityConfig (TextClassifier.EntityConfig entityConfig)

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.

Parameters
entityConfig TextClassifier.EntityConfig: This value may be null.

Returns
TextLinks.Request.Builder this builder

setExtras

Added in API level 29
public TextLinks.Request.Builder setExtras (Bundle extras)

Sets the extended data.

Parameters
extras Bundle: This value may be null.

Returns
TextLinks.Request.Builder this builder

setReferenceTime

Added in API level 30
public TextLinks.Request.Builder setReferenceTime (ZonedDateTime referenceTime)

Sets the reference time based on which relative dates (e.g. "tomorrow") should be interpreted.

Parameters
referenceTime ZonedDateTime: reference time based on which relative dates. This should usually be the time when the text was originally composed. This value may be null.

Returns
TextLinks.Request.Builder this builder This value cannot be null.