Module: Toybox.Application.WatchFaceConfig

Overview

The WatchFaceConfig module facilitates access to persisted watchface configurations. Watchface could have more than one configuration settings, and each setting is represented by a unique identifier.

Since:

API Level 5.1.0

Supported Devices:

Classes Under Namespace

Classes: Color, ComplicationRef, Id, Settings

Instance Method Summary collapse

Instance Method Details

getIds() as Lang.Array<WatchFaceConfig.Id> or Null

Returns ids of all saved watchface config settings.

Supported Devices:

Returns:

  • Lang.Array

    or null if the watchface does not support watchface config.

Since:

API Level 5.1.0

getSettings(configId as WatchFaceConfig.Id or Null) as WatchFaceConfig.Settings or Null

Returns the watchface config settings for the given unique identifier.

Parameters:

  • configId(Id)

    unique identifier of the watchface config settings to fetch, if null default or active settings will be returned.

Supported Devices:

Returns:

Since:

API Level 5.1.0

setSettings(configId as WatchFaceConfig.Id or Null, settings as WatchFaceConfig.Settings) as Void

Set or update watchface config settings with the given unique identifier, configId.

Parameters:

  • configId(Lang.Number)

    unique identifier of the watchface config settings to save or update, if null default settings will be updated.

  • settings(WatchFaceConfig.Settings)

    watchface config settings to apply.

Supported Devices:

Since:

API Level 5.1.0

Throws:


Generated Mar 4, 2025, 4:09:51 PM