PhotoImageComplicationData.Builder

public final class PhotoImageComplicationData.Builder


Builder for PhotoImageComplicationData.

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

Summary

Public constructors

Builder(
    @NonNull Icon photoImage,
    @NonNull ComplicationText contentDescription
)

Public methods

@NonNull PhotoImageComplicationData

Builds the PhotoImageComplicationData.

final @NonNull PhotoImageComplicationData.Builder

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

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

Sets the complication's display policy.

final @NonNull PhotoImageComplicationData.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 PhotoImageComplicationData.Builder
@RequiresApi(value = 33)
setPersistencePolicy(int persistencePolicy)

Sets the complication's persistence policy.

final @NonNull PhotoImageComplicationData.Builder

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

final @NonNull PhotoImageComplicationData.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 Icon photoImage,
    @NonNull ComplicationText contentDescription
)
Parameters
@NonNull Icon photoImage

The Icon to be displayed

@NonNull ComplicationText contentDescription

The content description field for accessibility and is used to describe what data the image represents. If the image is purely stylistic, and does not convey any information to the user, then provide an empty content description. If no content description is provided, a generic content description will be used instead. Please do not include the word 'complication' in the description.

Public methods

setDataSource

Added in 1.1.0
public final @NonNull PhotoImageComplicationData.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 PhotoImageComplicationData.Builder setDisplayPolicy(int displayPolicy)

Sets the complication's display policy.

setDynamicValueInvalidationFallback

Added in 1.3.0-alpha01
public final @NonNull PhotoImageComplicationData.Builder setDynamicValueInvalidationFallback(
    PhotoImageComplicationData 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.

setPersistencePolicy

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

Sets the complication's persistence policy.

setTapAction

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

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

setValidTimeRange

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

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