PhotoImageComplicationData.Builder


class PhotoImageComplicationData.Builder


Builder for PhotoImageComplicationData.

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

Summary

Public constructors

Builder(photoImage: Icon, contentDescription: ComplicationText)

Public functions

open PhotoImageComplicationData

Builds the PhotoImageComplicationData.

PhotoImageComplicationData.Builder

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

PhotoImageComplicationData.Builder
setValidTimeRange(validTimeRange: TimeRange?)

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

Public constructors

Builder

Added in 1.0.0
Builder(photoImage: Icon, contentDescription: ComplicationText)
Parameters
photoImage: Icon

The Icon to be displayed

contentDescription: ComplicationText

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 functions

build

Added in 1.0.0
open fun build(): PhotoImageComplicationData

Builds the PhotoImageComplicationData.

setTapAction

Added in 1.0.0
fun setTapAction(tapAction: PendingIntent?): PhotoImageComplicationData.Builder

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

setValidTimeRange

Added in 1.0.0
fun setValidTimeRange(validTimeRange: TimeRange?): PhotoImageComplicationData.Builder

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