ComplicationData

IMAGE_STYLE_ICON

public static final int IMAGE_STYLE_ICON

Style for small images that have a transparent background and are expected to be drawn entirely within the space available, such as a launcher icon. Watch faces may add padding when drawing these images, but should never crop these images. Icons may be recolored to fit the complication style.

Constant Value: 2 (0x00000002)

IMAGE_STYLE_PHOTO

public static final int IMAGE_STYLE_PHOTO

Style for small images which are photos that are expected to fill the space available. Images of this style may be cropped to fit the shape of the complication - in particular, the image may be cropped to a circle. Photos my not be recolored.

This is the default value.

Constant Value: 1 (0x00000001)

CREATOR

public static final Creator<ComplicationData> CREATOR

clearTimelineEndEpochSecond

public void clearTimelineEndEpochSecond ()

Removes the timeline end epoch time, if set, from this ComplicationData.

clearTimelineStartEpochSecond

public void clearTimelineStartEpochSecond ()

Removes the timeline start epoch time, if set, from this ComplicationData.

describeContents

public int describeContents ()

equals

public boolean equals (Object o)

getBurnInProtectionIcon

public Icon getBurnInProtectionIcon ()

Returns the burn-in protection version of the icon field for this complication data, or null if no such icon was provided. The image returned is expected to be an outline image suitable for use in ambient mode on screens with burn-in protection. The image is also expected to be single-color and so may be tinted to whatever color the watch face requires (but note that Drawable.mutate should be called before drawables are tinted, and that the color used should be suitable for ambient mode with burn-in protection).

If the device is in ambient mode, and utilises burn-in protection, then the result of this method must be used instead of the result of getIcon().

Valid for the types ComplicationType.SHORT_TEXT, ComplicationType.LONG_TEXT, ComplicationType.RANGED_VALUE, ComplicationType.MONOCHROMATIC_IMAGE, or ComplicationType.NO_PERMISSION, otherwise returns null.

getBurnInProtectionSmallImage

public Icon getBurnInProtectionSmallImage ()

Returns the burn-in protection version of the small image field for this complication data, or null if no such icon was provided. The image returned is expected to be an outline image suitable for use in ambient mode on screens with burn-in protection. The image is also expected to be single-color and so may be tinted to whatever color the watch face requires (but note that Drawable.mutate should be called before drawables are tinted, and that the color used should be suitable for ambient mode with burn-in protection).

If the device is in ambient mode, and utilises burn-in protection, then the result of this method must be used instead of the result of getSmallImage().

Valid for the types ComplicationType.LONG_TEXT and ComplicationType.SMALL_IMAGE. Otherwise returns null.

getColorRamp

public int[] getColorRamp ()

Returns the colors for the progress bar.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE or ComplicationType.GOAL_PROGRESS. If unset, returns an empty array.

getContentDescription

public ComplicationText getContentDescription ()

Returns the content description field for this complication, for screen readers. This usually describes the image, but may also describe the overall complication.

Valid for all non-empty types.

getDataSource

public ComponentName getDataSource ()

The ComponentName of the ComplicationDataSourceService that provided this ComplicationData.

getDisplayPolicy

public int getDisplayPolicy ()

Returns ComplicationDisplayPolicies.ALWAYS_DISPLAY if not set.

getElementBackgroundColor

public int getElementBackgroundColor ()

Returns the background color to use between elements for this complication.

Valid only if the type of this complication data is ComplicationType.WEIGHTED_ELEMENTS. Otherwise returns 0.

getElementColors

public int[] getElementColors ()

Returns the element colors for this complication.

Valid only if the type of this complication data is ComplicationType.WEIGHTED_ELEMENTS. If unset, returns an empty array.

getElementWeights

public float[] getElementWeights ()

Returns the element weights for this complication.

Valid only if the type of this complication data is ComplicationType.WEIGHTED_ELEMENTS. If unset, returns an empty array.

getEndDateTimeMillis

