TextLinksParams.Builder

Artifact: androidx.textclassifier:textclassifier

Kotlin |Java

public final class TextLinksParams.Builder

A builder for building TextLinksParams.

Summary

Public constructors
`Builder()`

Public methods
`@NonNull TextLinksParams`	`build()` Builds and returns a TextLinksParams object.
`@NonNull TextLinksParams.Builder`	`setApplyStrategy(int applyStrategy)` Sets the apply strategy used to determine how to apply links to text. e.g `APPLY_STRATEGY_IGNORE`
`@NonNull TextLinksParams.Builder`	`setDefaultLocales(@Nullable LocaleListCompat defaultLocales)`
`@NonNull TextLinksParams.Builder`	`setEntityConfig(@Nullable TextClassifier.EntityConfig entityConfig)` Sets the entity configuration to use.
`@NonNull TextLinksParams.Builder`	`setReferenceTime(@Nullable Long referenceTime)`
`@NonNull TextLinksParams.Builder`	`setSpanFactory(@Nullable TextLinks.SpanFactory spanFactory)` Sets a custom span factory for converting TextLinks to `TextLinkSpan`.

Public constructors

Builder

public Builder()

Public methods

build

public @NonNull TextLinksParams build()

Builds and returns a TextLinksParams object.

setApplyStrategy

public @NonNull TextLinksParams.Builder setApplyStrategy(int applyStrategy)

Sets the apply strategy used to determine how to apply links to text. e.g APPLY_STRATEGY_IGNORE

Returns
`@NonNull TextLinksParams.Builder`	this builder

setDefaultLocales

public @NonNull TextLinksParams.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 TextLinksParams.Builder`	this builder

setEntityConfig

public @NonNull TextLinksParams.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 TextLinksParams.Builder`	this builder

setReferenceTime

public @NonNull TextLinksParams.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 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 is set, now is used.

Returns
`@NonNull TextLinksParams.Builder`	this builder

setSpanFactory

public @NonNull TextLinksParams.Builder setSpanFactory(@Nullable TextLinks.SpanFactory spanFactory)

Sets a custom span factory for converting TextLinks to TextLinkSpan. Set to null to use the default span factory.

Returns
`@NonNull TextLinksParams.Builder`	this builder