TextLinks.Request.Builder

Artifact: androidx.textclassifier:textclassifier

Kotlin |Java

public final class TextLinks.Request.Builder

A builder for building TextLinks requests.

Summary

Public constructors
`Builder(@NonNull CharSequence text)`

Public methods
`@NonNull TextLinks.Request`	`build()` Builds and returns the request object.
`@NonNull TextLinks.Request.Builder`	`setDefaultLocales(@Nullable LocaleListCompat defaultLocales)`
`@NonNull TextLinks.Request.Builder`	`setEntityConfig(@Nullable TextClassifier.EntityConfig entityConfig)` Sets the entity configuration to use.
`@NonNull TextLinks.Request.Builder`	`setExtras(@Nullable Bundle extras)` Sets the extended, vendor specific data.
`@NonNull TextLinks.Request.Builder`	`setReferenceTime(@Nullable Long referenceTime)`

Public constructors

Builder

public Builder(@NonNull CharSequence text)

Public methods

build

public @NonNull TextLinks.Request build()

Builds and returns the request object.

setDefaultLocales

public @NonNull TextLinks.Request.Builder setDefaultLocales(@Nullable LocaleListCompat defaultLocales)

Parameters
`@Nullable LocaleListCompat defaultLocales`	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
`@NonNull TextLinks.Request.Builder`	this builder

setEntityConfig

public @NonNull TextLinks.Request.Builder setEntityConfig(@Nullable 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.

Returns
`@NonNull TextLinks.Request.Builder`	this builder

setExtras

public @NonNull TextLinks.Request.Builder setExtras(@Nullable Bundle extras)

Sets the extended, vendor specific data.

setReferenceTime

public @NonNull TextLinks.Request.Builder setReferenceTime(@Nullable Long referenceTime)

Parameters

Parameters
`@Nullable Long referenceTime`	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.

@Nullable Long referenceTime

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
`@NonNull TextLinks.Request.Builder`	this builder