Class

WKInterfaceTimer

A special type of label that displays a countdown or count-up timer.

Overview

Use a timer object to configure the amount of time and the appearance of the timer text. When you start the timer, WatchKit updates the displayed text automatically on the user’s Apple Watch without further interactions from your extension. To know when the timer reaches 0, configure a Timer object with the same target date you used to set up the timer.

Do not subclass or create instances of this class yourself. Instead, define outlets in your interface controller class and connect them to the corresponding objects in your storyboard file. For example, to refer to a timer object in your interface, define a property with the following syntax in your interface controller class:

@IBOutlet weak var myTimer: WKInterfaceTimer!

During the initialization of your interface controller, WatchKit creates any needed timer objects and assigns them to their connected outlets. At that point, you can use those objects to reconfigure the corresponding timers.

Interface Builder Configuration Options

Xcode lets you configure information about your timer interface object in your storyboard file. Table 1 lists the attributes you can configure and their meaning.

Table 1

WatchKit timer attributes

Attribute

Description

Format

The format of the timer string. Select different options to update the appearance of the timer label in your storyboard scene.

Enabled

A checkbox indicating whether the timer starts running as soon as your interface is initialized.

Units

The units to be displayed in the label. Enabling checkboxes in this section causes the timer to display the corresponding units that are in range of the time. In other words, a timer with 2 minutes remaining displays minutes and seconds only; it does not display hours, days, or any larger units.

Preview Secs

The initial number of seconds for the timer. You can change this value programmatically using the setDate(_:) method.

A date object is a custom label whose text you cannot set directly. However, you can customize the appearance of the date object as you would for a label using the Attributes inspector in Xcode. For information about the label attributes you can configure, see WKInterfaceLabel.

Symbols

Configuring the Timer Attributes

func setDate(Date)

Changes the start time for the timer.

func setTextColor(UIColor?)

Sets the color of the timer’s text.

Starting and Stopping the Timer

func start()

Begins updates to the timer’s display.

func stop()

Stops updates to the timer’s display.

Relationships

Inherits From

Conforms To