Class: Toybox.Complications.Complication

Inherits:

Toybox.Lang.Object

• Toybox.Lang.Object
• Toybox.Complications.Complication

Overview

Complication object

Since:

API Level 4.2.0

Instance Member Summary

• complicationId as Complications.Id or Null
• longLabel as Complications.Label or Null
• ranges as Complications.Ranges or Null
• shortLabel as Complications.Label or Null
• unit as Complications.Unit or Lang.String or Null
• value as Complications.Value or Null

Instance Method Summary

• getIcon() as Complications.Icon or Null

  Get the complication icon.

• getType() as Complications.Type or Null

  Get the complication type.

Instance Attribute Details

var complicationId as Complications.Id or Null

Since:

API Level 4.2.0

var longLabel as Complications.Label or Null

Since:

API Level 4.2.0

var ranges as Complications.Ranges or Null

Since:

API Level 4.2.0

var shortLabel as Complications.Label or Null

Since:

API Level 4.2.0

var unit as Complications.Unit or Lang.String or Null

Since:

API Level 4.2.0

var value as Complications.Value or Null

Since:

API Level 4.2.0

Instance Method Details

getIcon() as Complications.Icon or Null

Get the complication icon. This is only available for user complications

Returns:

• Complications.Icon —

  An icon for a user complication, or null for if this is a native complication complications.

Since:

API Level 4.2.0

Throws:

• (Complications.ComplicationNotFoundException) —

  Thrown if the given complication is not found.

getType() as Complications.Type or Null

Get the complication type

Returns:

• Complications.Type —

  The complication type of a system complication, or COMPLICATION_TYPE_INVALID for user complications.

Since:

API Level 4.2.0