public long getEndDateTimeMillis ()

Returns the end time for this complication data (i.e. the last time at which it should be considered active and displayed), this may be Long.MAX_VALUE. See also isActiveAtMillis(long).

getExtras

public PersistableBundle getExtras ()

Returns the extras set in this ComplicationData.

If unset, returns an empty bundle.

getIcon

public Icon getIcon ()

Returns the icon field for this complication data, or null if no value was provided for the field. The image returned is expected to be single-color and so may be tinted to whatever color the watch face requires (but note that Drawable.mutate should be called before drawables are tinted).

If the device is in ambient mode, and utilises burn-in protection, then the result of getBurnInProtectionIcon() must be used instead of this.

Valid for the types SHORT_TEXT, LONG_TEXT, RANGED_VALUE, MONOCHROMATIC_IMAGE, or NO_PERMISSION, otherwise returns null.

getInvalidatedData

public ComplicationData getInvalidatedData ()

Returns the invalidated ComplicationData used in COMPLICATION_TYPE_NO_DATA when generated by dynamic value invalidation, or null.

getLargeImage

public Icon getLargeImage ()

Returns the large image field for this complication data. This image is expected to be of a suitable size to fill the screen of the watch.

As this may be any image, it is unlikely to be suitable for display in ambient mode when burn-in protection is enabled, or in low-bit ambient mode, and should not be rendered under these circumstances.

Valid only if the type of this complication data is ComplicationType.LARGE_IMAGE. Otherwise returns null.

getLongText

public ComplicationText getLongText ()

Returns the longText field for this complication data.

The value is provided as a ComplicationText object, from which the text to display can be obtained for a given point in time.

Valid only if the type of this complication data is ComplicationType.LONG_TEXT, otherwise returns null.

getLongTitle

public ComplicationText getLongTitle ()

Returns the long title field for this complication data, or an empty bundle if no value was provided for the field.

The value is provided as a ComplicationText object, from which the text to display can be obtained for a given point in time.

Valid only if the type of this complication data is ComplicationType.LONG_TEXT, otherwise returns null.

getPersistencePolicy

public int getPersistencePolicy ()

Returns ComplicationPersistencePolicies.CACHING_ALLOWED if not set.

getPlaceholder

public ComplicationData getPlaceholder ()

Returns the placeholder ComplicationData if there is one or null.

getRangedDynamicValue

public ProtoLayoutDynamicFloat getRangedDynamicValue ()

Returns the dynamic ranged value field for this complication.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE and ComplicationType.GOAL_PROGRESS). If unset, returns null.

getRangedMaxValue

public float getRangedMaxValue ()

Returns the maxValue of the ranged value field for this complication.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE, otherwise returns zero.

getRangedMinValue

public float getRangedMinValue ()

Returns the minValue of the ranged value field for this complication.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE, otherwise returns zero.

getRangedValue

public float getRangedValue ()

Returns the ranged value field for this complication.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE and ComplicationType.GOAL_PROGRESS), otherwise returns zero.

getRangedValueType

public int getRangedValueType ()

Returns the ranged value type field for this complication.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE, otherwise returns zero.

getShortText

public ComplicationText getShortText ()

Returns the short text field for this complication data, or an empty bundle if no value was provided for the field.

The value is provided as a ComplicationText object, from which the text to display can be obtained for a given point in time.

The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated.

Valid only if the type of this complication data is ComplicationType.SHORT_TEXT, ComplicationType.RANGED_VALUE, or ComplicationType.NO_PERMISSION, otherwise returns an empty bundle.

getShortTitle

public ComplicationText getShortTitle ()

Returns the short title field for this complication data, or an empty bundle if no value was provided for the field.

The value is provided as a ComplicationText object, from which the text to display can be obtained for a given point in time.

The length of the text, including any time-dependent values at any valid time, is expected to not exceed seven characters. When using this text, the watch face should be able to display any string of up to seven characters (reducing the text size appropriately if the string is very wide). Although not expected, it is possible that strings of more than seven characters might be seen, in which case they may be truncated.

