Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

TextLinks.Request.Builder

public static final class TextLinks.Request.Builder
extends Object

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


A builder for building TextLinks requests.

Summary

Public constructors

TextLinks.Request.Builder(CharSequence text)

Public methods

TextLinks.Request build()

Builds and returns the request object.

TextLinks.Request.Builder setDefaultLocales(LocaleListCompat defaultLocales)
TextLinks.Request.Builder setEntityConfig(TextClassifier.EntityConfig entityConfig)

Sets the entity configuration to use.

TextLinks.Request.Builder setExtras(Bundle extras)

Sets the extended, vendor specific data.

TextLinks.Request.Builder setReferenceTime(Long referenceTime)

Inherited methods

Public constructors

TextLinks.Request.Builder

public TextLinks.Request.Builder (CharSequence text)

Parameters
text CharSequence

Public methods

build

public TextLinks.Request build ()

Builds and returns the request object.

Returns
TextLinks.Request

setDefaultLocales

public TextLinks.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
TextLinks.Request.Builder this builder

setEntityConfig

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

Returns
TextLinks.Request.Builder this builder

setExtras

public TextLinks.Request.Builder setExtras (Bundle extras)

Sets the extended, vendor specific data.

Parameters
extras Bundle

Returns
TextLinks.Request.Builder

setReferenceTime

public TextLinks.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 generate a link accordingly. If no reference time or null is set, now is used.

Returns
TextLinks.Request.Builder this builder