ComplicationSlot.Builder

public final class ComplicationSlot.Builder


Builder for constructing ComplicationSlots.

Summary

Public methods

final @NonNull ComplicationSlot

Constructs the ComplicationSlot.

final @NonNull ComplicationSlot.Builder
setAccessibilityTraversalIndex(int accessibilityTraversalIndex)

Sets the initial value used to sort Complications when generating accessibility content description labels.

final @NonNull ComplicationSlot.Builder

Sets optional extras to be merged into the Intent sent when invoking the complication data source chooser activity.

final @NonNull ComplicationSlot.Builder
setDefaultDataSourceType(
    @NonNull ComplicationType defaultDataSourceType
)

This method is deprecated. Instead set DefaultComplicationDataSourcePolicy.systemDataSourceFallbackDefaultType.

final @NonNull ComplicationSlot.Builder
setEnabled(boolean enabled)

Whether the complication is initially enabled or not (by default its enabled).

final @NonNull ComplicationSlot.Builder
setFixedComplicationDataSource(boolean fixedComplicationDataSource)

Whether or not the complication source is fixed (i.e. the user can't change it).

final @NonNull ComplicationSlot.Builder
setNameResourceId(Integer nameResourceId)

If non-null sets the ID of a string resource containing the name of this complication slot, for use visually in an editor.

final @NonNull ComplicationSlot.Builder
setScreenReaderNameResourceId(Integer screenReaderNameResourceId)

If non-null sets the ID of a string resource containing the name of this complication slot, for use by a screen reader.

Public methods

build

Added in 1.0.0
public final @NonNull ComplicationSlot build()

Constructs the ComplicationSlot.

setAccessibilityTraversalIndex

Added in 1.0.0
public final @NonNull ComplicationSlot.Builder setAccessibilityTraversalIndex(int accessibilityTraversalIndex)

Sets the initial value used to sort Complications when generating accessibility content description labels. By default this is id.

setConfigExtras

Added in 1.0.0
public final @NonNull ComplicationSlot.Builder setConfigExtras(@NonNull Bundle extras)

Sets optional extras to be merged into the Intent sent when invoking the complication data source chooser activity.

setDefaultDataSourceType

Added in 1.0.0
Deprecated in 1.1.0
public final @NonNull ComplicationSlot.Builder setDefaultDataSourceType(
    @NonNull ComplicationType defaultDataSourceType
)

Sets the initial ComplicationType to use with the initial complication data source. Note care should be taken to ensure defaultDataSourceType is compatible with the DefaultComplicationDataSourcePolicy.

setEnabled

Added in 1.0.0
public final @NonNull ComplicationSlot.Builder setEnabled(boolean enabled)

Whether the complication is initially enabled or not (by default its enabled). This can be overridden by ComplicationSlotsUserStyleSetting.

setFixedComplicationDataSource

Added in 1.0.0
public final @NonNull ComplicationSlot.Builder setFixedComplicationDataSource(boolean fixedComplicationDataSource)

Whether or not the complication source is fixed (i.e. the user can't change it).

setNameResourceId

Added in 1.1.0
public final @NonNull ComplicationSlot.Builder setNameResourceId(Integer nameResourceId)

If non-null sets the ID of a string resource containing the name of this complication slot, for use visually in an editor. This resource should be short and should not contain the word "Complication". E.g. "Left" for the left complication.

setScreenReaderNameResourceId

Added in 1.1.0
public final @NonNull ComplicationSlot.Builder setScreenReaderNameResourceId(Integer screenReaderNameResourceId)

If non-null sets the ID of a string resource containing the name of this complication slot, for use by a screen reader. This resource should be a short sentence. E.g. "Left complication" for the left complication.