Valid only if the type of this complication data is ComplicationType.SHORT_TEXT, ComplicationType.RANGED_VALUE, or ComplicationType.NO_PERMISSION, otherwise returns an empty bundle.

getSmallImage

public Icon getSmallImage ()

Returns the small image field for this complication data, or null if no value was provided for the field.

This may be either a IMAGE_STYLE_PHOTO image, which is expected to fill the space available, or an IMAGE_STYLE_ICON image, which should be drawn entirely within the space available. Use getSmallImageStyle() to determine which of these applies.

As this may be any image, it is unlikely to be suitable for display in ambient mode when burn-in protection is enabled, or in low-bit ambient mode, and should not be rendered under these circumstances.

Valid for the types ComplicationType.LONG_TEXT and ComplicationType.SMALL_IMAGE. Otherwise returns null.

getSmallImageStyle

public int getSmallImageStyle ()

Returns the small image style for this complication data.

The result of this method should be taken in to account when drawing a small image complication.

Valid only for types that contain small images, i.e. ComplicationType.SMALL_IMAGE and ComplicationType.LONG_TEXT. Otherwise returns zero.

getStartDateTimeMillis

public long getStartDateTimeMillis ()

Returns the start time for this complication data (i.e. the first time at which it should be considered active and displayed), this may be 0. See also isActiveAtMillis(long).

getTapAction

public PendingIntent getTapAction ()

Returns the tap action field for this complication. The result is a PendingIntent that should be fired if the complication is tapped on, assuming the complication is tappable, or null if no tap action has been specified.

Valid for all non-empty types, otherwise returns null.

getTargetValue

public float getTargetValue ()

Returns the targetValue of the ranged value field for this complication.

Valid only if the type of this complication data is ComplicationType.GOAL_PROGRESS, otherwise returns zero.

getTimelineEndEpochSecond

public long getTimelineEndEpochSecond ()

For timeline entries. The epoch second at which this timeline entry becomes invalid or -1 if it's not set.

getTimelineEntries

public List<ComplicationData> getTimelineEntries ()

Returns the list of ComplicationData timeline entries.

getTimelineStartEpochSecond

public long getTimelineStartEpochSecond ()

For timeline entries. The epoch second at which this timeline entry becomes valid or -1 if it's not set.

getType

public int getType ()

hasBurnInProtectionIcon

public boolean hasBurnInProtectionIcon ()

Returns true if the ComplicationData contains a burn in protection Icon. I.e. if getBurnInProtectionIcon() can succeed.

hasBurnInProtectionSmallImage

public boolean hasBurnInProtectionSmallImage ()

Returns true if the ComplicationData contains a burn in protection small image. I.e. if getBurnInProtectionSmallImage() can succeed.

hasColorRamp

public boolean hasColorRamp ()

Returns true if the ComplicationData has the color ramp field set. I.e. if getColorRamp() can succeed.

hasContentDescription

public boolean hasContentDescription ()

Returns true if the ComplicationData contains a content description. I.e. if getContentDescription() can succeed.

hasDynamicValues

public boolean hasDynamicValues ()

Returns true if the complication contains a dynamic value that needs to be evaluated.

hasElementBackgroundColor

public boolean hasElementBackgroundColor ()

Returns true if the ComplicationData contains a background color for use between elements for this complication. I.e. if getElementBackgroundColor() can succeed.

hasElementColors

public boolean hasElementColors ()

Returns true if the ComplicationData contains element colors. I.e. if getElementColors() can succeed.

hasElementWeights

public boolean hasElementWeights ()

Returns true if the ComplicationData contains element weights. I.e. if getElementWeights() can succeed.

hasExtras

public boolean hasExtras ()

Returns true if extras have been set in this ComplicationData. I.e. if getExtras() can succeed.

hasIcon

public boolean hasIcon ()

