TextLinksParams.Builder
public
static
final
class
TextLinksParams.Builder
extends Object
java.lang.Object | |
↳ | androidx.textclassifier.TextLinksParams.Builder |
A builder for building TextLinksParams.
Summary
Public constructors | |
---|---|
Builder()
|
Public methods | |
---|---|
TextLinksParams
|
build()
Builds and returns a TextLinksParams object. |
TextLinksParams.Builder
|
setApplyStrategy(int applyStrategy)
Sets the apply strategy used to determine how to apply links to text. |
TextLinksParams.Builder
|
setDefaultLocales(LocaleListCompat defaultLocales)
|
TextLinksParams.Builder
|
setEntityConfig(TextClassifier.EntityConfig entityConfig)
Sets the entity configuration to use. |
TextLinksParams.Builder
|
setReferenceTime(Long referenceTime)
|
TextLinksParams.Builder
|
setSpanFactory(TextLinks.SpanFactory spanFactory)
Sets a custom span factory for converting TextLinks to |
Inherited methods | |
---|---|
Public constructors
Builder
public Builder ()
Public methods
build
public TextLinksParams build ()
Builds and returns a TextLinksParams object.
Returns | |
---|---|
TextLinksParams |
setApplyStrategy
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
Parameters | |
---|---|
applyStrategy |
int |
Returns | |
---|---|
TextLinksParams.Builder |
this builder |
setDefaultLocales
public TextLinksParams.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 | |
---|---|
TextLinksParams.Builder |
this builder |
setEntityConfig
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.
Parameters | |
---|---|
entityConfig |
TextClassifier.EntityConfig |
Returns | |
---|---|
TextLinksParams.Builder |
this builder |
setReferenceTime
public TextLinksParams.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 is set, now is used. |
Returns | |
---|---|
TextLinksParams.Builder |
this builder |
setSpanFactory
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.
Parameters | |
---|---|
spanFactory |
TextLinks.SpanFactory |
Returns | |
---|---|
TextLinksParams.Builder |
this builder |