Register now for Android Dev Summit 2019!

Builder

class Builder
kotlin.Any
   ↳ androidx.textclassifier.TextLinksParams.Builder

A builder for building TextLinksParams.

Summary

Public constructors

A builder for building TextLinksParams.

Public methods

TextLinksParams

Builds and returns a TextLinksParams object.

TextLinksParams.Builder
setApplyStrategy(applyStrategy: Int)

Sets the apply strategy used to determine how to apply links to text.

TextLinksParams.Builder
setDefaultLocales(@Nullable defaultLocales: LocaleListCompat?)

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

Sets the entity configuration to use.

TextLinksParams.Builder
setReferenceTime(@Nullable referenceTime: Long?)

TextLinksParams.Builder
setSpanFactory(@Nullable spanFactory: TextLinks.SpanFactory?)

Sets a custom span factory for converting TextLinks to TextLinkSpan.

Public constructors

<init>

Builder()

A builder for building TextLinksParams.

Public methods

build

@NonNull fun build(): TextLinksParams

Builds and returns a TextLinksParams object.

setApplyStrategy

@NonNull fun setApplyStrategy(applyStrategy: Int): TextLinksParams.Builder

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

Return
TextLinksParams.Builder: this builder

setDefaultLocales

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

setEntityConfig

@NonNull fun setEntityConfig(@Nullable entityConfig: TextClassifier.EntityConfig?): TextLinksParams.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
TextLinksParams.Builder: this builder

setReferenceTime

@NonNull fun setReferenceTime(@Nullable referenceTime: Long?): TextLinksParams.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 is set, now is used.
Return
TextLinksParams.Builder: this builder

setSpanFactory

@NonNull fun setSpanFactory(@Nullable spanFactory: TextLinks.SpanFactory?): TextLinksParams.Builder

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

Return
TextLinksParams.Builder: this builder