public final class

TextLinksParams.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.textclassifier.TextLinksParams.Builder

Overview

A builder for building TextLinksParams.

Summary

Constructors
publicBuilder()

Methods
public TextLinksParamsbuild()

Builds and returns a TextLinksParams object.

public TextLinksParams.BuildersetApplyStrategy(int applyStrategy)

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

public TextLinksParams.BuildersetDefaultLocales(LocaleListCompat defaultLocales)

public TextLinksParams.BuildersetEntityConfig(TextClassifier.EntityConfig entityConfig)

Sets the entity configuration to use.

public TextLinksParams.BuildersetReferenceTime(java.lang.Long referenceTime)

public TextLinksParams.BuildersetSpanFactory(TextLinks.SpanFactory spanFactory)

Sets a custom span factory for converting TextLinks to TextLinks.TextLinkSpan.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Methods

public TextLinksParams.Builder setApplyStrategy(int applyStrategy)

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

Returns:

this builder

public TextLinksParams.Builder setSpanFactory(TextLinks.SpanFactory spanFactory)

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

Returns:

this builder

public TextLinksParams.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.

Returns:

this builder

public TextLinksParams.Builder setDefaultLocales(LocaleListCompat defaultLocales)

Parameters:

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:

this builder

public TextLinksParams.Builder setReferenceTime(java.lang.Long referenceTime)

Parameters:

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:

this builder

public TextLinksParams build()

Builds and returns a TextLinksParams object.