Returns true if the ComplicationData contains an Icon. I.e. if getIcon() can succeed.

hasInvalidatedData

public boolean hasInvalidatedData ()

Returns true if the ComplicationData contains a content description. I.e. if getContentDescription() can succeed.

hasIsColorRampInterpolated

public boolean hasIsColorRampInterpolated ()

Returns true if the ComplicationData has the isColorRampInterpolated field set. I.e. if isColorRampInterpolated() can succeed.

hasLargeImage

public boolean hasLargeImage ()

Returns true if the ComplicationData contains a large image. I.e. if getLargeImage() can succeed.

hasLongText

public boolean hasLongText ()

Returns true if the ComplicationData contains long text. I.e. if getLongText() can succeed.

hasLongTitle

public boolean hasLongTitle ()

Returns true if the ComplicationData contains a long title. I.e. if getLongTitle() can succeed.

hasPlaceholder

public boolean hasPlaceholder ()

Returns true if the ComplicationData contains a placeholder. I.e. if getPlaceholder() can succeed.

hasRangedDynamicValue

public boolean hasRangedDynamicValue ()

Returns true if the ComplicationData contains a ranged dynamic value. I.e. if getRangedDynamicValue() can succeed.

hasRangedMaxValue

public boolean hasRangedMaxValue ()

Returns true if the ComplicationData contains a ranged max value. I.e. if getRangedMaxValue() can succeed.

hasRangedMinValue

public boolean hasRangedMinValue ()

Returns true if the ComplicationData contains a ranged max value. I.e. if getRangedMinValue() can succeed.

hasRangedValue

public boolean hasRangedValue ()

Returns true if the ComplicationData contains a ranged value. I.e. if getRangedValue() can succeed.

hasRangedValueType

public boolean hasRangedValueType ()

Returns true if the ComplicationData contains a ranged max type. I.e. if getRangedValueType() can succeed.

hasShortText

public boolean hasShortText ()

Returns true if the ComplicationData contains short text. I.e. if getShortText() can succeed.

hasShortTitle

public boolean hasShortTitle ()

Returns true if the ComplicationData contains a short title. I.e. if getShortTitle() can succeed.

hasSmallImage

public boolean hasSmallImage ()

Returns true if the ComplicationData contains a small image. I.e. if getSmallImage() can succeed.

hasTapAction

public boolean hasTapAction ()

Returns true if the ComplicationData contains a tap action. I.e. if getTapAction() can succeed.

hasTargetValue

public boolean hasTargetValue ()

Returns true if the ComplicationData contains a ranged max value. I.e. if getTargetValue() can succeed.

hasTimelineEntries

public boolean hasTimelineEntries ()

Returns true if the Timeline Entries field has been set and their presence is valid for this ComplicationData. I.e. if getTimelineEntries() will succeed.

hashCode

public int hashCode ()

isActiveAtMillis

public boolean isActiveAtMillis (long dateTimeMillis)

Returns true if the complication is active and should be displayed at the given time. If this returns false, the complication should not be displayed.

This must be checked for any time for which the complication will be displayed.

isColorRampInterpolated

public boolean isColorRampInterpolated ()

Returns either a boolean where: true means the color ramp colors should be smoothly interpolated; false means the color ramp should be rendered in equal sized blocks of solid color.

Valid only if the type of this complication data is ComplicationType.RANGED_VALUE or ComplicationType.GOAL_PROGRESS.

isTapActionLostDueToSerialization

public boolean isTapActionLostDueToSerialization ()

TapAction unfortunately can't be serialized.

Returns true if tapAction has been lost due to serialization (e.g. due to being read from the local cache). The next complication update from the system would replace this with one with a tapAction.

isTimeDependent

public boolean isTimeDependent ()

Returns true if the complication data contains at least one text field with a value that may change based on the current time.

stripExtras

public void stripExtras ()

Removes any extras, if set, from this ComplicationData.

toString

public String toString ()

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)