LongTextComplicationData.Builder

public final class LongTextComplicationData.Builder


Builder for LongTextComplicationData.

You must at a minimum set the text and contentDescription fields.

Summary

Public constructors

Builder(
    @NonNull ComplicationText text,
    @NonNull ComplicationText contentDescription
)

Public methods

@NonNull LongTextComplicationData

Builds the LongTextComplicationData.

final @NonNull LongTextComplicationData.Builder

Sets the ComponentName of the ComplicationDataSourceService that provided this ComplicationData, if any.

final @NonNull LongTextComplicationData.Builder
@RequiresApi(value = 33)
setDisplayPolicy(int displayPolicy)

Sets the complication's display policy.

final @NonNull LongTextComplicationData.Builder

Sets the complication's fallback, used in case any dynamic value cannot be evaluated, e.g. when a data source is not available.

final @NonNull LongTextComplicationData.Builder

Sets optional image associated with the complication data.

final @NonNull LongTextComplicationData.Builder
@RequiresApi(value = 33)
setPersistencePolicy(int persistencePolicy)

Sets the complication's persistence policy.

final @NonNull LongTextComplicationData.Builder

Sets optional image associated with the complication data.

final @NonNull LongTextComplicationData.Builder

Sets optional pending intent to be invoked when the complication is tapped.

final @NonNull LongTextComplicationData.Builder

Sets optional title associated with the complication data.

final @NonNull LongTextComplicationData.Builder
setValidTimeRange(TimeRange validTimeRange)

Sets optional time range during which the complication has to be shown.

Public constructors

Builder

Added in 1.0.0
public Builder(
    @NonNull ComplicationText text,
    @NonNull ComplicationText contentDescription
)
Parameters
@NonNull ComplicationText text

Localized main ComplicationText to display within the complication. There isn't an explicit character limit but text may be truncated if too long

@NonNull ComplicationText contentDescription

Defines localized text that briefly describes content of the complication. This property is used primarily for accessibility. Since some complications do not have textual representation this attribute can be used for providing such. Please do not include the word 'complication' in the description.

Public methods

build

Added in 1.0.0
public @NonNull LongTextComplicationData build()

Builds the LongTextComplicationData.

setDataSource

Added in 1.1.0
public final @NonNull LongTextComplicationData.Builder setDataSource(ComponentName dataSource)

Sets the ComponentName of the ComplicationDataSourceService that provided this ComplicationData, if any.

Note a ComplicationDataSourceService does not need to call this because the system will set this value on its behalf.

setDisplayPolicy

Added in 1.2.0
@RequiresApi(value = 33)
public final @NonNull LongTextComplicationData.Builder setDisplayPolicy(int displayPolicy)

Sets the complication's display policy.

setDynamicValueInvalidationFallback

Added in 1.3.0-alpha01
public final @NonNull LongTextComplicationData.Builder setDynamicValueInvalidationFallback(LongTextComplicationData fallback)

Sets the complication's fallback, used in case any dynamic value cannot be evaluated, e.g. when a data source is not available.

IMPORTANT: This is only used when the system supports dynamic values. See each dynamic value field's fallback companion field for the situation where the system does not support dynamic values at all.

setMonochromaticImage

Added in 1.0.0
public final @NonNull LongTextComplicationData.Builder setMonochromaticImage(MonochromaticImage icon)

Sets optional image associated with the complication data.

setPersistencePolicy

Added in 1.2.0
@RequiresApi(value = 33)
public final @NonNull LongTextComplicationData.Builder setPersistencePolicy(int persistencePolicy)

Sets the complication's persistence policy.

setSmallImage

Added in 1.0.0
public final @NonNull LongTextComplicationData.Builder setSmallImage(SmallImage smallImage)

Sets optional image associated with the complication data.

setTapAction

Added in 1.0.0
public final @NonNull LongTextComplicationData.Builder setTapAction(PendingIntent tapAction)

Sets optional pending intent to be invoked when the complication is tapped.

setTitle

Added in 1.0.0
public final @NonNull LongTextComplicationData.Builder setTitle(ComplicationText title)

Sets optional title associated with the complication data.

setValidTimeRange

Added in 1.0.0
public final @NonNull LongTextComplicationData.Builder setValidTimeRange(TimeRange validTimeRange)

Sets optional time range during which the complication has to be shown.