Return the sport for which the current activity retrieves heart rate
zone thresholds.

If the active sport does not have sport specific zones, it will return
{Toybox::UserProfile::HR_ZONE_SPORT_GENERIC HR_ZONE_SPORT_GENERIC}.
@example
using Toybox.UserProfile;
var profile = UserProfile.getCurrentSport();
Returns [Toybox::UserProfile::SportHrZone]

The current HR zone sport from the
{Toybox::UserProfile::HR_ZONE_SPORT_GENERIC HR_ZONE_SPORT_*} enum.
@since 1.2.6
]]> Retrieve the current {Toybox::UserProfile::Profile Profile}
object.
@example
using Toybox.UserProfile;
var profile = UserProfile.getProfile();
Returns [Toybox::UserProfile::Profile] The Profile object for the

current user
@since 1.0.0
]]> Retrieve an {Toybox::Lang::Array Array} of the current heart rate zone
threshold values in beats per minute (bpm)

The returned Array contains zone values as follows:
* min zone 1 - The minimum heart rate threshold for zone 1
* max zone 1 - The maximum heart rate threshold for zone 1
* max zone 2 - The maximum heart rate threshold for zone 2
* max zone 3 - The maximum heart rate threshold for zone 3
* max zone 4 - The maximum heart rate threshold for zone 4
* max zone 5 - The maximum heart rate threshold for zone 5
@example Use the HR_ZONE_SPORT_* enum to get the zone for that specific sport
using Toybox.UserProfile;
var genericZoneInfo = UserProfile.getHeartRateZones(UserProfile.HR_ZONE_SPORT_GENERIC);
sport [Toybox::UserProfile::SportHrZone] The sport that zones are being

requested from. Should be a {Toybox::UserProfile::HR_ZONE_SPORT_GENERIC HR_ZONE_SPORT_*} value.
Returns [Toybox::Lang::Array] An Array of zone thresholds for the

requested sport.
@since 1.2.6
]]> Get an iterator for Activity history for the user
@example Shows the use of UserActivityHistoryIterator
using Toybox.UserProfile;
using Toybox.System;

// get a UserActivityHistoryIterator object
var userActivityIterator = UserProfile.getUserActivityHistory();
var sample = userActivityIterator.next(); // get the user activity data

while (sample != null) {
System.println("Sample: " + sample.userActivityData); // print the current sample
sample = userActivityIterator.next();
}
Returns [Toybox::UserProfile::UserActivityHistoryIterator] Iterator object

@since 3.3.0
]]> Get information about the current profile.

Returns [Toybox::Activity::ProfileInfo] the current profile

@since 3.2.0
]]> Get the current Activity Info.
Returns [Toybox::Activity::Info] The current Activity Info

@since 1.0.0
]]> Get information about the current workout step.

Returns [Toybox::Activity::WorkoutStepInfo] if a workout is active, +null+ otherwise

@throws [Toybox::Lang::OperationNotAllowedException] Thrown if called from a
data field app
@since 3.2.0
]]> Get information about the next workout step.

Returns [Toybox::Activity::WorkoutStepInfo] if a workout is active and there is a next step, +null+ otherwise

@throws [Toybox::Lang::OperationNotAllowedException] Thrown if called from a
data field app
@since 3.2.0
]]> Get a {Toybox::Time::Moment Moment} for the current time.

Returns [Toybox::Time::Moment] A Moment representing the current moment

in time.
@example Using now() on December 31, 1989 at 5:00 pm CST
using Toybox.Time;
var now = new Time.Moment(Time.now().value()); // UNIX epoch 631148400
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@see https://en.wikipedia.org/wiki/Unix_time UNIX Time
@since 1.0.0
]]> Get a {Toybox::Time::Moment Moment} for midnight today.

Returns [Toybox::Time::Moment] A Moment representing the the beginning

of the current day.
@example Using today() on December 31, 1989 at 5:00 pm CST
using Toybox.Time;
var now = new Time.Moment(Time.today().value()); // UNIX epoch 631087200
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@see https://en.wikipedia.org/wiki/Unix_time UNIX Time
@since 1.0.0
]]> Get a {Toybox::Time::Moment Moment} for the current time based on the
specified source.

This method behaves the same as {Toybox::Time#now Time.now()}, but accepts
an +options+ argument that allows the time source to be selected.
options [Toybox::Lang::Dictionary] Clock options

@option options [Toybox::Time::CurrentTime] :currentTimeType A
{Toybox::Time::CURRENT_TIME_DEFAULT Time.CURRENT_TIME_*} value, which
defaults to {Toybox::Time::CURRENT_TIME_DEFAULT Time.CURRENT_TIME_DEFAULT}
if no time type is provided
@throws [Toybox::Time::RealTimeClockNotValidException] Thrown if
{Toybox::Time::CURRENT_TIME_RTC Time.CURRENT_TIME_RTC} is passed as an option
and the real-time clock value is not valid, i.e. synced with trusted source
such as GPS.
@see Toybox::Time#now Time.now()
@since 3.0.10
]]> Get natural logarithm of a value
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The value for which to get the logarithm
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

natural logarithm of x
* Float if input is Number or Float
* Double if input is Long or Double
@since 2.3.0
]]> Get logarithm of a value using the specified base
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The value for which to get the logarithm
base [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The base value.
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

specified base logarithm of x
* Float if both inputs are Number or Float
* Double if either input is Long or Double
@since 1.0.0
]]> Get the cosine of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The angle in radians
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The cosine value of x in radians
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Get the arc tangent of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The tangent value
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The interval [-PI/2..PI/2] in radians, or +NaN+ if invalid
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Get the most common value found in an array of data.
data [Toybox::Lang::Array] An array of {Toybox::Lang::Object Objects}

Returns [Toybox::Lang::Object]

The most frequently occurring value in data.
@throws [Toybox::Lang::InvalidValueException] Thrown if there is no most
frequently occurring value or the passed in value array is empty
@since 3.1.0
]]> Returns a pseudo-random Number. Use the {Toybox::Math#srand srand()} function to seed the random number generator.
Returns [Toybox::Lang::Number] Non-negative random number

@since 1.0.0
]]> Seed the random number generator.
seed [Toybox::Lang::Number] The value used for seeding rand()

@since 1.0.0
@note srand() does not return any value.
]]> Calculate the square root of a value.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The value for which to get the square root
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The square root of x, or +NaN+ if invalid
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Calculate x to the power of y.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

Base
y [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

Exponent
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

x to the power of y
* Float if both inputs are Number or Float
* Double if either input is Long or Double
@since 1.0.0
]]> Get the sine of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The angle in radians
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The sine value of x in radians
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Compute the floor of a value.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

A numeric value
Returns [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The largest integer less than or equal to x
Return type matches the input parameter type
@since 1.3.0
]]> Get the standard deviation of a sample of population data.
data [Toybox::Lang::Array] An array of {Toybox::Lang::Number Number},

{Toybox::Lang::Float Float}, {Toybox::Lang::Long Long}, or
{Toybox::Lang::Double Double} values with at least two elements.
xbar [Toybox::Lang::Double] The mean, if known.

Otherwise, pass +null+ and the mean of data will be calculated.
Returns [Toybox::Lang::Double]

The standard deviation of the samples
@throws [Toybox::Lang::InvalidValueException] Thrown if the provided data
array has fewer than two elements.
@since 3.1.0
]]> Get the arc tangent of y/x in radians.
y [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The proportion of the y coordinate
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The proportion of the x coordinate
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The principal arc tangent of y/x, in the interval [-PI..PI] radians,
or +NaN+ if invalid
* Float if both inputs are Number or Float
* Double if either input is Long or Double
@since 1.3.0
]]> Get the tangent of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The angle in radians
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The tangent value of x in radians
Toybox::Lang::Float if input is Toybox::Lang::Number or Toybox::Lang::Float
Toybox::Lang::Double if input is Toybox::Lang::Long or Toybox::Lang::Double
@since 1.0.0
]]> Convert an angle from radians to degrees.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The angle in radians
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The angle of x in degrees
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.3.0
]]> Get the arc cosine of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The cosine value
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The interval [0..PI] in radians, or +NaN+ if invalid
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Compute the ceiling of a value.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

A numeric value
Returns [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The smallest integer greater than or equal to x
Return type matches the input parameter type
@since 1.3.0
]]> Convert an angle from degrees to radians.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The angle in degrees
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The angle of x in radians
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.3.0
]]> Round a value.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

A numeric value
Returns [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The closest integer to x. Decimal values >= .5 will be rounded up
Return type matches the input parameter type
@since 1.3.0
]]> Get the sample variance of an array of data.

Returns the sample variance with Bessel's correction.
data [Toybox::Lang::Array] An array of {Toybox::Lang::Number Number},

{Toybox::Lang::Float Float}, {Toybox::Lang::Long Long}, or
{Toybox::Lang::Double Double} values with at least two elements.
xbar [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double] The mean, if known.

Otherwise, pass +null+ and the mean of data will be calculated.
Returns [Toybox::Lang::Double]

The variance of the samples
@throws [Toybox::Lang::InvalidValueException] Thrown if the provided data
array has fewer than two elements.
@since 3.1.0
]]> Get the arithmetic mean (average) of an array of data.
data [Toybox::Lang::Array] An array of {Toybox::Lang::Number Number},

{Toybox::Lang::Float Float}, {Toybox::Lang::Long Long}, or
{Toybox::Lang::Double Double} values
Returns [Toybox::Lang::Double]

The arithmetic mean of the values in data
@throws [Toybox::Lang::InvalidValueException] Thrown if the provided data
array is empty.
@since 3.1.0
]]> Get the arc sine of an angle.
x [Toybox::Lang::Number, Toybox::Lang::Float, Toybox::Lang::Long, Toybox::Lang::Double]

The sine value
Returns [Toybox::Lang::Float, Toybox::Lang::Double]

The interval [-PI/2..PI/2] in radians, or +NaN+ if invalid
* Float if input is Number or Float
* Double if input is Long or Double
@since 1.0.0
]]> Retrieve an Iterator of all currently paired devices accessible to the
Application

Returns [Toybox::BluetoothLowEnergy::Iterator] All paired devices

available to the App
@since 3.1.0
]]> Accessor for determining the number of available connections

@since 3.1.0
Returns [Toybox::Lang::Number] The number of available connections

]]> Pairs a peripheral device seen in scanning with the system.

The BLE Subsystem will begin to search for the device specified by
the scanResult parameter. Once the device is found and connected,
{Toybox::BluetoothLowEnergy::BleDelegate#onConnectedStateChanged onConnectedStateChanged()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate} with
the associated {Toybox::BluetoothLowEnergy::Device Device} object

This pairing does not persist across application instances.

scanResult [Toybox::BluetoothLowEnergy::ScanResult] A scan result

for the device that should be paired. Cannot be +null+.

@throws [Toybox::BluetoothLowEnergy::DevicePairException] Thrown if
the maximum number of paired devices has already been reached,
or if pairing failed for unkown reason
Returns [Toybox::BluetoothLowEnergy::Device] the device that was added

to the paired list or +null+ if the device could not be paired.
@since 3.1.0
]]> Converts long representation of a UUID to a Uuid object

@see Toybox::BluetoothLowEnergy::Uuid
mostSigBits [Toybox::Lang::Long] Most Significant 64-bits of

the UUID
leastSigBits [Toybox::Lang::Long] Least Significant 64-bits of

the UUID
Returns [Toybox::BluetoothLowEnergy::Uuid] Uuid Object

@since 3.1.0
]]> Registers a Bluetooth Profile Definition

Call this function to define all of the Profiles that will be used in
the application. Only registered characteristics and descriptors will be
available when performing GATT operations

When the operation is completed,
{Toybox::BluetoothLowEnergy::BleDelegate#onProfileRegister onProfileRegister()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
with the UUID and a Status.

Registration can fail if too many profiles are registered, the current
limit is 3.

@example
using Toybox.BluetoothLowEnergy;

function registerProfiles() {
var profile = { // Set the Profile
:uuid => Ble.stringToUuid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
:characteristics => [ { // Define the characteristics
:uuid => Ble.stringToUuid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"), // UUID of the first characteristic
:descriptors => [ // Descriptors of the characteristic
Ble.stringToUuid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
Ble.stringToUuid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") ] }, {
:uuid => Ble.stringToUuid("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") }] // UUID of the second characteristic
};

// Make the registerProfile call
BluetoothLowEnergy.registerProfile( profile );
}

profile [Toybox::Lang::Dictionary] Profile Definition. Defines

the expected Profile UUID, Profile Characteristics and Characteristic
Descriptors.
Cannot be +null+.

@throws [Toybox::BluetoothLowEnergy::ProfileRegistrationException] If
registration could not be completed
@since 3.1.0
]]> Starts the BLE Scanning Operations

Once scanning is started {Toybox::BluetoothLowEnergy::BleDelegate#onScanResults onScanResults()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
as Advertising data is received.
@since 3.1.0
]]> Unpairs a peripheral device from the system

If the device is connected the BLE Subsystem will disconnect from the
device and will not attempt to reconnect. If the device is not connected
the system will stop searching for the device.

device [Toybox::BluetoothLowEnergy::Device] the device to remove

from the paired device store. Cannot be +null+
@since 3.1.0
]]> Retrieves the CCCD Uuid

@see Toybox::BluetoothLowEnergy::Uuid
Returns [Toybox::BluetoothLowEnergy::Uuid] Uuid Object for the

Client Characteristic Configuration Descriptor
@since 3.1.0
]]> Sets the Delegate Handler for Bluetooth Asynchronous Callbacks

An application can only have 1 registered delegate. Subsequent calls to
this function will override the current delegate

delegate [Toybox::BluetoothLowEnergy::BleDelegate] An implementation

of the {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate} class to register
as the handler for callbacks, or +null+ to deregister the current handler.
@example
using Toybox.BluetoothLowEnergy as Ble;
class Handler extends Ble.BleDelegate {
function initialize() {
BleDelegate.initialize();
}
}

var handler = new Handler();
Ble.setDelegate(handler);
@since 3.1.0
]]> Converts the String Representation of a UUID into a Uuid Object

@see Toybox::BluetoothLowEnergy::Uuid
str [Toybox::Lang::String] String Representation of the Uuid

formatted as "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
Returns [Toybox::BluetoothLowEnergy::Uuid] Uuid Object

@throws [Toybox::BluetoothLowEnergy::UuidFormatException] If string
is not in valid format
@since 3.1.0
]]> Exit the current app and launch a new app.

This may only be called by watch-apps and widgets, and may only target
watch-apps (both native activities and Connect IQ apps) and widgets.
This is an asynchronous request that presents a confirmation dialog to
launch the Intent. If confirmed, the current app will exit. Otherwise,
the app will continue to run without exiting.
intent [Toybox::System::Intent] The Intent to trigger

@throws [Toybox::System::UnexpectedAppTypeException] Indicates the intended
application is not a device app or widget
@throws [Toybox::System::AppNotInstalledException] Indicates the intended
application is not installed
@throws [Toybox::System::PreviousOperationNotCompleteException] Indicates
exitTo() is called a second time before the initial call completes
@example
using Toybox.System;
var targetApp = new System.Intent(
"manifest-id://12345678-1234-1234-1234-123412341234",
{"arg"=>"CurrentAppName"}
);
System.exitTo(targetApp);
@see Toybox::System::Intent
@since 2.2.0
]]> End execution of the current app.

This will exit the system cleanly from any point within an app.
@since 1.0.0
]]> Get the unit ID

Returns [Toybox::Lang::Long] The unit ID of the device

@since 3.0.10
]]> Send a notification to the system

name [Toybox::Lang::Object] The name which identifies the value

value [Toybox::Lang::Object] The value

Returns [Toybox::Lang::Boolean] true if notification handled by the system

@since 3.0.10
]]> Create the app's log file

This is locked to the samples_prv.der key
@since 3.1.0
]]> Get the current millisecond timer value.
Returns [Toybox::Lang::Number]

@note The returned value typically starts at zero on device boot and
will roll over periodically. Assuming the timer starts at zero, this
will happen ~25 days after a reboot, and every ~50 days thereafter.
@since 1.0.0
]]> Write an error to the console and exit the system.
@note There are never really too many bananas.
msg [Toybox::Lang::String] The error message to output

@example
using Toybox.System;
const MAX_BANANAS = 8;
var bananasInBunch = 10;
if (bananasInBunch > MAX_BANANAS) {
System.error("Too many bananas!")
}
@since 1.0.0
]]> Get the current device settings.
Returns [Toybox::System::DeviceSettings]

@example
using Toybox.System;
var mySettings = System.getDeviceSettings();
@since 1.0.0
]]> Print to the console with a line terminator.

output [Toybox::Lang::Object] The item to print, typically a

{Toybox::Lang::String String}.
@example
using Toybox.System;
System.println("Hello Monkey C!");
@since 1.0.0
]]> Get the current system stats.
Returns [Toybox::System::Stats]

@example
using Toybox.System;
var myStats = System.getSystemStats();
@since 1.0.0
]]> Check the installation status of an app.
uri [Toybox::Lang::String] The URI that specifies an app

Returns [Toybox::Lang::Boolean] +true+ if the app is installed,

otherwise +false+
@throws [Toybox::Lang::InvalidValueException] Thrown if an invalid
URI format is provided
@example Valid URI formats
manifest-id://[manifest ID in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx]
store-id://[app store ID in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx]
@since 3.2.0
]]> Returns the user's notification preferences for the current app
Returns [Toybox::System::PushNotificationPreference] PUSH_NOTIFICATIONS_* enum

@since 3.0.10
]]> Print to the console.
output [Toybox::Lang::Object] The item to print, typically a

{Toybox::Lang::String String}.
@since 1.0.0
]]> Get the current clock time.
Returns [Toybox::System::ClockTime]

@since 1.0.0
]]> Throws an exception if value1 and value2 are equal.

The objects passed to this function must implement the
{Toybox::Lang::Object#equals Object.equals()} method which compares both
type and value.
value1 [Toybox::Lang::Object] The value to test for equality

value2 [Toybox::Lang::Object] The value to test for equality

@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertNotEqualTest(logger) {
var x = 1;
var y = 1;
Test.assertNotEqual(x, y);
return true;
}
// Output:
ASSERTION FAILED
Unhandled Exception
@since 2.1.0
]]> Throws an exception if the test is +false+.
test [Toybox::Lang::Boolean] The expression to test for +true+

@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertTest(logger) {
var x = false;
Test.assert(x);
return true;
}
// Output:
ASSERTION FAILED
Unhandled Exception
@since 2.1.0
]]> Throws an exception if value1 and value2 are equal followed by a
{Toybox::Lang::String String} defined by the developer.

The objects passed to this function must implement the
{Toybox::Lang::Object#equals Object.equals()} method which compares both
type and value.
value1 [Toybox::Lang::Object] The value to test for equality

value2 [Toybox::Lang::Object] The value to test for equality

message [Toybox::Lang::String] The identifying message for the assert

@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertNotEqualMessageTest(logger) {
var x = 1;
var y = 2;
Test.assertNotEqual(x, y, "x and y are equal!");
return true;
}
// Output:
ASSERTION FAILED: x and y are equal!
Unhandled Exception
@since 2.1.0
]]> Throws an exception if value1 and value2 are not equal.

The objects passed to this function must implement the
{Toybox::Lang::Object#equals Object.equals()} method which compares both
type and value.
value1 [Toybox::Lang::Object] The first value to test for

equality
value2 [Toybox::Lang::Object] The second value to test for

equality
@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertEqualTest(logger) {
var x = 1;
var y = 2;
Test.assertEqual(x, y);
return true;
}
// Output:
ASSERTION FAILED
Unhandled Exception
@since 2.1.0
]]> Throws an exception if value1 and value2 are not equal followed by a
{Toybox::Lang::String String} defined by the developer.

The objects passed to this function must implement the
{Toybox::Lang::Object#equals Object.equals()} method which compares both
type and value.
value1 [Toybox::Lang::Object] The value to test for equality

value2 [Toybox::Lang::Object] The value to test for equality

message [Toybox::Lang::String] The identifying message for the assert

@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertEqualMessageTest(logger) {
var x = 1;
var y = 2;
Test.assertEqual(x, y, "x and y are not equal!");
return true;
}
// Output:
ASSERTION FAILED: x and y are not equal!
Unhandled Exception
@since 2.1.0
]]> Throws an exception if the test is +false+ followed by a
{Toybox::Lang::String String} defined by the developer.
test [Toybox::Lang::Boolean] Expression to test for +true+

message [Toybox::Lang::String] The identifying message for the

assert
@throws [Toybox::Test::AssertException]
@example
using Toybox.Test;
(:test)
function anAssertMessageTest(logger) {
var x = false;
Test.assertMessage(x, "The assert is False for x.");
return true;
}
// Output:
ASSERTION FAILED: The assert is False for x.
Unhandled Exception
@since 2.1.0
]]> Create a public {Toybox::Cryptography::Key Key} object from bytes to be
added to a {Toybox::Cryptography::KeyAgreement KeyAgreement}.

If a public key is received from another party, it can be converted to a
{Toybox::Cryptography::Key Key} object using this method.
algorithm [Toybox::Cryptography::HashAlgorithm] The hash algorithm to use as a

{Toybox::Cryptography::KEY_PAIR_ELLIPTIC_CURVE_SECP224R1 KEY_PAIR_ELLIPTIC_CURVE_*}
constant
bytes [Toybox::Lang::ByteArray] The public key bytes to be used to

generate the {Toybox::Cryptography::Key Key}
Returns [Toybox::Cryptography::Key]

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if an argument is
not the correct type
@throws [Toybox::Lang::InvalidValueException] Thrown if the ByteArray
provided is not the correct size for the selected algorithm, or the
algorithm selected is not supported.
@note bytes is expected to be in little-endian byte order.
@see Toybox::Cryptography::KeyAgreement
@since 3.0.0
]]> Generates cryptographically random bytes.
size [Toybox::Lang::Number] The number of requested random bytes

Returns [Toybox::Lang::ByteArray] A ByteArray of the requested size

filled with cryptographically random bytes
@since 3.0.0
]]> Encodes a String in base64
string [Toybox::Lang::String] The string to encode

Returns [Toybox::Lang::String] A base64 encoded String

@since 1.3.0
]]> Given an Array of {Toybox::Lang::Char Char} objects, return the String equivalent
charArray [Toybox::Lang::Array] An Array of Char objects

Returns [Toybox::Lang::String] The String representation of the input Array

@since 1.3.0
]]> Convert a String or ByteArray representation to a String or ByteArray
representation whose underlying byte format corresponds to the provided
input options.
input [Toybox::Lang::String, Toybox::Lang::ByteArray] Input that

needs to be converted.
options [Toybox::Lang::Dictionary]

@option options [Toybox::StringUtil::Representation] :fromRepresentation Required. A
{Toybox::StringUtil REPRESENTATION_*} enum value indicating the
representation from which the +input+ should be converted.
@option options [Toybox::StringUtil::Representation] :toRepresentation Required. A
{Toybox::StringUtil REPRESENTATION_*} enum value indicating the
representation to which the +input+ should be converted.
@option options [Toybox::StringUtil::CharacterEncoding] :encoding A
{Toybox::StringUtil CHAR_ENCODING_*} value indicating the String encoding
to use when generating a hex string or ByteArray when either the
+fromRepresentation+ or +toRepresentation+ is set to
REPRESENTATION_STRING_PLAIN_TEXT. Defaults to CHAR_ENCODING_UTF8 if not
specified.
Returns [Toybox::Lang::String, Toybox::Lang::ByteArray] The converted

String or ByteArray based on the provided options
@throws [Toybox::Lang::InvalidOptionsException] Thrown if a required option
is not set with a valid enumeration value.
@since 3.0.0
]]> Given an Array of UTF-8 bytes, return the String equivalent
utf8Array [Toybox::Lang::Array] An Array of UTF-8 bytes

Returns [Toybox::Lang::String] The String representation of the input Array

@throws [Toybox::Lang::InvalidValueException] Thrown if a the provided bytes
contain an invalid UTF-8 sequence.
@since 1.3.0
]]> Get stress history data for the given period

This function always returns the most recent sensor history samples. The time
between each `SensorSample` in the iterator may be device dependent.
options [Toybox::Lang::Dictionary] Dictionary of options. Can be

+null+.
@option options [Toybox::Lang::Number, Toybox::Time::Duration] :period The
period of time from which to retrieve the samples:
* If +null+, the entire available history is retrieved
* If a {Toybox::Time::Duration Duration}, then the history for the given Duration is retrieved
* If a {Toybox::Lang::Number Number}, then the last specified Number of entries are retrieved
@option options [Toybox::Lang::Boolean] :order The order in which to
retrieve the samples:
* If +null+, the samples will be {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST}
* Use the ORDER_* enumeration to explicitly select {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST} or {Toybox::SensorHistory::ORDER_OLDEST_FIRST ORDER_OLDEST_FIRST}
Returns [Toybox::SensorHistory::SensorHistoryIterator] An iterator for

the stress history for the given period. Samples returned by this
iterator are ranges from 0-100. Higher value indicate higher stress
and lower value indicate lower stress.
and a 100 indicates the body is rested and charged.
@example Shows the use of StressHistoryIterator
using Toybox.ActivityMonitor;
using Toybox.System;

// Create a method to get the SensorHistoryIterator object
function getIterator() {
// Check device for SensorHistory compatibility
if ((Toybox has :SensorHistory) && (Toybox.SensorHistory has :getStressHistory)) {
// Set up the method with parameters
return Toybox.SensorHistory.getStressHistory({});
}
return null;
}

// get stress history iterator object
var stressIterator = getIterator();
var sample = stressIterator.next(); // get the stress data

while (sample != null) {
System.println("Sample: " + sample.data); // print the current sample
sample = stressIterator.next();
}
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@since 3.3.0
]]> Get the body battery history for the given period.

This function always returns the most recent sensor history samples. The time
between each `SensorSample` in the iterator may be device dependent.
options [Toybox::Lang::Dictionary] Dictionary of options. Can be

+null+.
@option options [Toybox::Lang::Number, Toybox::Time::Duration] :period The
period of time from which to retrieve the samples:
* If +null+, the entire available history is retrieved
* If a {Toybox::Time::Duration Duration}, then the history for the given Duration is retrieved
* If a {Toybox::Lang::Number Number}, then the last specified Number of entries are retrieved
@option options [Toybox::Lang::Boolean] :order The order in which to
retrieve the samples:
* If +null+, the samples will be {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST}
* Use the ORDER_* enumeration to explicitly select {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST} or {Toybox::SensorHistory::ORDER_OLDEST_FIRST ORDER_OLDEST_FIRST}
Returns [Toybox::SensorHistory::SensorHistoryIterator] An iterator for

the body battery history for the given period. Samples returned by this
iterator are ranges from 0-100. A 0 indicates that the body is drained
and a 100 indicates the body is rested and charged.
@example Shows the use of BodyBatteryIterator
using Toybox.SensorHistory;
using Toybox.System;

// Create a method to get the SensorHistoryIterator object
function getIterator() {
// Check device for SensorHistory compatibility
if ((Toybox has :SensorHistory) && (Toybox.SensorHistory has :getBodyBatteryHistory)) {
// Set up the method with parameters
return Toybox.SensorHistory.getBodyBatteryHistory({});
}
return null;
}
// get the body battery iterator object
var bbIterator = getIterator();
var sample = bbIterator.next(); // get the body battery data

while (sample != null) {
System.println("Sample: " + sample.data); // print the current sample
sample = bbIterator.next();
}
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@since 3.3.0
]]> Get the heart rate history for the given period, up to the last power
cycle.

This function always returns the most recent heart rate samples. The
time between each {Toybox::SensorHistory::SensorSample SensorSample} in
the iterator may be device dependent.
options [Toybox::Lang::Dictionary] Dictionary of options. Can be

+null+.
@option options [Toybox::Lang::Number, Toybox::Time::Duration] :period The
period of time from which to retrieve the samples:
* If +null+, the entire available history is retrieved
* If a {Toybox::Time::Duration Duration}, then the history for the given Duration is retrieved
* If a {Toybox::Lang::Number Number}, then the last specified Number of entries are retrieved
@option options [Toybox::Lang::Boolean] :order The order in which to
retrieve the samples:
* If +null+, the samples will be listed {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST}
* Use the ORDER_* enumeration to explicitly select {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST} or {Toybox::SensorHistory::ORDER_OLDEST_FIRST ORDER_OLDEST_FIRST}
Returns [Toybox::SensorHistory::SensorHistoryIterator] An iterator for

the heart rate history for the given period. Samples returned by this
iterator are in beats per minute (bpm).
@example Gets a SensoryHistoryIterator and prints out the heart rate value from the most recent SensorSample
using Toybox.SensorHistory;
using Toybox.Lang;
using Toybox.System;

// Create a method to get the SensorHistoryIterator object
function getIterator() {
// Check device for SensorHistory compatibility
if ((Toybox has :SensorHistory) && (Toybox.SensorHistory has :getHeartRateHistory)) {
return Toybox.SensorHistory.getHeartRateHistory({});
}
return null;
}

// Store the iterator info in a variable. The options are 'null' in
// this case so the entire available history is returned with the
// newest samples returned first.
var sensorIter = getIterator();

// Print out the next entry in the iterator
if (sensorIter != null) {
System.println(sensorIter.next().data);
}
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@since 2.1.0
]]> Get the oxygen saturation history for the given period

This function always returns the most recent sensor history samples. The time
between each `SensorSample` in the iterator may be device dependent.
options [Toybox::Lang::Dictionary] Dictionary of options. Can be

+null+.
@option options [Toybox::Lang::Number, Toybox::Time::Duration] :period The
period of time from which to retrieve the samples:
* If +null+, the entire available history is retrieved
* If a {Toybox::Time::Duration Duration}, then the history for the given Duration is retrieved
* If a {Toybox::Lang::Number Number}, then the last specified Number of entries are retrieved
@option options [Toybox::Lang::Boolean] :order The order in which to
retrieve the samples:
* If +null+, the samples will be {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST}
* Use the ORDER_* enumeration to explicitly select {Toybox::SensorHistory::ORDER_NEWEST_FIRST ORDER_NEWEST_FIRST} or {Toybox::SensorHistory::ORDER_OLDEST_FIRST ORDER_OLDEST_FIRST}
Returns [Toybox::SensorHistory::SensorHistoryIterator] An iterator for

the oxygen saturation history for the given period. Samples returned by this
iterator are in percent (%).
@example Gets a SensoryHistoryIterator and prints out the Muscle Oxygen Saturation value from the most recent SensorSample
using Toybox.SensorHistory;
using Toybox.Lang;
using Toybox.System;

// Create a method to get the SensorHistoryIterator object
function getIterator() {
// Check device for SensorHistory compatibility
if ((Toybox has :SensorHistory) && (Toybox.SensorHistory has :getOxygenSaturationHistory)) {
// Set up the method with parameters
return Toybox.SensorHistory.getOxygenSaturationHistory({});
}
return null;
}

// Store the iterator info in a variable. The options are 'null' in
// this case so the entire available history is returned with the
// newest samples returned first.
var sensorIter = getIterator();

// Print out the next entry in the iterator
if (sensorIter != null) {
System.println(sensorIter.next().data);
}
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@since 3.2.0
]]> Register a background event that triggers at the wake time configured on
the device.
@since 2.3.0
]]> Registers the application to receive an event whenever an activity is completed.
@since 3.0.10
]]> Registers a background event that triggers each time an OAuth
login request completes and the token becomes available on the
system for use.

This event is triggered when a OAuth response is received by
the system.

@since 2.3.0
]]> Get data previously saved by a background process.

Data is delivered via
{Toybox::Application::AppBase#onBackgroundData AppBase.onBackgroundData()},
and is reset to +null+ once data has been delivered to the main process.
This method always returns +null+ in the main application's process.
@see Toybox::Application::AppBase#onBackgroundData AppBase.onBackgroundData()
@since 2.3.0
]]> Remove the active sleep background event for the application.
@since 2.3.0
]]> Remove the active goal background event of specified type for the
application.
goalType [Toybox::Application::GoalType] An

{Toybox::Application::GOAL_TYPE_STEPS Application.GOAL_TYPE_*} value
representing the goal type of the event to remove
@example
Background.deleteGoalEvent(GOAL_TYPE_STEPS);
@since 2.3.0
]]> Registers the application to receive silent and actionable push notifications.
@since 3.0.10
]]> Register a background event that triggers at the sleep time configured
on the device.
@since 2.3.0
]]> Register a background event that triggers when the user reaches a
specified goal.
goalType [Toybox::Application::GoalType] An

{Toybox::Application::GOAL_TYPE_STEPS Application.GOAL_TYPE_*} value
representing the goal type on which to trigger the background event
@example
Background.registerForGoalEvent(GOAL_TYPE_STEPS);
@since 2.3.0
]]> Get the time the last temporal background event was triggered.

This is useful for ensuring new events are not scheduled within the five
minute minimum time allowed between temporal events.
Returns [Toybox::Time::Moment] The time the last background event was

triggered, but may be +null+ if no previous temporal background event
has occurred or if the device app or widget has been started since the
event was last triggered
@example Register a new temporal background event as soon as allowed
using Toybox.Background;
using Toybox.Time;
const FIVE_MINUTES = new Time.Duration(5 * 60);
var lastTime = Background.getLastTemporalEventTime();
if (lastTime != null) {
// Events scheduled for a time in the past trigger immediately
var nextTime = lastTime.add(FIVE_MINUTES);
Background.registerForTemporalEvent(nextTime);
} else {
Background.registerForTemporalEvent(Time.now());
}
@see Toybox::Background#registerForTemporalEvent registerForTemporalEvent()
@see Toybox::Time
@since 2.3.0
]]> Registers a background event that triggers each time a multiple of 1000
steps is reached.

This event is triggered only by device-recorded steps, and will not
trigger based on synced steps.
@since 2.3.0
]]> Stops the application from receiving silent and actionable push notifications.
@since 3.0.10
]]> Remove the active steps background event for the application.
@since 2.3.0
]]> Remove the OAuth response background event.
@since 2.3.0
]]> Register a background event that triggers at a specific time or at a
regular interval.

Temporal background events may be registered to run at a specific point
in time by providing a {Toybox::Time::Moment Moment} at which the event
should trigger, or may be registered to run at a periodically by
specifying an interval {Toybox::Time::Duration Duration}. If a temporal
event is scheduled for a time in the past, the event will trigger
immediately.

Temporal events cannot be set to occur less than 5 minutes after the
last temporal event occurred. For watch-apps and widgets the 5 minute
restriction is cleared on application startup if the event was specified
using a {Toybox::Time::Moment Moment}.

Only one temporal event may be registered at a time. Calling
+registerForTemporalEvent+ will overwrite any previously registered
temporal events.
time [Toybox::Time::Moment, Toybox::Time::Duration] The specific

Moment in time at which to run a background event, or the interval
Duration at which to repeat a background event
@throws [Toybox::Background::InvalidBackgroundTimeException] Indicates an
application has attempted to schedule a background event which either:
* Occurs less than five minutes after the last background event occurred
* Has a duration of less than five minutes
@example Schedule a background event to run five minutes from now
using Toybox.Background;
using Toybox.Time;
const FIVE_MINUTES = new Time.Duration(5 * 60);
var eventTime = Time.now().add(FIVE_MINUTES);
Background.registerForTemporalEvent(eventTime);
@see Toybox::Time
@since 2.3.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForOAuthResponseEvent registerForOAuthResponseEvent()}
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForOAuthResponseEvent(), otherwise +false+
@since 3.0.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForWakeEvent registerForWakeEvent()}.
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForWakeEvent(), otherwise +false+
@since 3.0.0
]]> Registers the application to receive an event whenever a phone app message is received.
@since 3.2.0
]]> Display a confirmation dialog requesting to launch the application to
which the background task belongs.

If the dialog is confirmed, the application will open. If the dialog is
declined, the application will not open and the dialog will be dismissed.
This request is only valid for widget or device app background tasks, and
will be ignored by watch face apps.
{Toybox::Background#exit Background.exit()} must be called at some point
in the background process after this method is invoked because the
confirmation dialog will only trigger after the background task exits.
message [Toybox::Lang::String] The message to display in the dialog

when requesting to launch the app
@throws [Toybox::Background::MessageSizeLimitException] Indicates the
provided message exceeds the size limit (255 Bytes). Note that some
characters may be larger than 1 Byte
@example
using Toybox.Background;
(:background)
class BackgroundServiceDelegate extends System.ServiceDelegate {
function initialize() {
ServiceDelegate.initialize();
}

function onTemporalEvent() {
Background.requestApplicationWake("Launch Cool App?");
Background.exit(null);
}
}
@see Toybox::System::ServiceDelegate
@see Toybox::Background#exit Background.exit()
@since 2.3.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForPushNotificationEvent registerForPushNotificationEvent()}
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForPushNotificationEvent(), otherwise +false+
@since 3.0.10
]]> Stops the application from receiving background phone app messages.
@since 3.2.0
]]> Clear the last run time for temporal event.
@since 3.2.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForPhoneAppMessageEvent registerForPhoneAppMessageEvent()}
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForPhoneAppMessageEvent(), otherwise +false+
@since 3.2.0
]]> Get the Moment or Duration with which a background event is registered by
{Toybox::Background#registerForTemporalEvent registerForTemporalEvent()}.
Returns [Toybox::Time::Moment, Toybox::Time::Duration] The specific

Moment in time at which a background event is registered to trigger,
or the interval Duration at which to repeat a background event. May
be +null+ if no temporal background event is registered.
@see Toybox::Time
@since 3.0.0
]]> Terminates the current background process.

All background processes should call this method when they have completed
the desired tasks. Data passed to this method will either be passed
immediately to the active application if it is running, or will be saved
and passed to the application the next time it runs. Data must be one of
the following types:
* {Toybox::Lang::String String}
* {Toybox::Lang::Number Number}
* {Toybox::Lang::Float Float}
* {Toybox::Lang::Boolean Boolean}
* {Toybox::Lang::Char Char}
* {Toybox::Lang::Long Long}
* {Toybox::Lang::Double Double}
* {Toybox::Lang::Array Array}
* {Toybox::Lang::Dictionary Dictionary}
Arrays and Dictionaries may contain +null+ values or any of the above
listed types. If no data should be passed to the main process, +null+ may
be specified.

This method will exit if called by a background process, but will do
nothing if called by the main application process.

backgroundData [Toybox::Lang::Object] The object to pass to the

main process's
{Toybox::Application::AppBase#onBackgroundData AppBase.onBackgroundData()}
method. Passing +null+ will not override previous data values not yet consumed
by the parent application's AppBase.onBackgroundData() method.
@throws [Toybox::Background::ExitDataSizeLimitException] Indicates the
data provided exceeds the data size limit (approximately 8 KB). If this
exception is caught, the process will not exit and should attempt to
call +Background.exit()+ again with less data.
@since 2.3.0
]]> Remove the active wake background event for the application.
@since 2.3.0
]]> Stops the application from receiving activity completed events.
@since 3.0.10
]]> Get whether a background event is registered with
{Toybox::Background#registerForStepsEvent registerForStepsEvent()}.
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForStepsEvent(), otherwise +false+
@since 3.0.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForActivityCompletedEvent registerForActivityCompletedEvent()}
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForActivityCompletedEvent(), otherwise +false+
@since 3.0.10
]]> Get whether a background event is registered with
{Toybox::Background#registerForGoalEvent registerForGoalEvent()}.
goalType [Toybox::Application::GoalType] An

{Toybox::Application::GOAL_TYPE_STEPS Application.GOAL_TYPE_*} value
representing the goal type to check for registered background events
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForGoalEvent(), otherwise +false+
@since 3.0.0
]]> Get whether a background event is registered with
{Toybox::Background#registerForSleepEvent registerForSleepEvent()}.
Returns [Toybox::Lang::Boolean] +true+ if a background event is registered

with registerForSleepEvent(), otherwise +false+
@since 3.0.0
]]> Remove the active temporal background event for the application.
@since 2.3.0
]]> Get the current {Toybox::Position::Info Position.Info}.

Using this API requires enabling the Positioning Permission.
This is useful for retrieving the current position info either on demand
or periodically within a {Toybox::Timer::Timer Timer}.
Returns [Toybox::Position::Info]

@example Get position info once per second
using Toybox.Position;
using Toybox.System;
using Toybox.Timer;
var dataTimer = new Timer.Timer();
dataTimer.start(method(:timerCallback), 1000, true); // A one-second timer
function timerCallback() {
var positionInfo = Position.getInfo();
if (positionInfo has :altitude && positionInfo.altitude != null) {
var altitude = positionInfo.altitude;
System.println("Altitude: " + altitude);
}
}
@since 1.0.0
]]> Convert a String to a Location object.

The input String must be in one of the four formats described by the
Position.GEO_* constants.
string [Toybox::Lang::String] The String to parse

format [Toybox::Position::CoordinateFormat] A Position.GEO_* value

Returns [Toybox::Position::Location] A Location object representing the

position described by the input String
@example
using Toybox.Position;
using Toybox.System;
var locString = "38.856147, -94.800953";
var myLocation = Position.parse(locString, Position.GEO_DEG);
System.println(myLocation.toRadians()); // [0.678168, -1.654589]
@since 1.0.0
]]> Create a bounding box from an array of {Toybox::Position::Location Location} objects.

locations [Toybox::Lang::Array] Array of {Toybox::Position::Location Location} objects.

Returns [Toybox::Lang::Array] Array of {Toybox::Position::Location Location}

objects that specify the bounds of the input array or +null+ if the the
input array is empty. The first element describes the top left corner,
the second describes the bottom right.
@since 3.0.3
]]> Convert {Toybox::Position::Info Position.Info} into a String
Returns [Toybox::Lang::String]

@since 1.0.0
]]> Request a Location event.

Using this API requires enabling the Positioning Permission.
Only Device Apps and Widgets may use this API.
options [Toybox::Lang::Number,Toybox::Lang::Dictionary] A LOCATION_* value or {Toybox::Lang::Dictionary} of options.

@option options [Toybox::Position::LocationAcquisitionType] :acquisitionType A LOCATION_* enum value indicating the
position acquisition type to use.
@option options [Toybox::Lang::Array] :constellations An array of CONSTELLATION_* enum values
specifying what constellations to enable. If not provided, CONSTELLATION_GPS will be used by default.
listener [Toybox::Lang::Method] A reference to a listener method:

* Called when location updates are received
* Receives a Position.Info object
@option options [Toybox::Position::Configuration] :configuration A CONFIGURATION_* value
specifying what configuration to enable. Only available with ConnectIQ 3.3.6 and later.
@option options [Toybox::Position::PositioningMode] :mode a POSITIONING_MODE_* value specifying the mode to use.
If +null+ POSITIONING_MODE_NORMAL will be used by default.
@throws [Toybox::Lang::InvalidValueException] Thrown if :acquisitionType is invalid, if a
specific CONSTELLATION_* value is not supported by a device, or if an invalid combination of
constellation values are specified.
@note Passing an options {Toybox::Lang::Dictionary Dictionary} is only supported with ConnectIQ 3.2.0 and later.
@note Passing the +:configuration+ option is only supported with ConnectIQ 3.3.6 or later.
@note Multitasking: Location events will be disabled when app enters inacitve state, and re-enabled when is active again.
These state changes are denoted by calls to AppBase.onActive() and AppBase.onInactive().
@example
using Toybox.Position;

var options = {
:acquisitionType => Position.LOCATION_CONTINUOUS
};

if (Position has :POSITIONING_MODE_AVIATION) {
options[:mode] = Position.POSITIONING_MODE_AVIATION;
}

if (Position has :hasConfigurationSupport) {
if ((Position has :CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5) &&
Position.hasConfigurationSupport(Position.CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5)) {
options[:configuration] = Position.CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1_L5;
} else if ((Position has :CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1) &&
Position.hasConfigurationSupport(Position.CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1)) {
options[:configuration] = Position.CONFIGURATION_GPS_GLONASS_GALILEO_BEIDOU_L1;
} else if ((Position has :CONFIGURATION_GPS) &&
Position.hasConfigurationSupport(Position.CONFIGURATION_GPS)) {
options[:configuration] = Position.CONFIGURATION_GPS;
}
} else if (Position has :CONSTELLATION_GLONASS) {
// this can fail with InvalidValueException if combination is not supported by device
options[:constellations] = [ Position.CONSTELLATION_GPS, Position.CONSTELLATION_GLONASS ];
} else {
options = Position.LOCATION_CONTINUOUS;
}

// Continuous location updates using selected options
Position.enableLocationEvents(options, method(:onPosition));

function onPosition(info) {
var myLocation = info.position.toDegrees();
}

@since 1.0.0
]]> Control the display backlight.

The backlight will always respect the backlight timeout settings on the device.
Behavior of this feature may also change depending on device settings. For example, if a device is set to activate the back light with key
presses, the backlight will toggle on with key presses even if the app is written to turn off the back light with a key press.

On products that use a gesture enabled display, calling this API will suppress the gesture detection for the period that the backlight is
on. Calling this repeatedly can hold the display on, but if the product has burn in protection an exception will be thrown if you attempt
to keep the display enabled for too long (e.g. over 1 minute).

setting [Toybox::Lang::Boolean, Toybox::Lang::Float]

* If +setting+ is a {Toybox::Lang::Boolean Boolean}, +false+ will disable the backlight and +true+
will enable the backlight at the system backlight level.
* If +setting+ is a {Toybox::Lang::Float Float}, the value 0.0 will disable the backlight and values
greater than 0.0 and less than or equal to 1.0 will enable the backlight at the specified brightness.
@note Passing a {Toybox::Lang::Float Float} is only supported with ConnectIQ 3.2.1 and later.
@throws BacklightOnTooLongException On products with burn in protection, this exception is thrown if the backlight
is held on for too long continuously
@throws InvalidOptionsException If the Float value is outside the valid range.
@since 1.0.0
]]> Engage the vibration motor.

The vibrate method takes an Array containing at least one
{Toybox::Attention::VibeProfile VibeProfile} object, up to a maximum of 8,
and runs them in sequence.
@note Forerunner devices do not support vibration patterns. Vibration may
still be used, but the vibration will always run at the same duty cycle.
vibeProfiles [Toybox::Lang::Array] An Array of

{Toybox::Attention::VibeProfile VibeProfile} objects
@example Vibrate in an on/off pattern
if (Attention has :vibrate) {
vibeData =
[
new Attention.VibeProfile(50, 2000), // On for two seconds
new Attention.VibeProfile(0, 2000), // Off for two seconds
new Attention.VibeProfile(50, 2000), // On for two seconds
new Attention.VibeProfile(0, 2000), // Off for two seconds
new Attention.VibeProfile(50, 2000) // on for two seconds
];
}
Attention.vibrate(vibeData);
@see Toybox::Attention::VibeProfile
@since 1.0.0
]]> Play a tone.
options [Toybox::Attention::Tone, Toybox::Lang::Dictionary] A TONE_* value or

{Toybox::Lang::Dictionary Dictionary} of options.
@option options [Toybox::Lang::Array] :toneProfile Array containing at least one
{Toybox::Attention::ToneProfile ToneProfile} object to be played in sequence.
@option options [Toybox::Lang::Number] :repeatCount Number of times to repeat the given
tone sequence.
@note Passing an options {Toybox::Lang::Dictionary Dictionary} is only supported with ConnectIQ 3.1.0 and later.
@example
using Toybox.Attention;

// Play a predefined tone
if (Attention has :playTone) {
Attention.playTone(Attention.TONE_LOUD_BEEP);
}

// Use an array of ToneProfile objects to build and play a custom tone
if (Attention has :ToneProfile) {
var toneProfile =
[
new Attention.ToneProfile( 2500, 250),
new Attention.ToneProfile( 5000, 250),
new Attention.ToneProfile(10000, 250),
new Attention.ToneProfile( 5000, 250),
new Attention.ToneProfile( 2500, 250),
];
Attention.playTone({:toneProfile=>toneProfile});
}

@throws [Toybox::Lang::InvalidOptionsException]
Thrown if passing an options hash with invalid values when using new ToneProfile objects
@since 1.0.0
]]> Exit the {Toybox::Application::AppBase AppBase}
and launch it in sync mode.
@since 3.1.0
]]> Native function called after constructing the query string for GET requests

@see Toybox::Communications#makeImageRequestNative2
@deprecated This method may be removed after System 8.
@since 1.2.0
]]> Initiate a download request.

Web requests are asynchronous. The supplied response callback method
will be called when the request returns.
@example
// It is common for developers to wrap a makeWebRequest() call in a function
// as displayed below. The function defines the variables for each of the
// necessary arguments in a Communications.makeWebRequest() call, then passes
// these variables as the arguments. This allows for a clean layout of your web
// request and expandability.
using Toybox.System;
using Toybox.Communications;

// set up the response callback function
function onReceive(responseCode, data) {
if (responseCode == 200) {
System.println("Request Successful"); // print success
}
else {
System.println("Response: " + responseCode); // print response code
};

};

function makeRequest() {
var url = "https://www.garmin.com"; // set the url

var params = { // set the parameters
"definedParams" => "123456789abcdefg"
};

var options = { // set the options
:method => Communications.HTTP_REQUEST_METHOD_GET, // set HTTP method
:headers => { // set headers
"Content-Type" => Communications.REQUEST_CONTENT_TYPE_URL_ENCODED},
// set response type
:responseType => Communications.HTTP_RESPONSE_CONTENT_TYPE_URL_ENCODED
};

var responseCallback = method(:onReceive); // set responseCallback to
// onReceive() method
// Make the Communications.makeWebRequest() call
Communications.makeWebRequest(url, params, options, responseCallback);
}
url [Toybox::Lang::String] The URL being requested

parameters [Toybox::Lang::Dictionary] A Dictionary of keys and

values.
* These values should not be URL encoded.
* Can be +null+.
options [Toybox::Lang::Dictionary] A Dictionary of

options.
responseCallback [Toybox::Lang::Method] A reference to

a callback method which must accept two arguments:
* responseCode: The server response code or a BLE_* error type
* data: The content if the request was successful, or +null+
@option options [Toybox::Communications::HttpRequestMethod] :method The HTTP method of the
request. This should be an HTTP_REQUEST_METHOD_* value.
@option options [Toybox::Lang::Dictionary] :headers A Dictionary of HTTP
headers to include in the request.
* The "Content-Type" header for the body of the request can be specified using a {Toybox::Communications REQUEST_CONTENT_TYPE_*} value.
* If the content type is not specified, it will default to "application/json" for GET and DELETE requests, and will default to "application/x-www-form-urlencoded" for POST and PUT requests.
* By default, DELETE requests will have their parameters appended to the URL.
* Setting the method as DELETE as well as a "Content-Type" header will result in the parameters being set in the body of the request and they will not be appended to the URL.
* GET requests can only have their parameters appended to the URL, specifying the "Content-Type" header will not set the body.
@option options [Toybox::Communications::HttpResponseContentType] :responseType The format of the response.
* This should be an {Toybox::Communications HTTP_RESPONSE_CONTENT_TYPE_*} value.
* If HTTP_RESPONSE_CONTENT_TYPE_FIT or HTTP_RESPONSE_CONTENT_TYPE_GPX is given, the system will attempt to download and parse a FIT or GPX file and store the contained data in the device, based on the contents of the file.
* If not given, the system will use the Content-Type header from the server response to determine the format of the response body. If the Content-Type header from the response is not one of the known HTTP_RESPONSE_CONTENT_TYPE_* types, an error will occur.
@option options [Toybox::Lang::Object] :context A user-specific context object to be passed to the
response callback. The callback will need to accept a third parameter if this value is
populated.
@option options [Toybox::Media::Encoding] :mediaEncoding The encoding of
the audio content that is being downloaded. Should be a
{Toybox::Media Media.ENCODING_*} value.
@option options [Toybox::Lang::Number] :maxBandwidth maximum bandwidth.
TVM will select the audio stream with the highest bandwidth that's less than or equal to the maximum
This option is only effective when processing HLS content
@option options [Toybox::Lang::Method] :fileDownloadProgressCallback
a callback method which must accept two parameters
* totalBytesTransferred: The total number of bytes transferred for the current file download
* fileSize: The size of the file being downloaded. Note that this can be +null+ if file size cannot be determined from the server.
* This option is only supported for media file download progress
* This option is supported since CIQ 3.2.0
@throws [Toybox::Lang::InvalidOptionsException]
Thrown if a required option for a particular request is omitted
@throws [Toybox::Lang::SymbolNotAllowedException]
Thrown if a given :responseType option is not supported for the device the request is being made from.
An example would be using HTTP_RESPONSE_CONTENT_TYPE_AUDIO on a device that does not support audio content provider apps
@note This method can be used when connected to WiFi or a mobile device over Bluetooth.
@since 1.3.0
]]> Build a URL string with GET parameters

url [Toybox::Lang::String] The base URL with no parameters

params [Toybox::Lang::Dictionary] The dictionary of params and values

urlEncode [Toybox::Lang::Boolean] If +true+, the keys and values will be url encoded before appending

Returns [Toybox::Lang::String]

@since 1.0.0
]]> Convert a URL String into a percent-encoded string.

The reserved characters in the string will be replaced with their
corresponding hex-value pairs. This follows the URI-encoding scheme as
detailed by RFC 3986.
@see https://www.ietf.org/rfc/rfc3986.txt RFC 3986
url [Toybox::Lang::String] The URL String to be encoded

Returns [Toybox::Lang::String] A percent-encoded String

@since 1.1.2
]]> Revoke a push notification token from the server.

callback [Toybox::Lang::Method] A reference to a callback

method that is invoked when token revocation is successful, which must
accept two arguments:
* responseCode: the server response code or a BLE_* error type
* data: an Object if an error occurs, otherwise +null+
@since 3.0.10
]]> Initiate an image download request.

GCM will scale and dither the image based on the capabilities of the
device, but the user will be able to pass additional options (like
dithering it down to a one color image)
@example
using Toybox.System;
using Toybox.Communications;

var image;
var responseCode;

// Set up the responseCallback function to return an image or null
function responseCallback(responseCode, data) {
responseCode = responseCode;
if (responseCode == 200) {
image = data;
} else {
image = null;
}
}

// wrap the request in a function
function makeRequest() {
var url = "http://www.garmin.com/image-path"; // set the image url
var parameters = null; // set the parameters
var options = { // set the options
:palette => [ Gfx.COLOR_ORANGE, // set the palette
Gfx.COLOR_DK_BLUE,
Gfx.COLOR_BLUE,
Gfx.COLOR_BLACK ],
:maxWidth => 100, // set the max width
:maxHeight => 100, // set the max height
:dithering => Communications.IMAGE_DITHERING_NONE // set the dithering
};

// Make the image request
Communications.makeImageRequest(url, parameters, options, method(:responseCallback));
}
url [Toybox::Lang::String] The URL of an image to request

parameters [Toybox::Lang::Dictionary, null] The Dictionary of keys and

values
* Appended to the URL
* Can be +null+
options [Toybox::Lang::Dictionary] Additional image options

@option options [Toybox::Lang::Array] :palette The color palette to restrict the image
dithering to. Using a smaller palette can reduce the size of the image
data to speed up transfers
@option options [Toybox::Lang::Number] :maxWidth The maximum width an
image should be scaled to
@option options [Toybox::Lang::Number] :maxHeight The maximum height an
image should be scaled to
@option options [Toybox::Communications::Dithering] :dithering The type of dithering
to use when processing the image. Defaults to
{Toybox::Communications::IMAGE_DITHERING_FLOYD_STEINBERG IMAGE_DITHERING_FLOYD_STEINBERG}
@option options [Toybox::Communications::PackingFormat] :packingFormat The format of the
image data to request. Defaults to
{Toybox::Communications::PACKING_FORMAT_DEFAULT PACKING_FORMAT_DEFAULT}
responseCallback [Toybox::Lang::Method] A reference to a callback

method which must accept two arguments:
* responseCode: The server response code or a BLE_* error type
* data: A {Toybox::WatchUi::BitmapResource BitmapResource} or {Toybox::Graphics::BitmapReference BitmapReference} from a successful request, or +null+ on error
@note This method can be used when connected to WiFi or a mobile device over Bluetooth.
@since 1.2.0
]]> Get the MailboxIterator for this Application's mailbox.
Returns [Toybox::Communications::MailboxIterator] Iterator for the

mailbox
@since 1.0.0
@deprecated This method may be removed after System 4.
@see Toybox::Communications#registerForPhoneAppMessages Communications.registerForPhoneAppMessages()
]]> Add a listener for mailbox events.

The listener method is called whenever a new message is received.
listener [Toybox::Lang::Method] A reference to a

callback method which must accept an iterator. The iterator is the
mailbox iterator for the app
@since 1.0.0
@deprecated This method may be removed after System 4.
@see Toybox::Communications#registerForPhoneAppMessages Communications.registerForPhoneAppMessages()
]]> Register a callback for receiving OAuth messages.

The callback will be called once for each received OAuth message.
If there are messages waiting for the app when this function is
called, the callback will immediately be called once for each waiting
message.
method [Toybox::Lang::Method] A reference to a callback, which

must receive a +data+ argument of the type
{Toybox::Communications::OAuthMessage OAuthMessage}.
@example
using Toybox.Communications;

function onOAuthMessage(message) {
if (message.data != null) {
var code = message.data[OAUTH_CODE];
var error = message.data[OAUTH_ERROR];
} else {
// return an error
}
}
Communications.registerForOAuthMessages(method(:onOAuthMessage));

@since 1.3.0
]]> @since 1.2.0
]]> Send a system notification to indicate that the sync completed.
errorMessage [Toybox::Lang::String] A descriptive error message

if a failure occurred. If the sync completes successfully, +null+ should
be passed to this method.
@since 3.1.0
]]> Send a system notification to indicate overall sync progress.
percentageComplete [Toybox::Lang::Number] An integer from 0 to

100 indicating the completion percentage.
@since 3.1.0
]]> Get a push notification token from the server.

callback [Toybox::Lang::Method] A reference to a callback method

that is invoked when a token is received from the server, which must accept
two arguments:
* responseCode: the server response code or a BLE_* error type
* data: the token as String
@since 3.0.10
]]> Cancel all pending JSON and Image requests.

The number of active requests running in parallel is limited in the
Connect IQ platform. This call will cancel all outstanding requests.
@since 1.2.0
]]> Initiate a download request.

The request is asynchronous; the responseCallback will be called when
the request returns.
url [Toybox::Lang::String] The URL being requested

parameters [Toybox::Lang::Dictionary] A Dictionary of keys and

values
* Appended to the URL for GET/DELETE request
* Set as the body for a POST/PUT request
* These values must be URL encoded
* Can be +null+
options [Toybox::Lang::Dictionary] A Dictionary of options

* Can be +null+
@option options [Toybox::Communications::HttpRequestMethod] :method The HTTP method of the
request. This option should be an HTTP_REQUEST_METHOD_* value.
@option options [Toybox::Lang::Dictionary] :headers A Dictionary of HTTP
headers to include in the request
* The "Content-Type" header for the body of the request can be specified using a REQUEST_CONTENT_TYPE_* value
* This is only valid for methods PUT and POST (you cannot set a body for a GET or DELETE request)
* If the content type is not specified, it will default to "application/json" for GET and DELETE requests, and will default to "application/x-www-form-urlencoded" for POST and PUT requests
responseCallback [Toybox::Lang::Method] A reference to a

callback method which must accept two arguments:
* responseCode: the server response code
* data: the content if the request was successful, or +null+
@since 1.0.0
@deprecated This method may be removed after System 4.
@note This method can be used when connected to WiFi or a mobile device over Bluetooth.
@see Toybox::Communications#makeWebRequest Communications.makeWebRequest().
]]> Checks if an internet-enabled WIFI access point is visible and can be connected to

connectionStatusCallback [Toybox::Lang::Method] A callback that

will be invoked after the connection test has completed. This callback
accepts a single dictionary parameter. This dictionary has two keys:
* :wifiAvailable +true+ if an access point with internet access could
be connected to, +false+ otherwise
* :errorCode If :wifiAvailable is +false+ the value will be a
{Toybox::Communications::WIFI_CONNECTION_STATUS_LOW_BATTERY WIFI_CONNECTION_STATUS_*}
indicating why the connection is not available.
@since 3.2.0
]]> Send data across the the BLE link.

Support for transmittable types has been expanded over time.
* {Toybox::Lang::ByteArray ByteArray} (Since 6.0.0)
content [Toybox::Communications::TransmitType] The object to be sent

options [Toybox::Lang::Dictionary] Additional transmit options

for future proofing. For now, an empty Dictionary is used.
listener [Toybox::Communications::ConnectionListener] An

extension of the ConnectionListener class
@since 1.0.0
]]> Register a callback for receiving Phone App messages.

The callback will be called once for each message received. If there are
messages waiting for the app when this function is called, the
callback will immediately be called once for each waiting message.
method [Toybox::Lang::Method] A reference to a callback, which

must receive a +data+ argument of the type
{Toybox::Communications::PhoneAppMessage PhoneAppMessage}.
@example
using Communications;

function phoneMessageCallback(msg as PhoneAppMessage) as Void {
System.println(Lang.format("Data: $1$", [ msg.data ]));
}

// register for messages
Communications.registerForPhoneAppMessages(method(:phoneMessageCallback));
@see Toybox::Communications::PhoneAppMessage
@see Toybox::Communications#registerForPhoneAppMessageErrors Communications.registerForPhoneAppMessageErrors()
@since 1.4.0
]]> Clear the contents of the mailbox.
@since 1.0.0
@deprecated This method may be removed after System 4.
@see Toybox::Communications#registerForPhoneAppMessages Communications.registerForPhoneAppMessages()
]]> Request that GCM issue a phone notification that will open a web page.

This method will push a phone notification that must be accepted by the
user. If the used accepts it, a web page defined by this method will be
opened in the default browser on the phone.
url [Toybox::Lang::String] The URL to open.

params [Toybox::Lang::Dictionary] The URL parameters used to add

to the pages web page URL.
Parameters should not be URL encoded.
options [Toybox::Lang::Dictionary] Additional options for the

request
@example
using Toybox.Communications;
Communications.openWebPage(
"http://www.bing.com/images/search",
{"q" => "cute kitten"},
null
);
// passes the url: http://bing.com/images/search?q=cute kitten to the
// browser on the phone
@note This method can only be used when connected to a mobile device over Bluetooth.
@since 1.3.0
]]> Request an OAuth sign-in through Garmin Connect Mobile.

A notification will trigger on the phone, that when clicked, provides a
web view that shows +requestUrl+. If the user grants permission to the app,
then the callback registered by
{Toybox::Communications#registerForOAuthMessages registerForOAuthMessages()}
will be called with an {Toybox::Communications::OAuthMessage OAuthMessage}
from the OAuth response.
@example
using Toybox.Communications;
using Toybox.System;

const CLIENT_ID = "myClientID";
const OAUTH_CODE = "myOAuthCode";
const OAUTH_ERROR = "myOAuthError";

// register a callback to capture results from OAuth requests
Communications.registerForOAuthMessages(method(:onOAuthMessage));

// wrap the OAuth request in a function
function getOAuthToken() {
status = "Look at OAuth screen\n";
Ui.requestUpdate();

// set the makeOAuthRequest parameters
var params = {
"scope" => Comm.encodeURL("https://www.serviceurl.com/"),
"redirect_uri" => "https://localhost",
"response_type" => "code",
"client_id" => $.CLIENT_ID
};

// makeOAuthRequest triggers login prompt on mobile device.
// "responseCode" and "responseError" are the parameters passed
// to the resultUrl. Check the oauth provider's documentation
// to determine the correct strings to use.
Comm.makeOAuthRequest(
"https://requesturl.com",
params,
"http://resulturl.com",
Comm.OAUTH_RESULT_TYPE_URL,
{"responseCode" => $.OAUTH_CODE, "responseError" => $.OAUTH_ERROR}
);
}

// implement the OAuth callback method
function onOAuthMessage(message) {
if (message.data != null) {
var code = message.data[$.OAUTH_CODE];
var error = message.data[$.OAUTH_ERROR];
} else {
// return an error
}
}
// the OAuth service can now be used with a makeWebRequest() call
requestUrl [Toybox::Lang::String] The URL to load in the web view

to begin authentication
requestParams [Toybox::Lang::Dictionary] Non-URL encoded parameters

for the +requestUrl+
resultUrl [Toybox::Lang::String] The URL of the final page of

authentication that contains the +resultKeys+
resultType [Toybox::Lang::TokenResult] An OAUTH_RESULT_TYPE_* value

that specifies the format of the result
resultKeys [Toybox::Lang::Dictionary] The desired OAuth response

values passed to the callback method. The keys map to the actual OAuth
response keys, and the values map to the keys of the
{Toybox::Communications::OAuthMessage OAuthMessage} data.
@note This method can only be used when connected to a mobile device over Bluetooth.
@since 1.3.0
]]> Generate the value for the "Authorization" header in an OAuth 1.0a
request.

The returned value can be set as the "Authorization" header for
{Toybox::Communications#makeWebRequest makeWebRequest()}.
@note It is recommended to use OAuth 2.0 instead of OAuth 1.0a. See {Toybox::Communications#makeOAuthRequest}.
url [Toybox::Lang::String] The request URL

params [Toybox::Lang::Dictionary] The parameters of the request

requestMethod [Toybox::Communications::HttpRequestMethod] An HTTP_REQUEST_METHOD_*

value
signatureMethod [Toybox::Communications::SigningMethod] An OAUTH_SIGNING_METHOD_*

value
token [Toybox::Lang::String, null] The token given by the OAuth

service
* Can be +null+
tokenSecret [Toybox::Lang::String] The token secret given by the

OAuth service. Used to sign the request
consumerKey [Toybox::Lang::String] The key that identifies your

application
consumerSecret [Toybox::Lang::String] The consumer secret that is

used to sign the request
Returns [Toybox::Lang::String] The value for the "Authorization" header

@since 1.3.0
@deprecated This method may be removed after System 10.
]]> Exit the {Toybox::Application::AudioContentProviderApp AudioContentProviderApp}
in its current mode and launch it in playback mode.
args [Toybox::Lang::Object] A serializable object to pass to

{Toybox::Application::AudioContentProviderApp#getContentDelegate AudioContentProviderApp.getContentDelegate()}
when the app starts in playback mode.
@throws [Toybox::Lang::SerializationException] Thrown when the given
argument cannot be serialized or is too large for serialization.
@since 3.0.0
]]> Exit the {Toybox::Application::AudioContentProviderApp AudioContentProviderApp}
in its current mode and launch it in sync mode.
@since 3.0.0
@deprecated This method may be removed after System 9.
@see Toybox::Communications#startSync Communications.startSync()
]]> Get the current size statistics of the media cache.
Returns [Toybox::Media::CacheStatistics] The current CacheStatistics object

@since 3.0.0
]]> Get a {Toybox::Media::Content Content} object by ID from what has been
persisted on the system.
contentRef [Toybox::Media::ContentRef] The ContentRef object for

the desired media {Toybox::Media::Content Content}
@throws [Toybox::Lang::UnexpectedTypeException]
Thrown if contentRef parameter is not a valid {Toybox::Media::ContentRef ContentRef} object
Thrown if ID field of provided {Toybox::Media::ContentRef ContentRef} object is not a string
but content type is set to CONTENT_TYPE_AUDIO
@throws [Toybox::Lang::InvalidOptionsException]
Thrown if provided {Toybox::Media::ContentRef ContentRef} has an invalid content type
Returns [Toybox::Media::Content] The desired Content object

@since 3.0.0
]]> Set the album art for the currently playing song
albumArt [Toybox::WatchUi::BitmapResource, Toybox::Graphics::BitmapReference] The album art to display. If +null+ then the

system's default album art will be displayed.
@note {Toybox::Graphics::BitmapReference BitmapReference} is only supported in CIQ 4.0.0 and later
@since 3.0.10
]]> Delete the cached media content and reset the encryption key for the app.
@since 3.0.0
]]> Delete an individual cached media item.
contentRef [Toybox::Media::ContentRef] The ContentRef for the

{Toybox::Media::Content Content} object to be deleted
@since 3.0.0
]]> Stops playback if it was initiated by the app. If playback was not initiated by the app,
calling stopPlayback() will do nothing.
@since 3.1.8
]]> Send a system notification to indicate that the sync completed.
errorMessage [Toybox::Lang::String] A descriptive error message

if a failure occurred. If the sync completes successfully, +null+ should
be passed to this method.
@since 3.0.0
@deprecated This method may be removed after System 9.
@see Toybox::Communications#notifySyncComplete Communications.notifySyncComplete()
]]> Send a system notification to indicate overall sync progress.
percentageComplete [Toybox::Lang::Number] An integer from 0 to

100 indicating the completion percentage.
@since 3.0.0
@deprecated This method may be removed after System 9.
@see Toybox::Communications#notifySyncProgress Communications.notifySyncProgress()
]]> Request that the media player call {Toybox::Media::ContentIterator#getPlaybackProfile ContentIterator.getPlaybackProfile()}
@since 3.0.3
]]> Get a {Toybox::Media::ContentRefIterator ContentRefIterator} object.

The ContentRefIterator is used to iterate over all cached media on the
system for the calling app.
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Media::ContentType] :contentType One of the
{Toybox::Media::CONTENT_TYPE_INVALID CONTENT_TYPE_*} values that
indicates the type of cached content.
@option options [Toybox::Lang::Boolean] :shuffle
* When +true+, the {Toybox::Media::ContentRef ContentRef} objects will be returned in a random order
* When +false+, the {Toybox::Media::ContentRef ContentRef} objects will be returned in a consistent order that is system dependent
@throws [Toybox::Lang::InvalidOptionsException] Thrown if :contentType value is invalid
@since 3.0.0
Returns [Toybox::Media::ContentRefIterator]

]]> Create a formatted String by substituting the given parameters into the
given format at the corresponding locations.
format [Toybox::Lang::String] A string using $1$, $2$, $3$... as

substitution identifiers
parameters [Toybox::Lang::Array] The Array of content to substitute

into the formatted String
Returns [Toybox::Lang::String] A new String with the substituted content

@example
// Set the 'myString' variable to "Your next meeting is at 2:30 on Sep 4 in room 6820."
using Toybox.Lang
var myFormat = "Your next meeting is at $1$:$2$ on $3$ $4$ in room $5$.";
var myParams = [2, 30, "Sep", 4, "6820"];
var myString = Lang.format(myFormat, myParams);
@since 1.0.0
]]> Get the waypoints installed on the system
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

var iterator = PersistedContent.getWaypoints(); // Get the Iterator
Returns [Toybox::PersistedContent::Iterator] The Iterator of {Toybox::PersistedContent::Waypoint Waypoints} from

the routes list
@since 2.2.0
]]> Get the subset of waypoints installed on the system that are owned by
the application
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

// Get an iterator for all waypoints owned by this application
var iterator = PersistedContent.getAppWaypoints();
Returns [Toybox::PersistedContent::Iterator] An Iterator over the persisted content objects requested

@since 3.0.0
]]> Get the courses installed on the system
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

var iterator = PersistedContent.getCourses(); // Get the Iterator
Returns [Toybox::PersistedContent::Iterator] The Iterator of

{Toybox::PersistedContent::Course Course} objects
@since 2.2.0
]]> Save a {Toybox::Position::Location Location} as a
{Toybox::PersistedContent::Waypoint Waypoint} to the device's
location list
location [Toybox::Position::Location] The Location object to

persist
options [Toybox::Lang::Dictionary] The Dictionary of options, or

+null+ to accept defaults
@option options [Toybox::Lang::String] :name The name to assign to the
waypoint. If not specified the waypoint will be named automatically.
@example
using Toybox.PersistedContent;
using Toybox.Position;

var location = new Position.Location(
{
:latitude => ,
:longitude => ,
:format => :degrees
}
);
PersistedContent.saveWaypoint(location, {:name => "Cool Waypoint Name"});
@see Toybox::Position::Location
@since 2.2.0
]]> Get the workouts installed on the system
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

var iterator = PersistedContent.getWorkouts(); // Get the Iterator
Returns [Toybox::PersistedContent::Iterator] The Iterator of {Toybox::PersistedContent::Workout Workout} objects

@since 2.2.0
]]> Get the subset of courses installed on the system that are owned by
the application
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

// Get an iterator for all courses owned by this application
var iterator = PersistedContent.getAppCourses();
Returns [Toybox::PersistedContent::Iterator] An Iterator over the

persisted content objects requested
@since 3.0.0
]]> Get the subset of workouts installed on the system that are owned by
the application
@example
// Assumes content already saved on device
using Toybox.PersistedContent;

// Get an iterator for all workouts owned by this application
var iterator = PersistedContent.getAppWorkouts();
Returns [Toybox::PersistedContent::Iterator] An Iterator over the persisted content objects requested

@since 3.0.0
]]> Get a text string to fit in a specified area

text [Toybox::Lang::String] The text to fit into the given area,

which may include newlines
font [Toybox::Graphics::FontType] The font to use when determining line

break placement
width [Toybox::Lang::Numeric] The width of the area to fit within

height [Toybox::Lang::Numeric] The height of the area to fit within

truncate [Toybox::Lang::Boolean] If +true+, the resulting string

may be truncated to fit within the provided area using the provided font
Returns Returns a String suitable for display in the given area. The

String will be truncated if the 'truncate' parameter is +true+ and the
String cannot fit into the specified area. Otherwise, +null+ will be
returned.
@note {Toybox::Graphics::FontReference FontReference} is only supported in CIQ 4.0.0 and later
@since 3.1.0
]]> Get the height (ascent plus descent) of the given font.
font [Toybox::Graphics::FontType] The font to use

Returns [Toybox::Lang::Number] The height of the font

@note {Toybox::Graphics::FontReference FontReference} is only supported in CIQ 4.0.0 and later
@since 1.2.0
]]> Get the recommended distance above the baseline for single spaced text.

The base line is the line on which the text sits.
font [Toybox::Graphics::FontType] The font to use

Returns [Toybox::Lang::Number] The ascent of the font

@note {Toybox::Graphics::FontReference FontReference} is only supported in CIQ 4.0.0 and later
@since 1.2.0
]]> Get the recommended distance below the baseline for single spaced text.

The base line is the line on which the text sits.
font [Toybox::Graphics::FontType] The font to use

Returns [Toybox::Lang::Number] The descent of the font

@note {Toybox::Graphics::FontReference FontReference} is only supported in CIQ 4.0.0 and later
@since 1.2.0
]]> Get the hourly forecast

Returns [Toybox::Weather::HourlyForecast] An array of hourly forecasts or +null+ if no data is available

@since 3.2.0
]]> Get the daily forecast

Returns [Toybox::Weather::DailyForecast] An array of daily forecasts or +null+ if no data is available

@since 3.2.0
]]> Get the most recently cached weather conditions

Returns [Toybox::Weather::CurrentConditions] or +null+ if no data is available

@since 3.2.0
]]> Get sunrise time for the provided location and date

location [Toybox::Position::Location] Location to get the sunset information

date [Toybox::Time::Moment] date to get the sunset information

Returns [Toybox::Time::Moment] Sunset time as moment or +null+ if no sunset time is available.

@since 3.3.0
]]> Get sunrise time for the provided location and date

location [Toybox::Position::Location] Location to get the sunrise information

date [Toybox::Time::Moment] date to get the sunrise information

Returns [Toybox::Time::Moment] Sunrise time as moment or +null+ if no sunrise time is available

@since 3.3.0
]]> Get an Array of ActivityMonitor.History objects
@since 1.0.0
Returns [Toybox::Lang::Array] An Array of

{Toybox::ActivityMonitor::History ActivityMonitor.History} objects.
* The Array will be a maximum of 7 objects
* The objects will be inserted most recent first
]]> Get the current {Toybox::ActivityMonitor::Info ActivityMonitor.Info}
@since 1.0.0
Returns [Toybox::ActivityMonitor::Info] An Info object with the

current information.
]]> Get the heart rate history for the given period, up to the last
power cycle.

This function always returns the most recent heart rate
samples. The time between each HeartRateSample in the iterator may be
device dependent.
@since 1.2.1
period [Toybox::Time::Duration, Toybox::Lang::Number] The period

of time from which to retrieve heart rate samples
* If period is +null+, the entire available history is retrieved
* If period is a {Toybox::Time::Duration Duration}, then the history for the given Duration is retrieved
* If period is a {Toybox::Lang::Number Number}, then the last Number entries are retrieved
newestFirst [Toybox::Lang::Boolean] The order in which to

retrieve heart rate samples
* +true+ to get the samples newest first
* +false+ to get the samples oldest first
Returns [ActivityMonitor.HeartRateIterator] An iterator for the heart

rate history for the given period
]]> Create a {Toybox::ActivityRecording::Session Session} object with
options determined by the caller.

Only one Session object is allowed to exist at a time. If there
is an existing object that has not been closed using the
{Toybox::ActivityRecording::Session#save save()} or
{Toybox::ActivityRecording::Session#discard discard()} methods, this method will
return that object instead of creating a new one. On some products
running the 1.x virtual machine, creating a Session object requires a
large memory allocation. To free this memory, the Session must first be
successfully saved or discarded, and then app references to the Session
object should be set to +null+.
@example Create a Session with auto lap detection using entry/exit lines
using Toybox.ActivityRecording;
function createSession() {
var session = ActivityRecording.createSession({ // set up recording session
:name=>"Race", // set session name
:sport=>Activity.SPORT_GENERIC, // set sport type
:subSport=>Activity.SUB_SPORT_GENERIC, // set sub sport type
:autoLap=>{ // auto lap configuration
:type=>:lines, // auto lap using entry/exit lines
:exit=>[loc1, loc2], // set exit of auto lap staging box (typically the finish line)
:entry=>[loc3, loc4], // set entrance of auto lap staging box (typically before the finish line)
:autoStart=>true // auto start using the entry/exit lines
}
});
return session;
}
options [Toybox::Lang::Dictionary] A Dictionary containing

session creation options.
@option options [Toybox::ActivityRecording::Sport, Toybox::Activity::Sport] :sport The primary sport being
recorded (SPORT_GENERIC by default).
@option options [Toybox::ActivityRecording::SubSport, Toybox::Activity::SubSport] :subSport The sport subcategory
being recorded (SUB_SPORT_GENERIC by default).
@option options [Toybox::Lang::String] :name Required. This is the name
that will be associated with the sport being recorded. The suggested
maximum length of the name is 15 characters (some devices support
longer names).
@option options [Toybox::Lang::Float] :poolLength This is the length of
the pool in meters for this activity. If this session object is configured
with +:sport=>SPORT_SWIMMING+ and +:subSport=>SUB_SPORT_LAP_SWIMMING+, this
option is required to configure the system in this mode. If it is not
provided, activity data may have undefined behavior. For all other sport
modes, this option is ignored.
@option options [Toybox::Lang::Dictionary] :autoLap A dictionary containing
auto-lap detection options. If present, this dictionary must have a +:type+ key;
If the value of +:type+ is +:lines+, the +:entry+ and +:exit+ keys are required. The
values associated with +:entry+ and +:exit+ describe the endpoints of the auto lap
entry and exit line segments, each being defined as an {Toybox::Lang::Array Array}
of two {Toybox::Position::Location Location} objects. (added in 3.0.10)
@option options [Toybox::SensorLogging::SensorLogger] :sensorLogger The
SensorLogger to use to record this session.
@throws [Toybox::Lang::InvalidOptionsException] Thrown if required options
are missing or provided options are invalid in +:autoLap+ options dictionary
Returns [Toybox::ActivityRecording::Session] A new Session object, or

the existing Session object if a Session is active and has not been
saved or discarded.
@since 1.0.0
]]> Register a callback for receiving OAuth messages.

The callback will be called once for each received OAuth message.
If there are messages waiting for the app when this function is
called, the callback will immediately be called once for each waiting
message.
method [Toybox::Lang::Method] A reference to a callback, which

must receive a +data+ argument of the type
{Toybox::Authentication::OAuthMessage OAuthMessage}.
@example
using Toybox.Authentication;

function onOAuthMessage(message) {
if (message.data != null) {
var code = message.data[OAUTH_CODE];
var error = message.data[OAUTH_ERROR];
} else {
// return an error
}
}
Authentication.registerForOAuthMessages(method(:onOAuthMessage));

@since 3.3.0
]]> Request an OAuth sign-in through Garmin Connect IQ Mobile App

A notification will trigger on the phone, that when clicked, provides a
web view that shows +requestUrl+. If the user grants permission to the app,
then the callback registered by
{Toybox::Authentication#registerForOAuthMessages registerForOAuthMessages()}
will be called with an {Toybox::Authentication::OAuthMessage OAuthMessage}
from the OAuth response.
@example
using Toybox.Authentication;
using Toybox.System;

const CLIENT_ID = "myClientID";
const OAUTH_CODE = "myOAuthCode";
const OAUTH_ERROR = "myOAuthError";

// register a callback to capture results from OAuth requests
Authentication.registerForOAuthMessages(method(:onOAuthMessage));

// wrap the OAuth request in a function
function getOAuthToken() {
status = "Look at OAuth screen\n";
Ui.requestUpdate();

// set the makeOAuthRequest parameters
var params = {
"redirect_uri" => "connectiq://oauth",
"response_type" => "code",
"client_id" => $.CLIENT_ID
};

// makeOAuthRequest triggers login prompt on mobile device.
// "responseCode" and "responseError" are the parameters passed
// to the resultUrl. Check the oauth provider's documentation
// to determine the correct strings to use.
Auth.makeOAuthRequest(
"https://requesturl.com",
params,
"http://resulturl.com",
Auth.OAUTH_RESULT_TYPE_URL,
{"responseCode" => $.OAUTH_CODE, "responseError" => $.OAUTH_ERROR}
);
}

// implement the OAuth callback method
function onOAuthMessage(message) {
if (message.data != null) {
var code = message.data[$.OAUTH_CODE];
var error = message.data[$.OAUTH_ERROR];
} else {
// return an error
}
}
// the OAuth service can now be used with a makeWebRequest() call
requestUrl [Toybox::Lang::String] The URL to load in the web view

to begin authentication
requestParams [Toybox::Lang::Dictionary] Non-URL encoded parameters

for the +requestUrl+
resultUrl [Toybox::Lang::String] The URL of the final page of

authentication that contains the +resultKeys+
resultType [Toybox::Authentication::OAuthResultType] An OAUTH_RESULT_TYPE_* value

that specifies the format of the result
resultKeys [Toybox::Lang::Dictionary] The desired OAuth response

values passed to the callback method. The keys map to the actual OAuth
response keys, and the values map to the keys of the
{Toybox::Authentication::OAuthMessage OAuthMessage} data.
@since 3.3.0
]]> Push a View onto the View stack.
view [Toybox::WatchUi::View] View to push

delegate [Toybox::WatchUi::BehaviorDelegate,

Toybox::WatchUi::ConfirmationDelegate,
Toybox::WatchUi::InputDelegate,
Toybox::WatchUi::MenuInputDelegate,
Toybox::WatchUi::NumberPickerDelegate,
Toybox::WatchUi::PickerDelegate,
Toybox::WatchUi::TextPickerDelegate,
Toybox::WatchUi::WatchFaceDelegate]
The input delegate to handle input for the View
transition [Toybox::WatchUi::SlideType] A

{Toybox::WatchUi::SLIDE_IMMEDIATE WatchUi.SLIDE_*} value
@throws [Toybox::Lang::UnexpectedTypeException]
Thrown when view is type {Toybox::WatchUi::MapView MapView} and the
visible map area parameters are invalid
@throws [Toybox::Lang::OperationNotAllowedException] Thrown if called
from background, data field, glance, or watch face app; or if the new
view is a {Toybox::WatchUi::DataField DataField},
a {Toybox::WatchUi::GlanceView GlanceView},
or a {Toybox::WatchUi::WatchFace WatchFace}
@since 1.0.0
]]> Animate an Object.

Animate works by changing an object property over time, such as the
x-position of a Drawable. The animation starts after the call and runs
the length of the specified period. During this time, the View object's
onUpdate() method will be invoked at an increased rate to facilitate
animation.
object [Toybox::Lang::Object] The object to animate

property [Toybox::Lang::Symbol] The Symbol of the object's property

to animate (e.g. :locX, :locY, etc.)
type [Toybox::WatchUi::AnimationType] A

{Toybox::WatchUi::ANIM_TYPE_LINEAR WatchUi.ANIM_TYPE_*} value
start [Toybox::Lang::Number] The starting value of the property

stop [Toybox::Lang::Number] The ending value of the property

period [Toybox::Lang::Float] The duration of the animation in seconds

callback [Toybox::Lang::Method] A Method to call when the animation

is complete; this can be +null+
@example Move a bitmap across the screen from left to right
using System.WatchUi;

square = new Ui.Bitmap({
:rezId=>Rez.Drawables.square,
:locX=>10,
:locY=>30
});
WatchUi.animate(square, :locX, Ui.ANIM_TYPE_LINEAR, 10, 200, 10, null);
@note Will cause an app crash if called from background or data field app,
or from watch face while in low power mode
@see Toybox::WatchUi::Drawable
@see Toybox::WatchUi::Bitmap
@since 1.0.0
]]> Load a resource from the executable.

resource [Toybox::Lang::ResourceId] An identifier for a resource

defined in the project's +resources.xml+ file
Returns [Toybox::Lang::Array, Toybox::Lang::Dictionary, Toybox::Lang::String, Toybox::WatchUi::AnimationResource, Toybox::WatchUi::BitmapResource, Toybox::WatchUi::FontResource, Toybox::Graphics::BitmapReference, Toybox::Graphics::FontReference]

@note {Toybox::Graphics::BitmapReference} and {Toybox::Graphics::FontReference} are returned
for {Toybox::WatchUi::BitmapResource} and {Toybox::WatchUi::FontResource} in CIQ 4.0.0 and later.
@example Loading a String resource
// The resources.xml file contents:
//
// APEELingApp
//
using Toybox.WatchUi;

var banana = WatchUi.loadResource(Rez.Strings.AppName);
@since 1.0.0
]]> initializes the Rez module of a Barrel so static variables can be accessed during startup (global )
@since 2.4.0
]]> Pop the current View from the View stack and push a new one.

view [Toybox::WatchUi::View] The View object to push

delegate [Toybox::WatchUi::BehaviorDelegate,

Toybox::WatchUi::InputDelegate]
The input delegate to handle input for the View
transition [Toybox::WatchUi::SlideType] A

{Toybox::WatchUi::SLIDE_IMMEDIATE WatchUi.SLIDE_*} value
@throws [Toybox::Lang::OperationNotAllowedException] Thrown if called
from background, data field, glance, or watch face app; or of called
from the base page of a widget and the new view is native; or if the new
view is a {Toybox::WatchUi::DataField DataField},
a {Toybox::WatchUi::GlanceView GlanceView},
or a {Toybox::WatchUi::WatchFace WatchFace}
@note Prior to ConnectIQ 3.1, this method only supported switching to
user-defined View objects, and would only accept InputDelegate or
BehaviorDelegate objects as delegates for the given View.
@since 1.0.0
]]> Cancel animations started with {Toybox::WatchUi#animate WatchUi.animate()}

Stop all animations that were started with {Toybox::WatchUi#animate WatchUi.animate()}.
This will leave all animations at their final frame, as if
{Toybox::WatchUi#animate WatchUi.animate()} ran to completion.

@see Toybox::WatchUi#animate WatchUi.animate()
@since 3.1.7
]]> initializes the Rez module so static variables can be accessed during startup (global )
@since 1.0.0
]]> Pop the current View from the View stack.
transition [Toybox::WatchUi::SlideType] A

{Toybox::WatchUi::SLIDE_IMMEDIATE WatchUi.SLIDE_*} value
@throws [Toybox::Lang::OperationNotAllowedException] Thrown if called
from background, data field, glance, or watch face app; or of called
from the base page of a widget
@since 1.0.0
]]> Request a call to the {Toybox::WatchUi::View#onUpdate onUpdate()} method
for the current View.
@see Toybox::WatchUi::View#onUpdate View.onUpdate()
@since 1.0.0
]]> @since 1.0.0
]]> Retrieve the AppBase {Toybox::Lang::Object Object} that is currently
running.
Returns [Toybox::Application::AppBase] The currently running AppBase

object
@since 1.0.0
]]> initializes the Rez module so static variables can be accessed during startup (global )
@since 3.1.0
]]> Load a resource from the executable.

resource [Toybox::Lang::ResourceId] An identifier for a resource

defined in the project's +resources.xml+ file
Returns [Toybox::Lang::Array, Toybox::Lang::Dictionary, Toybox::Lang::String, Toybox::WatchUi::AnimationResource, Toybox::WatchUi::BitmapResource, Toybox::WatchUi::FontResource, Toybox::Graphics::BitmapReference, Toybox::Graphics::FontReference]

@note {Toybox::Graphics::BitmapReference} and {Toybox::Graphics::FontReference} are returned
for {Toybox::WatchUi::BitmapResource} and {Toybox::WatchUi::FontResource} in CIQ 4.0.0 and later.
@example Loading a String resource
// The resources.xml file contents:
//
// APEELingApp
//
using Toybox.Application;

var banana = Application.loadResource(Rez.Strings.AppName);
@since 3.1.0
]]> initializes the Rez module of a Barrel so static variables can be accessed during startup (global )
@since 3.1.0
]]> Register a callback to fetch high-frequency data from various sensors.

The callback will get invoked each time a new set of sensor data over
the length of time specified in the period option is available.
@note Only one data request is allowed to be registered at a time.
Subsequent calls to this function for the same sensor type will
override previously registered requests.
listener [Toybox::Lang::Method] A method that takes a single

{Toybox::Sensor::SensorData SensorData} object as a parameter
that will contain the requested data.
options [Toybox::Lang::Dictionary] A Dictionary of options.

The allowed values depend on sensor type.
@option options [Toybox::Lang::Number] :period Period of time to request
samples in seconds. Maximum is 4 seconds.
@option options [Toybox::Lang::Boolean] :synchronous Set to +true+ to
request synchronized sensor data.
@note Magnetometer data is not supported in synchronous data request.
@option options [Toybox::Lang::Dictionary] :accelerometer Options for
accelerometer data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the accelerometer.
* :sampleRate ({Toybox::Lang::Number Toybox::Lang::Number}) Samples per
second to request in Hz.
* :includePower ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:accelerometer=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::AccelerometerData#power power Array} be computed.
* :includePitch ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:accelerometer=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::AccelerometerData#pitch pitch Array} be computed.
* :includeRoll ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:accelerometer=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::AccelerometerData#roll roll Array} be computed.
* :includeTimestamps ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:accelerometer=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::AccelerometerData#timestamp timestamp Array} be
included. This is useful for synchronizing data with other sensors.
@option options [Toybox::Lang::Dictionary] :heartBeatIntervals Options for
Heart Beat Interval data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch heart beat interval data.
@option options [Toybox::Lang::Dictionary] :gyroscope Options for
gyroscope data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the gyroscope.
* :sampleRate ({Toybox::Lang::Number Toybox::Lang::Number}) Samples per
second to request in Hz.
* :includeTimestamps ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:gyroscope=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::GyroscopeData#timestamp timestamp Array} be
included. This is useful for synchronizing data with other sensors.
@option options [Toybox::Lang::Dictionary] :magnetometer Options for
magnetometer data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the magnetometer.
* :sampleRate ({Toybox::Lang::Number Toybox::Lang::Number}) Samples per
second to request in Hz.
* :includeTimestamps ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Valid
only when +:magnetometer=>:enabled+ is set to +true+. Requests that
the {Toybox::Sensor::MagnetometerData#timestamp timestamp Array} be
included. This is useful for synchronizing data with other sensors.
@throws {Toybox::Sensor::TooManySensorDataListenersException}
Thrown if more than one listener is tried to register for sensor data.
@throws {Toybox::Lang::InvalidOptionsException}
Thrown if any required options are excluded, if provided options are out
of range, or are of the wrong type.
@example
using Toybox.Sensor;
// initialize accelerometer
var options = {
:period => 1, // 1 second sample time
:accelerometer => {
:enabled => true, // Enable the accelerometer
:sampleRate => 25 // 25 samples
},
:heartBeatIntervals => {
:enabled => true
}
};
// Using the callback setup in Toybox.SensorHistory.SensorData
Sensor.registerSensorDataListener(method(:accelCallback), options);
@see Toybox::ActivityRecording#createSession ActivityRecording.createSession()
@see Toybox::Sensor::SensorData
@note Will cause an app crash if called from a data field app
@since 2.3.0
]]> Retrieve the sensors that are currently registered.

This function returns an iterator for the sensors that are considered to be
`registered` if pairing information has been provided for it in Sensor settings.

sensorType [Toybox::Lang::Number, null] A SENSOR_* value that describes the sensor type

to enumerate, or +null+ to get all sensors.
Returns [Toybox::Sensor::SensorInfoIterator] An iterator of the sensors that are currently registered.

@since 3.2.0
]]> Unregister a previously registered data listener.
@example
// Assuming use of registerSensorDataListener() example and mSession
using Toybox.Sensor;

Sensor.unregisterSensorDataListener(); // Unregister Listener
mSession.stop(); // Stop Activity Recording
@see Toybox::Sensor#registerSensorDataListener Sensor.registerSensorDataListener()
@note Will cause an app crash if called from a data field app
@since 2.3.0
]]> Enable sensors for use.

This will enable both connected ANT+ sensors and system sensors if possible.
sensors [Toybox::Lang::Array] The sensors to enable:

* An Array of SENSOR_* types to enable
* An empty array ([]) to disable all sensors
Returns [Toybox::Lang::Array] An Array of requested sensors that are available

@example Enable a heart rate sensor
using Toybox.Sensor;
Sensor.setEnabledSensors([Sensor.SENSOR_HEARTRATE]);
@note Will cause an app crash if called from a data field app
@note Multitasking: Sensor states can not be changed while in inacitve mode
and sensor enabled during active mode will be disabled when app becomes inactive,
and re-enabled automatically when is active again.
These state changes are denoted by calls to AppBase.onActive() and AppBase.onInactive().
@since 1.0.0
]]> Request sensor events from enabled sensors.

Sensor events are retrieved from any enabled sensors at a rate of 1 Hz.
The data retrieved from enabled sensors is passed to the listener
{Toybox::Lang::Method Method} provided as a parameter to this method.
listener [Toybox::Lang::Method] A reference to a listener Method:

* Called when sensor updates are received
* Receives a Sensor.info object
* Use +null+ to specify no listener
@example
using Toybox.Sensor;
// Given an onSensor listener method is defined
Sensor.enableSensorEvents(method(:onSensor));
@note Will cause an app crash if called from a data field app
@since 1.0.0
]]> Get the current Sensor {Toybox::Sensor::Info Sensor.Info}.

This is useful for retrieving the current sensor info either on demand
or periodically within a {Toybox::Timer::Timer Timer}.
Returns [Toybox::Sensor::Info]

@example Get accelerometer data once per second
using Toybox.Sensor;
using Toybox.System;
using Toybox.Timer;
var dataTimer = new Timer.Timer();
dataTimer.start(method(:timerCallback), 1000, true); // A one-second timer
function timerCallback() {
var sensorInfo = Sensor.getInfo();
if (sensorInfo has :accel && sensorInfo.accel != null) {
var accel = sensorInfo.accel;
var xAccel = accel[0];
var yAccel = accel[1];
System.println("x: " + xAccel + ", y: " + yAccel);
}
}
@see Toybox::Timer::Timer
@note Will cause an app crash if called from a data field app
@since 1.0.0
]]> Disable the given sensor type for use.

Unlike the existing setEnabledSensors() function, this will not enable/disable
other sensor types.

Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@note Will cause an app crash if called from a data field app
@since 3.2.0
]]> Get the maximum sample rate supported by the system.
@example
using Toybox.Sensor;
var maxSample = Sensor.getMaxSampleRate();
Returns [Toybox::Lang::Number] The max sample rate as a number

@note Will cause an app crash if called from a data field app
@note This function can produce different results after the app
transitions to the active state after being inactive. These state
changes are denoted by calls to AppBase.onActive() and AppBase.onInactive().
@since 2.3.0
]]> Enable the given sensor type for use.

Unlike the existing setEnabledSensors() function, this will not enable/disable
other sensor types.

Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@note Will cause an app crash if called from a data field app
@note Multitasking: Sensor states can not be changed while in inacitve mode
and sensor enabled during active mode will be disabled when app becomes inactive,
and re-enabled automatically when is active again.
These state changes are denoted by calls to AppBase.onActive() and AppBase.onInactive().
@since 3.2.0
]]> Save a location (waypoint) to the device's location list
location [Toybox::Position::Location] Location object to persist

options [Toybox::Lang::Dictionary] Dictionary of options, or +null+ to accept defaults

@option options [Toybox::Lang::String] :name Name to assign to the waypoint. If not specified will be auto-named.
@deprecated This method may be removed after System 4.
@see Toybox::PersistedContent#saveWaypoint PersistedContent.saveWaypoint()
@since 1.0.2
]]> Constructor
@since 2.3.0
]]> Get statistics for the data gathered in the current session.
Returns [Toybox::SensorLogging::SensorLoggingStats] Returns a SensorLoggingStats object.

@since 2.3.0
]]> Constructor
@note A SensorLogger may be initialized with the same dictionary of options
provided to {Toybox::Sensor#registerSensorDataListener registerSensorDataListener()},
but only the options documented below will be used.
options [Toybox::Lang::Dictionary] A Dictionary of logging options

@option options [Toybox::Lang::Dictionary] :accelerometer Options for
accelerometer data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the accelerometer.
@option options [Toybox::Lang::Dictionary] :gyroscope Options for
gyroscope data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the gyroscope.
@option options [Toybox::Lang::Dictionary] :magnetometer Options for
magnetometer data.
* :enabled ({Toybox::Lang::Boolean Toybox::Lang::Boolean}) Set to +true+
to fetch data from the magnetometer.
@option options [Toybox::Lang::Boolean] :synchronous Set to +true+ to
request synchronized sensor data.
@note Magnetometer data is not supported in synchronous data request.
@since 2.3.0
]]> Get statistics for the sensor data gathered in the current session.
sensor Symbol for the sensor type to get the logging stats for or +null+ to get stats about all the enabled sensors.

Returns [Toybox::SensorLogging::SensorLoggingStats, Toybox::Lang::Dictionary] Returns a {Toybox::SensorLogging::SensorLoggingStats SensorLoggingStats}

for the requested sensor type or the {Toybox::Lang::Dictionary} with stats of all the enabled sensors if +null+ is passed.
@throws {Toybox::Lang::InvalidValueException}
Thrown if provided argument are out of range or are of the wrong type.
@since 3.3.0
]]> Get the data and increment the iterator to next entry

Returns [Toybox::UserProfile::UserActivityHistoryIterator]

@since 3.3.0
]]> Constructor
@since 2.3.0
]]> Return the next message in the
{Toybox::Ant::BurstPayload BurstPayload} object.
Returns [Toybox::Lang::Array] The Array of integers representing the

bytes of the {Toybox::Ant::BurstPayload BurstPayload}, or +null+ if
one does not exist.
@since 2.2.0
]]> Constructor
newBurstPayload [Toybox::Ant::BurstPayload]

@since 2.2.0
]]> See if background scanning is enabled for the channel assignment.
Returns [Toybox::Lang::Boolean] Returns +true+ if background scan is

enabled, otherwise +false+.
@example
using Toybox.Ant;
// Assuming initialized channel
ChannelAssignment.isBackgroundScanEnabled();
@since 1.2.0
]]> Constructor
By default disables background scanning.
c [Toybox::Ant::ChannelType] The channel type specifier. Must use one

of the following constants:
* {Toybox::Ant::CHANNEL_TYPE_TX_NOT_RX CHANNEL_TYPE_TX_NOT_RX} - Bidirectional Transmit (Master)
* Master Channels are not allowed on the ANT+ Network
* {Toybox::Ant::CHANNEL_TYPE_RX_NOT_TX CHANNEL_TYPE_RX_NOT_TX} - Bidirectional Receive (Slave)
* {Toybox::Ant::CHANNEL_TYPE_RX_ONLY CHANNEL_TYPE_RX_ONLY} - Receive Only (Slave)
n [Toybox::Ant::NetworkType] The network type specifier. Must use one of

the following constants:
* {Toybox::Ant::NETWORK_PUBLIC NETWORK_PUBLIC} - ANT public network
* {Toybox::Ant::NETWORK_PLUS NETWORK_PLUS} - ANT+ network
* {Toybox::Ant::NETWORK_PRIVATE NETWORK_PRIVATE} - ANT private network
* A network key must be provided for an Private Network
* Both 64 and 128 bit keys are required
@example
using Toybox.Ant;

var channelType = Ant.CHANNEL_TYPE_RX_NOT_TX // Bidirectional Receive (Slave)
var network = Ant.NETWORK_PUBLIC; // Ant public network
// Get the channel
channelAssign = new Ant.ChannelAssignment(channelType, network);

// Initialize the channel - assumes message callback method
GenericChannel.initialize(method(:onMessage), channelAssign);
@see Toybox::AntPlus
@since 1.0.0
]]> Set background scan to be enabled or disabled.

Enabling background scan can only be done on Receive Only channels.
isBackgroundScanEnabled [Toybox::Lang::Boolean] Value is

+true+ to enable background scan, otherwise +false+.
Returns [Toybox::Lang::Boolean] Return +true+ if the background scan

property was successfully set, otherwise +false+.
@example
using Toybox.Ant;
// Assuming initialized channel
ChannelAssignment.setBackgroundScan(isBackgroundScanEnabled);
@since 1.2.0
]]> Send a broadcast message.
data [Toybox::Ant::Message] A message whose payload

is an 8-byte {Toybox::Lang::Array Array} of numbers
@example
using Toybox.Ant;
// create a data Array to format Message
var data = new[8];
for (var i = 0; i < 8; i++) {
data[i] = i + 1; // Set the values of each member
}
var message = new Ant.Message();
message.setPayload(data); // Assumes valid data

// Assumes a valid GenericChannel object
genericChannel.sendBroadcast(message);
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@see Toybox::Ant::Message
@since 1.0.0
]]> Get the current ANT channel configuration.
Returns [Toybox::Ant::DeviceConfig] The DeviceConfig object with

current channel device configuration.
@example
using Toybox.Ant;
var devConfig = genericChannel.getDeviceConfig();
// devConfig fields can now be accessed for configuration info
@see Toybox::Ant::DeviceConfig
@since 1.0.0
]]> Release the generic ANT Channel back to the system.

If the channel is open it will be automatically closed.
@example
using Toybox.Ant;

// Assumes a valid GenericChannel object
genericChannel.release();
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@since 1.0.0
]]> Send an {Toybox::Lang::Array Array} of
{Toybox::Ant::Message Messages} as a burst across the ANT channel.

Success or Fail is received by the {Toybox::Ant::BurstListener BurstListener}.
burstData [Toybox::Ant::BurstPayload] The data to burst across

the channel
@example
using Toybox.Ant;
var burstData = new Ant.BurstPayload(); // Create new payload

// Message must contain a valid payload
burstData.add(message); // Add Message object to payload

// Assumes a valid GenericChannel object
genericChannel.sendBurst(burstData); // Send Message
@see Toybox::Ant::BurstPayload
@throws [Toybox::Lang::SymbolNotAllowedException] Thrown if called from a
data field app
@since 2.2.0
]]> Send an acknowledge message.

You can expect to receive either
{Toybox::Ant::MSG_CODE_EVENT_TRANSFER_TX_COMPLETED MSG_CODE_EVENT_TRANSFER_TX_COMPLETED} or
{Toybox::Ant::MSG_CODE_EVENT_TRANSFER_TX_FAILED MSG_CODE_EVENT_TRANSFER_TX_FAILED} if
the message succeeded/failed going to the recipient.
data [Toybox::Ant::Message] A message whose payload

is an 8-byte {Toybox::Lang::Array Array} of numbers
@example
using Toybox.Ant;
// create a data Array to format Message
var data = new[8];
for (var i = 0; i < 8; i++) {
data[i] = i + 1; // Set the values of each member
}
var message = new Ant.Message();
message.setPayload(data); // Assumes valid data

// Assumes a valid GenericChannel object
genericChannel.sendAcknowledge(message);
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@see Toybox::Ant::Message
@since 1.0.0
]]> Set the {Toybox::Ant::BurstListener BurstListener} for burst events.

Failed bursts or those larger than the specified threshold will be
discarded.
listener [Toybox::Ant::BurstListener] An extension of the

BurstListener class
@example
using Toybox.Ant;

// Assumes a valid GenericChannel object
// Assumes a valid BurstListener object as a parameter
genericChannel.setBurstListener(listener);
@see Toybox::Ant::BurstListener
@throws [Toybox::Lang::SymbolNotAllowedException] Thrown if called from a
data field app
@since 2.2.0
]]> Disable encryption on this channel.
@example
using Toybox.Ant;

// Assumes a valid GenericChannel object
genericChannel.disableEncryption();
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@since 2.3.0
]]> Set the current ANT channel configuration.
configuration [Toybox::Ant::DeviceConfig] The DeviceConfig object to

set for the current ANT channel
@example
using Toybox.Ant;
var configuration = new Ant.DeviceConfig({});

// Assumes a valid GenericChannel object
genericChannel.setDeviceConfig(configuration);
@see Toybox::Ant::DeviceConfig
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@throws [Toybox::Lang::UnexpectedTypeError] Thrown if configuration values in configuration are not
of the correct type.
@since 1.0.0
]]> Constructor
listener [Toybox::Lang::Method] The Method object to call

with channel messages
channelAssignment [Toybox::Ant::ChannelAssignment] The

ChannelAssignment object for the channel
@throws [Toybox::Ant::UnableToAcquireChannelException] Thrown if the
the system does not have a channel available.
@example
using Toybox.Ant;

// Assumes a listenerCallback method and ChannelAssignment object supplied
// as parameters upon initialization
GenericChannel.initialize(method(:listenerCallback), channelAssign);
@since 1.0.0
]]> Set the encryption configuration and enable encryption on this channel.
configuration [Toybox::Ant::CryptoConfig] The CryptoConfig object to

set for the current channel
@example
using Toybox.Ant;
var cryptoConfig = new Ant.CryptoConfig({});

// Assumes a valid GenericChannel object
genericChannel.enableEncryption(cryptoConfig);
@see Toybox::Ant::CryptoConfig
@throws [Toybox::Ant::EncryptionInvalidSettingsException]
Thrown if invalid encryption settings are used
@throws [Toybox::Ant::UnableToAcquireEncryptedChannelException]
Thrown if an ecrypted channel cannot be acquired because all channels are in use
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@since 2.3.0
]]> Close a generic ANT Channel.
@example
using Toybox.Ant;

// Assumes a valid GenericChannel object
genericChannel.close();
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@since 1.0.0
]]> Open a generic ANT Channel.
@example
using Toybox.Ant;

// Assumes a valid GenericChannel object
genericChannel.open();
@note Multitasking: Ant channel connection can not be changed while in inacitve mode
and ant channels opened during active mode will be closed when app becomes inactive,
and re-opened automatically when is active again.
These state changes are denoted by calls to AppBase.onActive() and AppBase.onInactive().
Returns [Toybox::Lang::Boolean] +true+ on success, otherwise +false+.

@since 1.0.0
]]> Callback when a burst reception completes successfully
burstPayload [Toybox::Ant::BurstPayload] The BurstPayload

received
@see Toybox::Ant::BurstPayload
@since 2.2.0
]]> Callback when a burst reception fails over the air
errorCode [Toybox::Ant::BurstError] The type of burst failure

that occurred as a {Toybox::Ant::BURST_ERROR_OUT_OF_MEMORY BURST_ERROR_*}
constant
@since 2.2.0
]]> Callback when a burst transmission completes successfully
@since 2.2.0
]]> Callback when a burst transmission fails over the air
errorCode [Toybox::Ant::BurstError] The type of burst failure

that occurred as a {Toybox::Ant::BURST_ERROR_OUT_OF_MEMORY BURST_ERROR_*}
constant
@since 2.2.0
]]> Constructor
options [Toybox::Lang::Dictionary] The initialization options

@option options [Toybox::Lang::Number] :deviceNumber The ANT-id of
the device to search for. Not setting enables a wild card search
@option options [Toybox::Lang::Number] :deviceType 1-Byte device
type identifier
@option options [Toybox::Lang::Number] :transmissionType The
manufacturer-specific transport type and extended device number
@option options [Toybox::Lang::Number] :messagePeriod The message period
that the sensor uses
@option options [Toybox::Lang::Number] :radioFrequency The radio
frequency that the sensor operates on. Range of 2 to 80.
@option options [Toybox::Lang::Number] :searchTimeoutLowPriority The
Low Priority search timeout that a receiving channel will wait for
in order to start tracking a master
* Low Priority search provides the capability of searching for a master without interrupting other channels on the device
* Range of 0 to 12 (2.5s increments)
* Default 6 (15s)
@option options [Toybox::Lang::Number] :searchTimeoutHighPriority The
High Priority search timeout that a receiving channel will wait for
in order to start tracking a master
* Is triggered after the Low Priority search mode times out
* Will interrupt other channels
* Will take priority over any other open channels on that device
* If it overlaps another channel the High Priority search takes priority and that other channel is blocked
* Keeping this search type disabled unless you have great difficulty acquiring a master through Low Priority search is recommended
* High Priority searches are disabled in data-fields, and will be ignored for that application type
* Range of 0 to 2 (2.5s increments)
* Default 0 (disabled)
@option options [Toybox::Lang::Number] :searchThreshold A proximity
threshold bin as a Number
* Configures the RSSI threshold a slave channel will search for which is effectively the distance at which a slave is willing to be from a master
* Values are 0 (disabled), 1 (closest), 10 (farthest)
@option options [Toybox::Lang::Number] :networkKey64Bit 64 bit
network key
* Set this when {Toybox::Ant::NETWORK_PRIVATE NETWORK_PRIVATE} was chosen in the channel assignment
@option options [Toybox::Lang::Number] :networkKey128Bit 128 bit
network key
* Set this when NETWORK_PRIVATE was chosen in the channel assignment
@since 1.2.0
@see https://www.thisisant.com/developer/resources/downloads/ ANT Downloads & Resources - ANT Message Protocol and Usage
]]> Get the ANT data packet.
Returns [Toybox::Lang::Array] An Array of Numbers as integers

representing the bytes of the data payload
@since 1.0.0
]]> Set the ANT data packet.
data [Toybox::Lang::Array] An Array of Numbers as integers

representing the bytes of the data payload
@since 1.0.0
]]> Add bytes to the end of the burst data.
message [Toybox::Lang::Array, Toybox::Lang::ByteArray] An Array of integers representing

the bytes of the data payload
@note {Toybox::Lang::ByteArray ByteArray} is supported with ConnectIQ 4.2.0 and later.
@since 2.2.0
]]> Return the number of bursts contained in the payload.
Returns [Toybox::Lang::Number] The number of Messages

@since 2.2.0
]]> Constructor
@since 2.2.0
]]> Constructor
@since 1.2.0
]]> Constructor
@since 2.3.0
]]> Constructor
options [Toybox::Lang::Dictionary] The Dictionary of options

for the configuration
@option options [Toybox::Lang::Number] :encryptionId a Number (uint32)
to uniquely identify a device during encryption negotiation
@option options [Toybox::Lang::Array] :encryptionKey The key which
will be used to encrypt/decrypt ANT packets as an Array of bytes
@option options [Toybox::Lang::Array] :userInfoString The
string to send during negotiation to the master channel (only used
when the channel is configured as a slave) as an Array of bytes
@option options [Toybox::Lang::Number] :decimationRate A
{Toybox::Lang::Number Number}
with range 1-255 used for division of the master channel rate by
the slave's
@since 2.3.0
]]> @since 3.0.11
]]> Add a {Toybox::Time::Moment Moment} or another Duration to a Duration.

When adding a Moment to a Duration, this method functions the same as
the {Toybox::Time::Moment#add Moment.add()} method.
time [Toybox::Time::Duration, Toybox::Time::Moment] The Duration

or Moment to add to Duration
Returns [Toybox::Time::Duration, Toybox::Time::Moment] A Duration or

Moment object that is the sum of self and the provided object:
* Duration + Moment = Moment
* Duration + Duration = Duration
@example Add two Duration objects
using Toybox.Time;
var oneHour = new Time.Duration(3600);
var twoHours = new Time.Duration(7200);
var threeHours = oneHour.add(twoHours);
@see Toybox::Time::Moment#add Moment.add()
@since 1.0.0
]]> Determine if a Duration is shorter or longer than another Duration.

This computes a Number representing the difference between the two
Duration objects in seconds. The {Toybox::Time::Duration#subtract subtract()}
method can also be used to get the absolute difference between two
Duration objects.
duration [Toybox::Time::Duration] The Duration to compare to

this Duration
Returns [Toybox::Lang::Number] The Number of seconds difference between

the two Duration objects. If the Duration supplied for comparison is
longer than this Duration, the value will be negative.
@example
using Toybox.System;
using Toybox.Time;
var oneHour = new Time.Duration(3600);
var twoHours = new Time.Duration(7200);

System.println(oneHour.compare(twoHours)); // -3600, or one minute in the past
System.println(twoHours.compare(oneHour)); // 3600, or one minute in the future
@since 1.0.0
]]> Get the absolute difference between two Duration objects.

The computed Duration is always a positive value. The
{Toybox::Time::Duration#compare compare()} method can also be used to
get the difference between two Duration objects.
duration [Toybox::Time::Duration] The Duration to subtract from

this Duration
Returns [Toybox::Time::Duration] The difference between the two

Duration objects
@example
using Toybox.Time;
var twoHours = new Time.Duration(7200);
var threeHours = new Time.Duration(10800);
var oneHour = threeHours.subtract(twoHours);
@since 1.0.0
]]> Determine if a Duration is shorter than another Duration.
duration [Toybox::Time::Duration] The Duration to compare to

this Duration
Returns [Toybox::Lang::Boolean] +true+ if this Duration is shorter than

the Duration supplied for comparison, otherwise +false+
@example
using Toybox.System;
using Toybox.Time;
var oneHour = new Time.Duration(3600);
var twoHours = new Time.Duration(7200);

System.println(oneHour.lessThan(twoHours)); // true
System.println(twoHours.lessThan(oneHour)); // false
@since 1.0.0
]]> Divide a Duration by a value.
value [Toybox::Lang::Number, Toybox::Lang::Float] The value by

which to divide the Duration
Returns [Toybox::Time::Duration] The quotient of the Duration and the

supplied value
@example
using Toybox.Time;
var fourHours = new Time.Duration(Gregorian.SECONDS_PER_HOUR * 4);
var twoHours = fourHours.divide(2);
@since 1.0.0
]]> Constructor
value [Toybox::Lang::Number] The Number of seconds with which

to initialize the Duration
Returns [Toybox::Time::Duration] A Duration representing the specified

Number of seconds
@example Create a Duration of one day with a number of seconds
using Toybox.Time;
var oneDay = new Time.Duration(86400);
@see Toybox::Time::Gregorian#duration Gregorian.duration()
@since 1.0.0
]]> Multiply a Duration by a value.
value [Toybox::Lang::Number, Toybox::Lang::Float] The value

by which to multiply the Duration
Returns [Toybox::Time::Duration] The product of the Duration and the

supplied value
@example
using Toybox.Time;
var twoHours = new Time.Duration(7200);
var fourHours = twoHours.multiply(2);
@since 1.0.0
]]> Get the value of a Duration.
Returns [Toybox::Lang::Number] The value of the Duration in seconds

@since 1.0.0
]]> Determine if a Duration is longer than another Duration.
duration [Toybox::Time::Duration] The Duration to compare to

this Duration
Returns [Toybox::Lang::Boolean] +true+ if this Duration is longer than

the Duration supplied for comparison, otherwise +false+
@example
using Toybox.System;
using Toybox.Time;
var oneHour = new Time.Duration(3600);
var twoHours = new Time.Duration(7200);

System.println(oneHour.greaterThan(twoHours)); // false
System.println(twoHours.greaterThan(oneHour)); // true
@since 1.0.0
]]> Create a {Toybox::Time::Moment Moment} from a Dictionary of options.
Each option value is assumed to be in the UTC time zone.

Unlike {Toybox::Time::Moment#initialize Moment.initialize()}, which
is based on the UNIX epoch, a Moment created with Gregorian.moment()
is based on {Toybox::Time#today today()}. The result is determined
by taking the result of {Toybox::Time#today today()} and overlaying
the options provided.

options [Toybox::Lang::Dictionary] A dictionary of options;

values that would not result in a valid date are not allowed
@option options [Toybox::Lang::Number] :year The year (1970-2106)
@option options [Toybox::Lang::Number, Toybox::Lang::Symbol] :month The month (1-12) or a Symbol (:january, :february, ...)
@option options [Toybox::Lang::Number] :day The day of month (1-31)
@option options [Toybox::Lang::Number] :hour The hour (0-23)
@option options [Toybox::Lang::Number] :minute The minute (0-59)
@option options [Toybox::Lang::Number] :second The second (0-59)
Returns [Toybox::Time::Moment] A Moment representing the specified

moment in time
@example Create a Moment representing midnight on the first day of the current month.
using Toybox.Time;
var oneDay = Gregorian.moment({:day => 1});
@see Toybox::Time::Moment#initialize Moment.initialize()
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@since 1.0.0
]]> Create a {Toybox::Time::Duration Duration} from a Dictionary of options.

This is an alternative to
{Toybox::Time::Duration#initialize Duration.initialize()} that allows
the Duration to be made more easily, using familiar units, which can
be handy when building a Duration manually.

Option values are represented as signed 32-bit integers.
options [Toybox::Lang::Dictionary] A dictionary of options

@option options [Toybox::Lang::Number] :years The number of years
(max 69)
@option options [Toybox::Lang::Number] :days The number of days
(max 24855)
@option options [Toybox::Lang::Number] :hours The number of hours
(max 596523)
@option options [Toybox::Lang::Number] :minutes The number of minutes
(max 35791394)
@option options [Toybox::Lang::Number] :seconds The number of seconds
(max 2147483647)
Returns [Toybox::Time::Duration] The Duration representing the

specified span of time
@example Create a Duration of one day with Gregorian.duration()
using Toybox.Time.Gregorian;
var oneDay = Gregorian.duration({:days => 1});
@see Toybox::Time::Duration#initialize Duration.initialize()
@since 1.0.0
]]> Get {Toybox::Time::Gregorian::Info Info} for a {Toybox::Time::Moment Moment}
in local time.
moment [Toybox::Time::Moment, Toybox::Time::LocalMoment] A Moment

or LocalMoment object for which to get Info
format [Toybox::Time::DateFormat] A Time.FORMAT_* type

Returns [Toybox::Time::Gregorian::Info] Info for the supplied Moment

formatted according to the specified format type in local time.
@example Get Info for today in local time (assume CST)
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var options = {
:year => 2003,
:month => 5, // 3.x devices can also use :month => Gregorian.MONTH_MAY
:day => 16,
:hour => 0
};
var date = Gregorian.moment(options);
var birthday = Gregorian.info(date, Time.FORMAT_MEDIUM);
System.println(birthday.year); // 2003
System.println(birthday.month); // May
System.println(birthday.day); // 16
System.println(birthday.hour); // 19
@since 1.0.0
]]> Return a Gregorian.MONTH_* given a month symbol
@since 1.0.0
]]> Get {Toybox::Time::Gregorian::Info Info} for a {Toybox::Time::Moment Moment}
in UTC time.
Info
format [Toybox::Time::DateFormat] A Time.FORMAT_* type

Returns [Toybox::Time::Gregorian::Info] Info for the supplied Moment

formatted according to the specified format type in UTC time.
@example Get Info for today in UTC
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var options = {
:year => 2003,
:month => 5, // 3.x devices can also use :month => Gregorian.MONTH_MAY
:day => 16,
:hour => 0
};
var date = Gregorian.moment(options);
var birthday = Gregorian.utcInfo(date, Time.FORMAT_MEDIUM);
System.println(birthday.year); // 2003
System.println(birthday.month); // May
System.println(birthday.day); // 16
System.println(birthday.hour); // 0
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@since 2.1.0
]]> Create a LocalMoment from a Moment and a Location
location [Toybox::Position::Location] The location to use to

determine the time zone offset and daylight saving time rules.
moment [Toybox::Time::Moment] The UTC time to find the local

time for.
Returns [Toybox::Time::LocalMoment] A LocalMoment object for the local

time at the given location, or +null+ if an error occurred.
@since 3.3.0
]]> Parameterized version of Moment.
year [Toybox::Lang::Number] An int representing the number of years

month [Toybox::Lang::Number] An int representing the number of months

day [Toybox::Lang::Number] An int representing the number of days

hour [Toybox::Lang::Number] An int representing the number of hours

minute [Toybox::Lang::Number] An int representing the number of minute

second [Toybox::Lang::Number] An int representing the number of seconds

Returns [Toybox::Time::Moment] A Moment object of the given date

@since 1.0.0
]]> Add a {Toybox::Time::Duration Duration} to a LocalMoment.

addend [Toybox::Time::Duration] The Duration to add to this

LocalMoment.
Returns [Toybox::Time::LocalMoment] A LocalMoment object that is the

sum of self and the provided Duration object.
@since 3.3.0
]]> Get the time zone offset from UTC time in seconds.

This is the time zone offset without the daylight saving time offset.

Returns [Toybox::Lang::Number] The time zone offset from UTC in seconds.

Positive values are East of UTC.

@since 3.3.0
]]> Determine if a LocalMoment is before or after another LocalMoment

This computes a Number representing the difference between the two
LocalMoment objects in seconds. The {Toybox::Time::LocalMoment#subtract subtract()}
method can also be used to get the absolute Duration between two LocalMoment
objects.
moment [Toybox::Time::LocalMoment] The LocalMoment to compare

to this LocalMoment
Returns [Toybox::Lang::Number] The Number of seconds difference between

the two LocalMoment objects, without considering time zone rules. If
the LocalMoment supplied for comparison is after this LocalMoment, the
value will be negative.
@example
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
using Toybox.Position;

var where = new Position.Location({
:latitude => 38.85391,
:longitude => -94.79630,
:format => :degrees,
});
var today = Gregorian.localMoment(where, Time.today());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);

System.println(today.compare(tomorrow)); // -86400, or one day in the past
System.println(tomorrow.compare(today)); // 86400, or one day in the future
@see Toybox::Time::LocalMoment#subtract LocalMoment.subtract()
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 3.3.0
]]> Get the total time offset from UTC time in seconds

Returns [Toybox::Lang::Number] The total offset from UTC time in seconds.

@since 3.3.0
]]> Subtract a {Toybox::Time::Duration Duration} or
{Toybox::Time::LocalMoment LocalMoment} from a LocalMoment.

subtrahend [Toybox::Time::LocalMoment, Toybox::Time::Duration] The

LocalMoment or Duration to subtract from this LocalMoment
Returns [Toybox::Time::Duration, Toybox::Time::LocalMoment] The Duration

between the two LocalMoment objects or the LocalMoment offset by a Duration.

When subtracting LocalMoments, the computed Duration is always a positive
value. The {Toybox::Time::LocalMoment#compare compare()} method can be
used to determine whether one LocalMoment is before or after another LocalMoment.

@since 3.3.0
]]> Get a Moment for this.
Returns [Toybox::Time::Moment] The UTC time of the LocalMoment as a Moment

@since 3.3.0
]]> Get whether the daylight saving time offset is in effect

Returns [Toybox::Lang::Boolean] true if daylight saving time is in

effect for this time.

@since 3.3.0
]]> Determine if a LocalMoment is less than another LocalMoment.
moment [Toybox::Time::LocalMoment] The LocalMoment to compare

to this LocalMoment
Returns [Toybox::Lang::Boolean] +true+ if this LocalMoment is less

than the LocalMoment supplied for comparison, otherwise +false+
@since 3.3.0
]]> Constructor
location [Toybox::Position::Location] The location for which this

LocalMoment is valid.
dateTime [Toybox::Lang::Number] The UTC timestamp value.

zoneOffset [Toybox::Lang::Number] The time zone offset in seconds.

daylightOffset [Toybox::Lang::Number] The daylight savings time

offset in seconds.
isDaylight [Toybox::Lang::Boolean] The indicator that the daylight

offset should be included when calculating the total offset from UTC time
@since 3.3.0
]]> Get the daylight saving time offset from UTC time in seconds.

Returns [Toybox::Lang::Number] The daylight saving time offset in seconds.


@since 3.3.0
]]> Get the UTC value of a LocalMoment.
Returns [Toybox::Lang::Number] The UTC time of the LocalMoment in seconds

since the UNIX epoch
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@see https://en.wikipedia.org/wiki/Unix_time UNIX Time
@since 3.3.0
]]> Determine if a LocalMoment is greater than another LocalMoment.
moment [Toybox::Time::LocalMoment] The LocalMoment to compare

to this LocalMoment
Returns [Toybox::Lang::Boolean] +true+ if this LocalMoment is greater

than the LocalMoment supplied for comparison, otherwise +false+
@since 3.3.0
]]> Add a {Toybox::Time::Duration Duration} to a Moment.

This method functions the same as the {Toybox::Time::Duration#add Duration.add()}
method when adding a Duration to a Moment.
duration [Toybox::Time::Duration] The Duration to add to this

Moment
Returns [Toybox::Time::Moment] A Moment object that is the sum of self

and the provided Duration object
@example Add one day to today
using Toybox.Time;
using Toybox.Time.Gregorian;
var today = new Time.Moment(Time.today().value());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);
@see Toybox::Time::Duration#add Duration.add()
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 1.0.0
]]> Determine if a Moment is before or after another Moment.

This computes a Number representing the difference between the two
Moment objects in seconds. The {Toybox::Time::Moment#subtract subtract()}
method can also be used to get the absolute Duration between two Moment
objects.
moment [Toybox::Time::Moment] The Moment to compare to this

Moment
Returns [Toybox::Lang::Number] The Number of seconds difference between

the two Moment objects. If the Moment supplied for comparison is after
this Moment, the value will be negative.
@example
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var today = new Time.Moment(Time.today().value());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);

System.println(today.compare(tomorrow)); // -86400, or one day in the past
System.println(tomorrow.compare(today)); // 86400, or one day in the future
@see Toybox::Time::Moment#subtract Moment.subtract()
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 1.0.0
]]> Subtract a {Toybox::Time::Duration Duration} or
{Toybox::Time::Moment Moment} from a Moment.

subtrahend [Toybox::Time::Moment, Toybox::Time::Duration] The

Moment or Duration to subtract from this Moment
Returns [Toybox::Time::Duration, Toybox::Time::Moment] The Duration

between the two Moment objects or the Moment offset by a Duration.

When subtracting Moments, the computed Duration is always a positive
value. The {Toybox::Time::Moment#compare compare()} method can be
used to determine whether one Moment is before or after another Moment.
@note Subtracting a Duration from a Moment was not supported until
ConnectIQ 3.0.0. If backward compatibility is a concern, it may be
best to add a negative Duration instead.
@example
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var today = new Time.Moment(Time.today().value());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);

var duration1 = today.subtract(tomorrow);
var duration2 = tomorrow.subtract(today);

System.println(duration1.value()); // 86400, or one day
System.println(duration2.value()); // 86400, or one day
@see Toybox::Time::Moment#compare Moment.compare()
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 1.0.0
]]> Determine if a Moment is less than another Moment.
moment [Toybox::Time::Moment] The Moment to compare to this

Moment
Returns [Toybox::Lang::Boolean] +true+ if this Moment is less than the

Moment supplied for comparison, otherwise +false+
@example
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var today = new Time.Moment(Time.today().value());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);

System.println(today.lessThan(tomorrow)); // true
System.println(tomorrow.lessThan(today)); // false
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 1.0.0
]]> Constructor
seconds [Toybox::Lang::Number] The Number of seconds with which

to initialize the Moment
Returns [Toybox::Time::Moment] A Moment representing the specified moment

in time
@example Create a Moment with a UNIX time stamp
using Toybox.Time;
var garminFounded = new Time.Moment(631065600);
@example Create a Moment representing today
using Toybox.Time;
var today = new Time.Moment(Time.today().value());
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@see https://en.wikipedia.org/wiki/Unix_time UNIX Time
@since 1.1.2
]]> Get the UTC value of a Moment.
Returns [Toybox::Lang::Number] The UTC date of the Moment in seconds

since the UNIX epoch
@see https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC Time
@see https://en.wikipedia.org/wiki/Unix_time UNIX Time
@since 1.0.0
]]> Determine if a Moment is greater than another Moment.
moment [Toybox::Time::Moment] The Moment to compare to this

Moment
Returns [Toybox::Lang::Boolean] +true+ if this Moment is greater than

the Moment supplied for comparison, otherwise +false+
@example
using Toybox.System;
using Toybox.Time;
using Toybox.Time.Gregorian;
var today = new Time.Moment(Time.today().value());
var oneDay = new Time.Duration(Gregorian.SECONDS_PER_DAY);
var tomorrow = today.add(oneDay);

System.println(today.greaterThan(tomorrow)); // false
System.println(tomorrow.greaterThan(today)); // true
@see Toybox::Time::Gregorian::SECONDS_PER_DAY SECONDS_PER_DAY
@since 1.0.0
]]> @since 2.3.0
]]> Constructor
dictionary [Toybox::Lang::Dictionary] A Dictionary containing

filter settings.
@option dictionary [Toybox::Lang::Array, Toybox::Lang::ResourceId] :coefficients An Array of
Float values that specify the filter coefficients. A ResourceId
referencing a JSON Array resource can also be used here.
@option dictionary [Toybox::Lang::Float] :gain A Float value that
specifies a multiplier to be applied to the coefficients.
@throws [Toybox::Lang::InvalidOptionsException] If the Dictionary
does not have valid coefficients for filter or the :gain field
is missing. Will also be thrown if an invalid JSON ResourceId is
specified for coefficients instead of an array
@since 2.3.0
]]> @since 2.3.0
]]> Constructor
dictionary [Toybox::Lang::Dictionary] A Dictionary

containing filter settings.
@option dictionary [Toybox::Lang::Array, Toybox::Lang::ResourceId] :coefficients_a An Array
of Float values that specify the feedback filter coefficients. A
ResourceId referencing a JSON Array resource can also be used here.
@option dictionary [Toybox::Lang::Array, Toybox::Lang::ResourceId] :coefficients_b An Array
of Float values that specify the feed forward filter coefficients.
A ResourceId referencing a JSON Array resource can also be used
here.
@option dictionary [Toybox::Lang::Float] :gain A Float value that
specifies a multiplier to be applied to the coefficients.
@throws [Toybox::Lang::InvalidOptionsException] If the Dictionary
does not have valid coefficients for filter or the :gain field
is missing. Will also be thrown if an invalid JSON ResourceId is
specified for :coefficients instead of an array
@since 2.3.0
]]> Apply the Filter to an Array of samples.
@note An Exception will be thrown if the base Filter class version of this method is called.
data Array of samples to apply filter

@throws [Toybox::Lang::SymbolNotAllowedException] If called on base
class Filter object
Returns Array of samples with filter applied.

@since 2.3.0
]]> Constructor
dictionary [Toybox::Lang::Dictionary] Unused. Preserves argument count for compatibility

@since 2.3.0
]]> After enabling notifications or indications on a characteristic
by enabling the appropriate bit of the CCCD of the characteristic
this function will be called after every change to the
characteristic.

characteristic [Toybox::BluetoothLowEnergy::Characteristic]

The characteristic that changed
value [Toybox::Lang::ByteArray] The updated value of the

characteristic
@since 3.1.0
]]> After requesting a read operation on a Characteristic with
{Toybox::BluetoothLowEnergy::Characteristic#requestRead requestRead()},
this function will be called when the operation is completed.

characteristic [Toybox::BluetoothLowEnergy::Characteristic]

The characteristic that was read.
status [Toybox::BluetoothLowEnergy::Status] A

{Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*}
indicating the result of the operation
value [Toybox::Lang::ByteArray] Characteristic value that was

read. +null+ if status is not {Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_SUCCESS}
@since 3.1.0
]]> After requesting a write operation on a Descriptor with
{Toybox::BluetoothLowEnergy::Descriptor#requestWrite requestWrite()}
this function will be called when the operation is completed.

descriptor [Toybox::BluetoothLowEnergy::Descriptor]

The descriptor that was written
status [Toybox::BluetoothLowEnergy::Status] A

{Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*}
indicating the result of the operation
@since 3.1.0
]]> After requesting a write operation on a Characteristic with
{Toybox::BluetoothLowEnergy::Characteristic#requestWrite requestWrite()},
this function will be called when the operation is completed.

characteristic [Toybox::BluetoothLowEnergy::Characteristic]

The characteristic that was written.
status [Toybox::BluetoothLowEnergy::Status] A

{Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*}
indicating the result of the operation
@since 3.1.0
]]> After requesting a read operation on a Descriptor with
{Toybox::BluetoothLowEnergy::Descriptor#requestRead requestRead()}
this function will be called when the operation is completed.

descriptor [Toybox::BluetoothLowEnergy::Descriptor]

The descriptor that was read
status [Toybox::BluetoothLowEnergy::Status] A

{Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*}
indicating the result of the operation
value [Toybox::Lang::ByteArray] Descriptor value that was

read. +null+ if status is not {Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_SUCCESS}
@since 3.1.0
]]> When the state of scanning is modified the system will call this
function with the new state and a status indicating the result of
the last call to {Toybox::BluetoothLowEnergy#setScanState setScanState()}.

scanState [Toybox::BluetoothLowEnergy::ScanState] A {Toybox::BluetoothLowEnergy::SCAN_STATE_OFF

SCAN_STATE_*} enum value indicating the new Scan State of the system
status [Toybox::BluetoothLowEnergy::Status] The {Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*}

result of the last call to {Toybox::BluetoothLowEnergy#setScanState setScanState()}
@since 3.1.0
]]> After pairing a device this will be called after the connection is
made

device [Toybox::BluetoothLowEnergy::Device] the device state that was changed

state [Toybox::BluetoothLowEnergy::ConnectionState] A

{Toybox::BluetoothLowEnergy::CONNECTION_STATE_DISCONNECTED CONNECTION_STATE_*}
indicating the state of the connection
@since 3.1.0
]]> Constructor
@since 3.1.0
]]> After Registering a UUID this callback will notify of the result of
the registration request

uuid [Toybox::BluetoothLowEnergy::Uuid]

Profile UUID that this callback is related to
status [Toybox::BluetoothLowEnergy::Status] A

{Toybox::BluetoothLowEnergy::STATUS_SUCCESS STATUS_*} indicating the result
of a call to {Toybox::BluetoothLowEnergy#registerProfile registerProfile()}
@since 3.1.0
]]> If a scan is running this will be called when new ScanResults are received

scanResults [Toybox::BluetoothLowEnergy::Iterator] An iterator of

{Toybox::BluetoothLowEnergy::ScanResult ScanResult} objects for
all of the advertisements seen since the last call to this callback
@since 3.1.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.1.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.1.0
]]> Get the next item in the list
Returns [Toybox::Lang::Object] The next item, or +null+ if end of list

@since 3.1.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.1.0
]]> Check that advertised device BLE address matches

address [Toybox::Lang::ByteArray, Toybox::Lang::String] Address

to check for as a big-endian byte array or a string in the format
"00:01:02:03:04:05"
Returns [Toybox::Lang::Boolean] +true+ if the parameter

provided is the same as the address associated with this
ScanResult, otherwise +false+
@since 3.2.0
]]> Gets the Advertised Appearance of the sensor

Returns [Toybox::Lang::Number] A number representing the appearance

of the sensor
@since 3.1.0
]]> Gets service UUIDs advertised by the device

If the advertising data contains any service UUID values. They can
be accessed through this iterator. If there are no advertised UUIDs
this function will return an empty iterator.

Returns [Toybox::BluetoothLowEnergy::Iterator]

Iterator of {Toybox::BluetoothLowEnergy::Uuid Uuid} objects
advertised in the ScanResult
@since 3.1.0
]]> Gets the received signal strength indication (RSSI) value of the
received advertisement.

Returns [Toybox::Lang::Number] the RSSI Value of the advertisement

associated with the scan result. In dBM
@since 3.1.0
]]> Gets Manufacturer Specific Data for a given Manufacturer

Manufacturer Specific Data is decoded according to the BLE Core
Specification V4.0 Volume 3 Part C Section 18.11

manufacturerId [Toybox::Lang::Number] The manufacturer id

to retrieve the manufacturer specific data for.
Returns [Toybox::Lang::ByteArray] Manufacturer Specific Data.

@since 3.1.0
]]> Gets Service Data for a specific UUID

Service data is decoded according to the BLE Core Specification
V4.0 Volume 3 Part C Section 18.10

uuid [Toybox::BluetoothLowEnergy::Uuid] Service UUID to

search for
Returns [Toybox::Lang::ByteArray] Service Data for a specific UUID.

@since 3.1.0
]]> Compares the ScanResult to another object for equality

other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if other is a scan result

for the same device, otherwise +false+
@since 3.2.0
]]> Determines if another scan result represents the same device as
another.

other [Toybox::BluetoothLowEnergy::ScanResult] The other scan

result to compare

Returns [Toybox::Lang::Boolean] Indicating if this scan result represents the same

device as another
@since 3.1.0
]]> Gets the advertised device name

If no device name is advertised this function will return +null+

Returns [Toybox::Lang::String] The device name if present or +null+ otherwise

@since 3.1.0
]]> Gets the Raw Data that was retrieved in the advertising packet

Returns [Toybox::Lang::ByteArray] Raw bytes that were received in

the advertising packet
@since 3.1.0
]]> Gets an iterator over all of the Manufacturer Specific Data AD
Entries in the advertising packet

Manufacturer Specific Data is decoded according to the BLE Core
Specification V4.0 Volume 3 Part C Section 18.11

Returns [Toybox::BluetoothLowEnergy::Iterator] Iterator of

{Toybox::Lang::Dictionary Dictionary} objects for each AD entry.
Dictionary will have keys for +:companyId+ and +:data+
@since 3.1.0
]]> Retrieves the Name of the sensor according to the device name that
is available in the GAP Service

Returns [Toybox::Lang::String] the name of the device.

+null+ if the device is not connected or name has not been received
yet.
@since 3.1.0
]]> Gets the connected status of the device

Returns [Toybox::Lang::Boolean]

+true+ if the sensor is connected
+false+ if sensor is disconnected
@since 3.1.0
]]> Retrieves an Iterator over the services provided by the device.

This will only provide Services that have been registered
using {Toybox::BluetoothLowEnergy#registerProfile registerProfile()}

Returns [Toybox::BluetoothLowEnergy::Iterator]

Iterator of {Toybox::BluetoothLowEnergy::Service Service} objects provided
by a device.
@since 3.1.0
]]> Retrieves the service with a specified UUID

If access to a specific service is required, use this function to
directly access the service based on a UUID.

uuid [Toybox::BluetoothLowEnergy::Uuid] The UUID of the service to search

for

Returns [Toybox::BluetoothLowEnergy::Service]

The service represented by the UUID if the service exists or,
+null+ if the service does not exist or the UUID has not been
registered
@since 3.1.0
]]> Retrieves the Descriptor with a specified UUID

uuid [Toybox::BluetoothLowEnergy::Uuid] the UUID to search

for.
Returns [Toybox::BluetoothLowEnergy::Descriptor] The Descriptor represented

by the UUID provided or, +null+ if the descriptor does not exist
or the UUID has not be registered.
@since 3.1.0
]]> Retrieves an Iterator over the {Toybox::BluetoothLowEnergy::Descriptor Descriptors}
discovered in the Characteristic

This will only provide descriptors that have been registered
using {Toybox::BluetoothLowEnergy#registerProfile registerProfile()}

Returns [Toybox::BluetoothLowEnergy::Iterator] Iterator of

{Toybox::BluetoothLowEnergy::Descriptor Descriptor} objects for
the descriptors discovered in the Characteristic
@since 3.1.0
]]> Return the UUID of the Characteristic

Returns [Toybox::BluetoothLowEnergy::Uuid]

The UUID of the Characteristic
@since 3.1.0
]]> Requests a write operation

Once the operation is completed,
{Toybox::BluetoothLowEnergy::BleDelegate#onCharacteristicWrite onCharacteristicWrite()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
with the status of the operation

Support for long writes is not implemented. Requesting a write on a
characteristic longer than 20 bytes will cause an
{Toybox::BluetoothLowEnergy::InvalidRequestException InvalidRequestException}

value [Toybox::Lang::ByteArray] New value to store.

options [Toybox::Lang::Dictionary] A Dictionary containing write options

@option options [Toybox::BluetoothLowEnergy::WriteType] :writeType A
{Toybox::BluetoothLowEnergy::WRITE_TYPE_WITH_RESPONSE WRITE_TYPE_*}
indicating the write type to use when writing to the characteristic. Cannot be +null+.
@throws [Toybox::BluetoothLowEnergy::InvalidRequestException] if the request is invalid
@since 3.1.0
]]> Requests a read operation on the characteristic

Once the operation is completed,
{Toybox::BluetoothLowEnergy::BleDelegate#onCharacteristicRead onCharacteristicRead()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
with the status of the operation

Support for long reads is not implemented.
@since 3.1.0
]]> Retrieves the Characteristic's Service

Retrieve the Service that this characteristic belongs to

Returns [Toybox::BluetoothLowEnergy::Service] Parent

characteristic object
@since 3.1.0
]]> Returns the UUID of the service

Returns [Toybox::BluetoothLowEnergy::Uuid] the UUID of the service

@since 3.1.0
]]> Retrieves the Characteristic with a specified UUID

uuid [Toybox::BluetoothLowEnergy::Uuid] the UUID to search

for.
Returns [Toybox::BluetoothLowEnergy::Characteristic] The Characteristic

represented by the UUID provided or, +null+ if the characteristic does
not exist or the UUID has not be registered.
@since 3.1.0
]]> Retrieves an Iterator over the Characteristics in a Service

This will only provide Characteristics that have been registered
using {Toybox::BluetoothLowEnergy#registerProfile registerProfile()}

Returns [Toybox::BluetoothLowEnergy::Iterator] Iterator of

{Toybox::BluetoothLowEnergy::Characteristic Characteristic} objects
for the Characteristics discovered in the Service
@since 3.1.0
]]> Retrieves the Service's Device

Retrieve the Device that this service belongs to

Returns [Toybox::BluetoothLowEnergy::Device] Parent

characteristic object
@since 3.1.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.1.0
]]> Retrieve a hash code of the UUID

Optimized for BLE standard
@since 3.1.0
]]> Compares the Uuid to another object for equality

other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean]

+true+ if the parameter provided is an equivalent Uuid or
equivalent UUID String, +false+ otherwise.
@throws [Toybox::BluetoothLowEnergy::UuidFormatException]
@since 3.1.0
]]> Convert UUID to a Little Endian Byte Array

Returns [Toybox::Lang::ByteArray] A Byte Array Representation of the

UUID
@since 3.1.0
]]> Convert a UUID to a String

Returns [Toybox::Lang::String] A String representation of the UUID

@since 3.1.0
]]> Returns the UUID of the Descriptor

Returns [Toybox::BluetoothLowEnergy::Uuid] the UUID of the Descriptor

@since 3.1.0
]]> Requests a write operation

Writes the locally stored value to the remote descriptor.

Once the operation is completed,
{Toybox::BluetoothLowEnergy::BleDelegate#onDescriptorWrite onDescriptorWrite()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
with the status of the operation

Support for long writes is not implemented. Requesting a write on a
characteristic longer than 20 bytes will cause an
{Toybox::BluetoothLowEnergy::InvalidRequestException InvalidRequestException}
value [Toybox::Lang::ByteArray] New value to store.

@throws [Toybox::BluetoothLowEnergy::InvalidRequestException] if the request is invalid
@since 3.1.0
]]> Retrieves the Descriptors Characteristic

Retrieve the Characteristic that this descriptor belongs to

Returns [Toybox::BluetoothLowEnergy::Characteristic] Parent

characteristic object
@since 3.1.0
]]> Requests a read operation on the descriptor

Once the operation is completed,
{Toybox::BluetoothLowEnergy::BleDelegate#onDescriptorRead onDescriptorRead()}
will be called on the registered {Toybox::BluetoothLowEnergy::BleDelegate BleDelegate}
with the status of the operation
@since 3.1.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.2.0
]]> Constructor
aURI [Toybox::Lang::String] The URI that specifies receiver

of the Intent
aArgs [Toybox::Lang::Dictionary] Parameters to pass to the

target URI
@since 2.2.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.2.0
]]> Constructor
@since 2.2.0
]]> A callback method that is triggered in the background at the
configured wake time.
@since 2.3.0
]]> The callback method that is triggered in the background at the
configured sleep time.
@since 2.3.0
]]> The callback method that is triggered when an activity is completed
activity [Toybox::Lang::Dictionary] A dictionary containing information

about the completed activity.
@option activity [Toybox::Activity::Sport] :sport The primary sport
of the completed activity.
@option activity [Toybox::Activity::SubSport] :subSport The sport subcategory
of the completed activity.
@since 3.0.10
]]> A callback method that is triggered in the background when a fitness
goal is reached.
goalType [Toybox::Application::GoalType] An Application.GOAL_TYPE_*

value, representing the goal type that is being registered.
@since 2.3.0
]]> The callback method that is triggered in the background when a step
goal is reached.

Step goals occur at 1000 step increments.
@since 2.3.0
]]> The callback method that is triggered when a push notification is received for this app
@since 3.0.10
]]> The callback method that is triggered when a phone app message arrives
for this app
msg [Toybox::Communications::PhoneAppMessage] The message received.


@since 3.2.0
]]> A callback method that is triggered in the background when time-based
events occur.
@since 2.3.0
]]> The callback method that is triggered in the background when an OAuth
response is received from the system

@since 2.3.0
]]> Constructor
message [Toybox::Lang::String] The exception message

@since 2.1.0
]]> Must return a {Toybox::Lang::Number Number} indicating the number
of tests to run
@since 2.1.0
]]> Runs the indicated test.

The parameter can be any type. Must return
+true+ on pass and +false+ on failure.
@since 2.1.0
]]> Write a debug {Toybox::Lang::String String} to the output stream.

The String is prefixed with DEBUG and a time stamp.
str [Toybox::Lang::String] The String output to the console

@example
using Toybox.Test;
(:test)
function aDebugTest(logger) {
logger.debug("This is a debug message.");
return true;
}
// Output:
DEBUG (9:23): This is a debug message.
@since 2.1.0
]]> Write a warning {Toybox::Lang::String String} to the output stream.

The String is prefixed with WARNING and a time stamp.
str [Toybox::Lang::String] The String output to the console

@example
using Toybox.Test;
(:test)
function aWarningTest(logger) {
logger.warning("This is a warning message.");
return true;
}
// Output:
WARNING (9:23): This is a warning message.
@since 2.1.0
]]> Write an error {Toybox::Lang::String String} to the output stream.

The String is prefixed with ERROR and time stamp.
str [Toybox::Lang::String] The String output to the console

@example
using Toybox.Test;
(:test)
function anErrorTest(logger) {
logger.error("This is an error message.");
return true;
}
// Output:
ERROR (9:24): This is an error message.
@since 2.1.0
]]> Constructor

A KeyPair can be initialized from a private key by passing a
private key {Toybox::Lang::ByteArray ByteArray} from an initialized
{Toybox::Cryptography::Key Key} object into the +:privateKey+ option
of the initialize method for this class. If no private key is provided,
then both a private and public key will be generated using the required
+:algorithm+ option.
options [Toybox::Lang::Dictionary] A dictionary of options

@option options [Toybox::Cryptography::KeyPairAlgorithm] :algorithm The algorithm
to use as a {Toybox::Cryptography::KEY_PAIR_ELLIPTIC_CURVE_SECP224R1 KEY_PAIR_*}
constant (required)
@option options [Toybox::Lang::ByteArray] :privateKey The private
key to be used to generate the KeyPair (optional)
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the
specified +:algorithm+ is not supported, or if a required option is
not provided
@throws [Toybox::Lang::InvalidValueException] Thrown if the specified
+:privateKey+ is not the correct size for the selected algorithm
@note privateKey is expected to be in little-endian byte order.
@since 3.0.0
]]> Get the public key.
Returns [Toybox::Cryptography::Key] The public key as a Key object

@since 3.0.0
]]> Get the private key.
Returns [Toybox::Cryptography::Key] The private key as a Key object

@since 3.0.0
]]> Return the digest of the authentication code.

The state of the object is reset and can be used to compute
a new authentication code with the same options.
Returns [Toybox::Lang::ByteArray] The computed message authentication

code in network byte order
@since 3.0.0
]]> Continue the computation of the CMAC by consuming the next chunk
of data.

Repeated calls are equivalent to a single call with the concatenation
of all the arguments.
message [Toybox::Lang::ByteArray] The next chunk of the message

being hashed
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Cryptography::CipherAlgorithm] :algorithm A
{Toybox::Cryptography CIPHER_*} value specifying the encryption
algorithm used for this CMAC computation; CIPHER_AES128 is the only
supported algorithm in Connect IQ 3.x. (required)
@option options [Toybox::Lang::ByteArray] :key The secret key used by
selected cipher algorithm, which must be the appropriate length for
chosen encryption type (required)
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the specified
algorithm is not supported
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided for the +:key+
option, if a type other than {Toybox::Lang::Number} is provided for
the +:algorithm+ option, or if either option is not provided
@since 3.0.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Get the current digest of the message that has been hashed.

Returns [Toybox::Lang::ByteArray] The digest of the message

@note This method resets the state of the Hash object, which can be
used to compute a new hash
@since 3.0.0
]]> Continue hashing of a message by consuming the next chunk of data.

Repeated calls are equivalent to a single call with the concatenation
of all the arguments.
message [Toybox::Lang::ByteArray] The next chunk of the

message being hashed
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Cryptography::HashAlgorithm] :algorithm The type
of Hash this object will compute from the
{Toybox::Cryptography HASH_*} enumeration (required)
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the
algorithm selected is not supported, or if a required option is
not provided
@see https://en.wikipedia.org/wiki/Hash_function
@since 3.0.0
]]> Return the digest of the authentication code.

The state of the object is reset and can be used to compute
a new authentication code with the same options.
Returns [Toybox::Lang::ByteArray] The computed message authentication

code in network byte order
@since 3.0.0
]]> Continue computation of the HMAC by consuming the next chunk of data.

Repeated calls are equivalent to a single call with the concatenation
of all the arguments.
message [Toybox::Lang::ByteArray] The next chunk of the

message being hashed
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Cryptography::HashAlgorithm] :algorithm A
{Toybox::Cryptography HASH_*} value specifying the type of Hash used
for this HMAC computation; HASH_SHA256 is the only supported
algorithm in Connect IQ 3.x (required)
@option options [Toybox::Lang::ByteArray] :key The secret key used
to compute the message authentication code, which can be of any
length in bytes (required)
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the specified
algorithm is not supported
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided for the +:key+
option, if a type other than {Toybox::Lang::Number} is provided for
the +:algorithm+ option, or if either option is not provided
@since 3.0.0
]]> Encrypt data with the key, depending on how the cipher was initialized.

Encryption can be broken up into two or more calls to encrypt. For
MODE_CBC, the +plaintext+ length (in bytes) must be a multiple of the
block size.
plaintext [Toybox::Lang::ByteArray] The piece of data to encrypt

Returns [Toybox::Lang::ByteArray] The encrypted data

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided
@throws [Toybox::Cryptography::InvalidBlockSizeException] Thrown if
+plaintext+ is not a valid size for the selected encryption type
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Cryptography::CipherAlgorithm] :algorithm The
encryption type this cipher object will use from the
{Toybox::Cryptography CIPHER_*} enumeration (required)
@option options [Toybox::Cryptography::EncryptionMode] :mode The encryption mode
this cipher object will use from the
{Toybox::Cryptography MODE_*} enumeration (required)
@option options [Toybox::Lang::ByteArray] :key The secret key to use
in the cipher. The key must be of the appropriate length for the
encryption type selected (required)
@option options [Toybox::Lang::ByteArray] :iv The initialization vector
to use for encryption or decryption. This will be generated by the
system using secure random bytes for algorithms that require
it if it is not provided (optional)
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type
other than {Toybox::Lang::ByteArray ByteArray} is provided for
the +:key+ and +:iv+ options
@throws [Toybox::Lang::InvalidOptionsException] Thrown if a required
option is not provided, the +:algorithm+ and +:mode+ options are
not initialized with a valid enumeration, an invalid key size is
provided for the selected algorithm, or an invalid initialization
vector size is provided for the selected algorithm
@since 3.0.0
]]> Decrypt data with the key, depending on how the cipher was initialized.

Decryption can be broken up into two or more calls to decrypt(). For
MODE_CBC, the +ciphertext+ length (in bytes) must be a multiple of the
block size.
ciphertext [Toybox::Lang::ByteArray] The piece of data to decrypt

Returns [Toybox::Lang::ByteArray] The decrypted data

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::ByteArray ByteArray} is provided
@throws [Toybox::Cryptography::InvalidBlockSizeException] Thrown if
+ciphertext+ is not a valid size for the selected encryption type
@since 3.0.0
]]> Generate a shared secret for the KeyAgreement.
Returns [Toybox::Lang::ByteArray] The secret for the KeyAgreement

@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A dictionary of options for

the KeyAgreement
@option options [Toybox::Cryptography::KeyAgreementProtocol] :protocol The protocol to use
as a {Toybox::Cryptography KEY_AGREEMENT_*} value
@option options [Toybox::Cryptography::Key] :privateKey The private
key in the KeyAgreement
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if an argument is
not the correct type
@throws [Toybox::Lang::InvalidValueException] Thrown if the specified
private key is not the correct size for the selected algorithm, or
if the selected protocol is not supported
@since 3.0.0
]]> Add a public {Toybox::Cryptography::Key Key} to KeyAgreement.
key [Toybox::Cryptography::Key] The public key to add to the

agreement
@throws [Toybox::Lang::InvalidValueException] Thrown if the specified
key is not valid for the selected algorithm
@since 3.0.0
]]> Constructor
@since 3.0.0
]]> Get the bytes of a Key object.
Returns [Toybox::Lang::ByteArray]

@since 3.0.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Get the next {Toybox::SensorHistory::SensorSample SensorSample}
entry in the iterator.

This must be called to get the initial data from the iterator.
Returns [Toybox::SensorHistory::SensorSample] The next

SensorHistorySample, or +null+ if there are no more samples
@example Print out the next SensorSample data value
using Toybox.SensorHistory;
using Toybox.System;
// Given a valid SensorHistoryIterator object, print out the next
// entry in the iterator
System.println(sensorIter.next().data);
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@since 2.1.0
]]> Get the minimum {Toybox::SensorHistory::SensorSample SensorSample}
data value contained in this iterator.
Returns [Toybox::Lang::Number] The minimum SensorSample data value in

this iterator
@example Print out the minimum SensorSample data value
using Toybox.SensorHistory;
using Toybox.System;
// Given a valid SensorHistoryIterator object, print out the
// minimum sample value entry in the iterator
System.println(sensorIter.getMin().data);
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@since 2.1.0
]]> Get the maximum {Toybox::SensorHistory::SensorSample SensorSample}
data value contained in this iterator.
Returns [Toybox::Lang::Number] The maximum SensorSample data value in

this iterator
@example Print out the maximum SensorSample data value
using Toybox.SensorHistory;
using Toybox.System;
// Given a valid SensorHistoryIterator object, print out the
// maximum sample value entry in the iterator
System.println(sensorIter.getMax().data);
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@since 2.1.0
]]> Get the {Toybox::Time::Moment Moment} of the oldest
{Toybox::SensorHistory::SensorSample SensorSample} in this iterator.
Returns [Toybox::Time::Moment] The Moment of the oldest SensorSample

in this iterator
@example Print out the Moment of the oldest SensorSample
using Toybox.SensorHistory;
using Toybox.System;
// Given a valid SensorHistoryIterator object, print out the Moment
// of the oldest sample entry in the iterator
System.println(sensorIter.getOldestSampleTime());
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@see Toybox::Time::Moment
@since 2.1.0
]]> Get the {Toybox::Time::Moment Moment} of the newest
{Toybox::SensorHistory::SensorSample SensorSample} in this iterator.
Returns [Toybox::Time::Moment] The Moment of the newest SensorSample

in this iterator
@example Print out the Moment of the newest SensorSample
using Toybox.SensorHistory;
using Toybox.System;
// Given a valid SensorHistoryIterator object, print out the Moment
// of the newest sample entry in the iterator
System.println(sensorIter.getNewestSampleTime());
@see Toybox::SensorHistory::SensorHistoryIterator
@see Toybox::SensorHistory::SensorSample
@see Toybox::Lang::Method
@see Toybox::Time::Moment
@since 2.1.0
]]> Constructor
@since 2.3.0
]]> Constructor
@since 2.3.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.3.0
]]> Get a {Toybox::Position::Location Location} object that is offset from the current position by a given distance and angle.

angle [Toybox::Lang::Float] The angle in radians from north.

distance [Toybox::Lang::Float] The distance from the current position in meters (m).

Returns [Toybox::Position::Location] The projected location.

@since 3.0.0
]]> Get a Location object's coordinates in degrees.
Returns [Toybox::Lang::Array] An Array containing the latitude and

longitude as {Toybox::Lang::Double Doubles} in a degree format
@example
using Toybox.Position;
using Toybox.System;
Position.enableLocationEvents(Position.LOCATION_ONE_SHOT, method(:onPosition));

function onPosition(info) {
var myLocation = info.position.toDegrees();
System.println(myLocation[0]); // latitude (e.g. 38.856147)
System.println(myLocation[1]); // longitude (e.g -94.800953)
}
@since 1.0.0
]]> Constructor
Create a Location based on a set of coordinates.
options [Toybox::Lang::Array] An Array of options

@option options [Toybox::Lang::Number] :latitude The latitude
@option options [Toybox::Lang::Number] :longitude The longitude
@option options [Toybox::Lang::Symbol] :format The format of the provided latitude
and longitude as one of three possible values:
* :degrees
* :radians
* :semicircles
@example
using Toybox.Position;
var myLocation = new Position.Location(
{
:latitude => 38.856147,
:longitude => -94.800953,
:format => :degrees
}
);
@since 1.0.0
]]> Get a location object's coordinates in radians.
Returns [Toybox::Lang::Array] An Array containing latitude and longitude

as {Toybox::Lang::Double Doubles} in a radian format
@example
using Toybox.Position;
using Toybox.System;
Position.enableLocationEvents(Position.LOCATION_ONE_SHOT, method(:onPosition));

function onPosition(info) {
var myLocation = info.position.toRadians();
System.println(myLocation[0]); // latitude (e.g. 0.678197)
System.println(myLocation[1]); // longitude (e.g -1.654588)
}
@since 1.0.0
]]> Get a String representation a Location object's coordinates.
format [Toybox::Position::CoordinateFormat] A Position.GEO_* value

Returns [Toybox::Lang::String] A formatted coordinate String in the

specified format
@example
using Toybox.Position;
using Toybox.System;
var myLocation = new Position.Location(
{
:latitude => 38.856147,
:longitude => -94.800953,
:format => :degrees
}
);
var locString = myLocation.toGeoString(Position.GEO_DMS); // N 38 51'22.13" W 94 45' 3.44"
@since 1.0.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.2.1
]]> Constructor
aFrequency [Toybox::Lang::Number] The frequency of the tone in hertz (hz)

aDuration [Toybox::Lang::Number] The duration of the tone in milliseconds (ms)

@since 3.1.0
]]> Constructor
dutyCycleVal [Toybox::Lang::Number] The strength of the vibration

lengthVal [Toybox::Lang::Number] The length of the vibration in milliseconds (ms)

@since 1.0.0
]]> Called when a sync is started by the system.

This method should be used to kick-off the application sync process.
This includes any setup required to fetch the data needed to prepare
the sync, as well as the initial call to
{Toybox::Communications#makeWebRequest makeWebRequest()} to download
the first piece of content. Note that, when using this method,
you must chain your makeWebRequest() calls together manually.
Additionally, you must call {Toybox::Communications#notifySyncProgress notifySyncProgress()}
intermittently to enable sync progress updates to be displayed in
the native user interface for the device. Finally,
{Toybox::Communications#notifySyncComplete notifySyncComplete()} must be
called either when the sync has successfully completed, or if an
error occurs, so that the device can be properly notified that the
sync process is finished.
@since 3.1.0
]]> Called when an active sync is cancelled.

This method will be called when an active sync is being cancelled by
the user. The app is responsible for calling the
{Toybox::Communications#cancelAllRequests cancelAllRequests()} to
cancel any requests made for a sync process. The app is also responsible
to let the system know that sync has successfully been cancelled by
calling {Toybox::Communications#notifySyncComplete notifySyncComplete()}.
@since 3.1.0
]]> Check if a sync is needed.

Returns [Toybox::Lang::Boolean]

* When +true+, a sync is needed
* When +false+ a sync is not needed and {Toybox::Communications::SyncDelegate#onStartSync onStartSync} will not be called if a sync is triggered for this application
@since 3.1.0
]]> Get the next message from the mailbox.
Returns Message content, or +null+ if no messages

@since 1.0.0
]]> Callback when a communications operation error occurs.
@since 1.0.0
]]> Callback when a communications operation completes.
@since 1.0.0
]]> Constructor
@since 1.4.0
]]> Constructor
@since 1.3.0
]]> Called when a sync is started by the system.

This method should be used to kick-off the application sync process.
This includes any setup required to fetch the data needed to prepare
the sync, as well as the initial call to
{Toybox::Communications#makeWebRequest makeWebRequest()} to download
the first piece of audio content. Note that, when using this method,
you must chain your makeWebRequest() calls together manually.
Additionally, you must call {Toybox::Media#notifySyncProgress notifySyncProgress()}
intermittently to enable sync progress updates to be displayed in
the native user interface for the device. Finally,
{Toybox::Media#notifySyncComplete notifySyncComplete()} must be
called either when the sync has successfully completed, or if an
error occurs, so that the device can be properly notified that the
sync process is finished.
@since 3.0.0
]]> Called when an active sync is cancelled.

This method will be called when an active sync is being cancelled by
the user. The app is responsible for calling the
{Toybox::Communications#cancelAllRequests cancelAllRequests()} to
cancel any requests made for a sync process. The app is also responsible
to let the system know that sync has successfully been cancelled by
calling {Toybox::Media#notifySyncComplete notifySyncComplete()}.
@since 3.0.0
]]> Check if a sync is needed.

Returns [Toybox::Lang::Boolean]

* When +true+, a sync is needed
* When +false+ a sync is not needed and {Toybox::Media::SyncDelegate#onStartSync onStartSync} will not be called if a sync is triggered for this application
@since 3.0.0
]]> Get the next {Toybox::Media::ContentIterator ContentIterator}

Returns [Toybox::Media::ContentRefIterator] The next ContentRef

object, or +null+ if no more exist
@since 3.0.0
]]> Respond to a command to turn shuffle on or off.
@since 3.0.0
]]> Return a {Toybox::Media::ContentIterator ContentIterator}
object for the system to use to iterate over media tracks.
Returns [Toybox::Media::ContentIterator]

@since 3.0.0
]]> Respond to a user ad click.

adContext [Toybox::Lang::Object] Context information for the

ad that was clicked
@since 3.0.0
]]> Respond to a thumbs-up action.

The thumbs-up option is native to the device media player.
When a user selects the thumbs-up function on the device, a
corresponding onThumbsUp() event is sent to the application.
contentRefId [Toybox::Lang::Object] ID referencing a

{Toybox::Media::ContentRef ContentRef} object
@since 3.0.0
]]> Handle a notification from a system that a song has been played.
contentRefId [Toybox::Lang::Object] The ID referencing a {Toybox::Media::ContentRef ContentRef} object

songEvent [Toybox::Media::SongEvent] A {Toybox::Media::SONG_EVENT_START SONG_EVENT_*}

value indicating the triggered event
playbackPosition [Toybox::Lang::Number, Toybox::Media::PlaybackPosition] The time the song has

been playing in seconds, or a {Toybox::Media::PLAYBACK_POSITION_START PLAYBACK_POSITION_*} value
@since 3.0.0
]]> Respond to a command to change repeat mode

@since 3.0.0
]]> Reset the {Toybox::Media::ContentIterator ContentIterator}
to the beginning of the current playlist.
Returns [Toybox::Media::ContentIterator] An instance of the newly

reset ContentIterator
@since 3.0.0
]]> Respond to a thumbs-down action.

The thumbs-down option is native to the device media player.
When a user selects the thumbs-down function on the device, a
corresponding onThumbsDown() event is sent to application.
contentRefId [Toybox::Lang::Object] ID referencing a

{Toybox::Media::ContentRef ContentRef} object
@since 3.0.0
]]> Handle a CustomButton being selected in the Media Player
button [Toybox::Media::CustomButton] The CustomButton that was pressed.

@since 3.0.3
]]> Constructor
icon [Toybox::WatchUi::BitmapResource, Toybox::Lang::ResourceId] The icon.

accentColor [Toybox::Graphics::ColorType] A {Toybox::Graphics Graphics.COLOR_*} value to indicate the icon's

accent color
@since 3.0.0
]]> Set the metadata for this object
@since 3.0.0
]]> Get the metadata for this object
@since 3.0.0
Returns [Toybox::Media::ContentMetadata]

]]> Get the underlying ContentRef object
@since 3.0.0
Returns [Toybox::Media::ContentRef]

]]> Get the playback start position for media content
@since 3.0.0
Returns [Toybox::Lang::Number]

]]> Constructor

contentRef [Toybox::Media::ContentRef] A reference to media content

metadata [Toybox::Media::ContentMetadata] The metadata associated with referenced media content

@since 3.0.0
]]> Constructor
type [Toybox::Media::PlaybackControl] A PLAYBACK_CONTROL_* value for the button.

options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::Lang::Boolean] :disabled Set to +true+ if the button is disabled, otherwise +false+
@since 3.0.3
]]> Called by the system to draw the button in the Media Player
image [Toybox::Media::ButtonImage] A BUTTON_IMAGE_* value

state [Toybox::Media::ButtonState] A BUTTON_STATE_* value indicating the current state of the button

highlighted [Toybox::Lang::Boolean] Set to +true+ if the button is highlighted, otherwise +false+

Returns [Toybox::Lang::Number, Toybox::WatchUi::BitmapResource, Toybox::Graphics::BitmapReference] A bitmap

representation of the button or a 24-bit RRGGBB color
@note {Toybox::Graphics::BitmapReference BitmapReference} is only supported in CIQ 4.0.0 and later
@since 3.0.3
]]> Called by the system to determine if the current state of the button
Returns [Toybox::Media::ButtonState] A BUTTON_STATE_* enum value representing the current state of the button

@since 3.0.3
]]> Called by the system to draw the name of the button
state [Toybox::Media::ButtonState] A BUTTON_STATE_* value indicating the current state of the button

Returns [Toybox::Lang::String] the name of the button

@since 3.0.3
]]> Called by the system to draw the button in the Media Player
image [Toybox::Media::ButtonImage] A BUTTON_IMAGE_* value

highlighted [Toybox::Lang::Boolean] +true+ if the button is highlighted, otherwise +false+

Returns [Toybox::WatchUi::BitmapResource, Toybox::Graphics::BitmapReference] A bitmap representation of the button

@note {Toybox::Graphics::BitmapReference BitmapReference} is only supported in CIQ 4.0.0 and later.
@since 3.0.3
]]> Get the next media content object.

Returns [Toybox::Media::Content]

* A {Toybox::Media::Content Content} object representing the next track
* +null+ if no tracks remain
* An error object if an error occurred. This can be anything that inherits from {Toybox::Lang::Object Object}, but it must implement toString().
@since 3.0.0
]]> Get the current media content playback profile
@since 3.0.0
Returns [Toybox::Media::PlaybackProfile]

]]> Get the current repeat state

Returns [Toybox::Media::RepeatMode] The {Toybox::Media::REPEAT_MODE_OFF REPEAT_MODE_*}

enum value that represents the current repeat state
@since 3.0.0
]]> Get the previous media content object.

Returns [Toybox::Media::Content]

* A {Toybox::Media::Content Content} object representing the next track.
* +null+ if no tracks remain.
* An error object if an error occurred. This can be anything that inherits from {Toybox::Lang::Object Object}, but it must implement toString().
@since 3.0.0
]]> Get the next media content object without incrementing the iterator.

Returns [Toybox::Media::Content]

* A {Toybox::Media::Content Content} object representing the current track
* +null+ if no tracks remain
* An error object if an error has occurred. This can be anything that inherits from {Toybox::Lang::Object Object}, but it must implement toString()
@since 3.0.0
]]> Get the current media content object.

Returns [Toybox::Media::Content]

* A {Toybox::Media::Content Content} object representing the current track
* +null+ if no tracks remain
* An error object if an error has occurred. This can be anything that inherits from {Toybox::Lang::Object Object}, but it must implement toString()
@since 3.0.0
]]> Get the previous media content object without decrementing the iterator.

Returns [Toybox::Media::Content]

* A {Toybox::Media::Content Content} object representing the current track
* +null+ if no tracks remain
* An error object if an error has occurred. This can be anything that inherits from {Toybox::Lang::Object Object}, but it must implement toString()
@since 3.0.0
]]> Determine if playback is currently set to shuffle.

Returns +true+ if shuffle is on, otherwise +false+.
@since 3.0.0
Returns [Toybox::Lang::Boolean]

]]> Determine if the the current track can be skipped.

Returns [Toybox::Lang::Boolean] Returns +true+ if the current track

can be skipped, otherwise +false+.
@since 3.0.0
]]> Get the media content type.

Returns [Toybox::Media::ContentType] A {Toybox::Media::CONTENT_TYPE_INVALID CONTENT_TYPE_*}

value
@since 3.0.0
]]> Get the content ref ID.

Returns [Toybox::Lang::Object] The ID parameter value for the current

ContentRef object
@since 3.0.0
]]> Constructor

id [Toybox::Lang::Object] A unique identifier for this

ContentRef object
type [Toybox::Media::ContentType] One of the

{Toybox::Media::CONTENT_TYPE_INVALID CONTENT_TYPE_*} enum values
@since 3.0.0
]]> Get the playback start position for media content
@since 3.0.0
Returns [Toybox::Lang::Number]

]]> Constructor

contentRef [Toybox::Media::ContentRef] A reference to media content

metadata [Toybox::Media::ContentMetadata] The metadata associated with referenced media content

playbackStartPos [Toybox::Lang::Number] Playback start position for the media content in seconds

@since 3.0.0
]]> Determine whether a key exists within a Dictionary.
key [Toybox::Lang::Object] The key to check against

Returns [Toybox::Lang::Boolean] +true+ if the key is in the Dictionary,

otherwise +false+
@since 1.0.0
]]> Retrieve the number of elements in a Dictionary.
Returns [Toybox::Lang::Number] The number of elements in the Dictionary

@since 1.0.0
]]> Retrieve the keys in the Dictionary.
Returns [Toybox::Lang::Array] An Array of keys in the Dictionary

@since 1.0.0
]]> Retrieve a value from a Dictionary for a given key.
key [Toybox::Lang::Object] The key to check against

Returns [Toybox::Lang::Object] The value for the specified key, or

+null+ if the key does not exist
@since 1.0.0
]]> Retrieve the values in the Dictionary.
Returns [Toybox::Lang::Array] An Array of values in the Dictionary

@since 1.0.0
]]> Determine whether a Dictionary is empty.
Returns [Toybox::Lang::Boolean] +true+ if the Dictionary is empty,

otherwise +false+
@since 1.0.0
]]> Convert a Dictionary to a String.

Due to the nature of hash tables, the order of Dictionary elements are
not guaranteed to match the insertion order when converting to a String.
Returns [Toybox::Lang::String] A String representation of the Dictionary

@example
using Toybox.System;
myDict = {
"One" => 1,
"Two" => 2,
"Three" => 3
};
System.println(myDict.get("One")); // prints 1

var myString = myDict.toString();
System.println(myString); // "{Two=>2, One=>1, Three=>}"
System.println(myString.get("One")); // Symbol Not Found Error
System.println(myString.substring(0, 5)); // "{Two="
@see https://en.wikipedia.org/wiki/Hash_table Hash Tables
@since 1.0.1
]]> Place a value in the Dictionary with a given key.
key [Toybox::Lang::Object] The key for the value being inserted

into the Dictionary
value [Toybox::Lang::Object] The value to insert into the Dictionary

@since 1.0.0
]]> Delete an item from a Dictionary.
key [Toybox::Lang::Object] The key of the value to be removed

@since 1.0.0
]]> InvalidOptionsException constructor.
msg [Toybox::Lang::String] The exception message

@since 2.3.0
]]> Convert a Symbol to a String

This will return the string for the name of the symbol in development builds.
Because Monkey C does not contain runtime reflection information in release
builds, the returned string will be different and will follow the format "symbol (num)".
In this format, "num" is the integer value of the symbol.
Returns [String] The String representation of the Symbol

@since 1.0.0
]]> Convert a Symbol to a Number

This will return a number containing the integer value of the symbol.
Returns [Number] The number representation of the Symbol

@since 2.3.0
]]> Convert a String to a Long using a specified base.
base [Toybox::Lang::Object] The base of the input string.

If the value of +base+ is zero, the string content is expected to have
syntax similar to that of integer constants, which includes:
* An optional sign character ('+' or '-')
* An optional prefix for octal or hexadecimal ('0' or '0x')
* A sequence of digits in the prefixed base, or decimal if none was specified.
If the base value is between 2 and 36, the format expected for the
number is valid digits and/or letters that represent integers of
the specified radix (from '0' to 'z' or 'Z' for base 36).
Returns [Toybox::Lang::Long] A Long representation of the String

@example
var myString;
var myNum;

myString = "10";
myNum = myString.toLongWithBase(2); // myNum is 2

myString = "FF";
myNum = myString.toLongWithBase(16); // myNum is 255
myNum = myString.toLongWithBase(0x10); // myNum is 255
@since 3.1.0
]]> Convert a String to an Array of Char objects.
Returns [Toybox::Lang::Array] A Char Array representation of the String,

where each character in the String is an element in the Array
@since 1.3.0
]]> Convert a String to an Array of Number objects.

Each Number represents one byte of the UTF-8 representation of the String.
Returns [Toybox::Lang::Array] An Array representation of the String,

where each byte in the string is an element in the Array
@since 1.3.0
]]> Convert a String to a Long.

If a String is in the numeric form of "123", it can be converted to
a Long. Additional characters after the detected number value will
be ignored. Strings that cannot be interpreted as a Long, or whose
value exceeds that which can be represented in a Long, will result
in a +null+ value.
Returns [Toybox::Lang::Long] A Long representation of the String

@example
var myString;
var myNum;

myString = "123";
myNum = myString.toLong(); // myNum is 123

myString = "3.14"
myNum = myString.toLong(); // myNum is 3

myString = "1200 E. 151st. Street"
myNum = myString.toLong(); // myNum is 1200

myString = "Hello There!"
myNum = myString.toLong(); // null
@since 3.1.0
]]> Convert a String to lowercase.
Returns [Toybox::Lang::String] A new lowercase String

@since 1.0.0
]]> Convert a String to a Number using a specified base.
base [Toybox::Lang::Object] The base of the input string.

If the value of +base+ is zero, the string content expected to have
syntax similar to that of integer constants, which includes:
* An optional sign character ('+' or '-')
* An optional prefix for octal or hexadecimal ('0' or '0x')
* A sequence of digits in the prefixed base, or decimal if none was specified.
If the base value is between 2 and 36, the format expected for the
number is valid digits and/or letters that represent integers of
the specified radix (from '0' to 'z' or 'Z' for base 36).
Returns [Toybox::Lang::Number] A Number representation of the String

@example
var myString;
var myNum;

myString = "10";
myNum = myString.toNumberWithBase(2); // myNum is 2

myString = "FF";
myNum = myString.toNumberWithBase(16); // myNum is 255
myNum = myString.toNumberWithBase(0x10); // myNum is 255
@since 1.4.1
]]> Convert a String to a Float.

If a String is in the numeric form of "123" or "123.45", convert it
to a Float. Additional characters after the detected floating point
value will be ignored. Strings that cannot be interpreted as a Float,
or whose value exceeds that which can be represented in a Float, will
result in a +null+ value.
Returns [Toybox::Lang::Float] A Float representation of the String

@example
var myString;
var myNum;

myString = "123";
myNum = myString.toFloat(); // myNum is 123.000000

myString = "3.14"
myNum = myString.toFloat(); // myNum is 3.140000

myString = "192.168.0.1"
myNum = myString.toFloat(); // myNum is 192.167999

myString = "Hello There!"
myNum = myString.toFloat(); // null
@since 1.0.0
]]> Get the number of characters in a String.
Returns [Toybox::Lang::Number] The length of the String

@since 1.0.0
]]> Create a new String that contains the contents of the current String
from a start position to an end position.
@note Starting with 3.3.2, passing null for +startIndex+ sets it to the
start of the string and passing null for +endIndex+ sets it to the end
of the string. Passing in a negative number for either +startIndex+ or
+endIndex+ offsets it from the end of the string.
startIndex [Toybox::Lang::Number] Zero-based start index of

the substring
endIndex [Toybox::Lang::Number] End position of the substring,

exclusive
Returns [Toybox::Lang::String] The substring of the String or +null+

on error
@example
var myString = "Go bananas with Monkey C!";
var mySubString = myString.substring(3, 10); // mySubString is "bananas"
@since 1.0.0
]]> Convert a String to a Double.

If a String is in the numeric form of "123" or "123.45", convert it
to a Double. Additional characters after the detected floating point
value will be ignored. Strings that cannot be interpreted as a Double,
or whose value exceeds that which can be represented in a Double, will
result in a +null+ value.
Returns [Toybox::Lang::Double] A Double representation of the String

@example
var myString;
var myNum;

myString = "123";
myNum = myString.toDouble(); // myNum is 123.000000

myString = "3.14"
myNum = myString.toDouble(); // myNum is 3.140000

myString = "192.168.0.1"
myNum = myString.toDouble(); // myNum is 192.167999

myString = "Hello There!"
myNum = myString.toDouble(); // null
@since 3.1.0
]]> Get a hash code value for a String.
Returns [Toybox::Lang::Number] The hash code for the String

@since 1.0.0
]]> Determine if the specified String exists in a String.
string [Toybox::Lang::String] String to find

Returns [Toybox::Lang::Number] The index of the start of the specified

String, or +null+ if not found
@example
var myString = "Go bananas with Monkey C!";
var index = myString.find("bananas"); // index is 3
@since 1.0.0
]]> Test if an Object instance is equal to another instance of an Object.
other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if the Objects are equal,

otherwise +false+
@since 1.0.0
]]> Convert a String to uppercase.
Returns [Toybox::Lang::String] A new uppercase String

@since 1.0.0
]]> Convert a String to a String.
Returns [Toybox::Lang::String] A String representation of String

@since 1.0.0
]]> Convert a String to a Number.

If a String is in the numeric form of "123", it can be converted to
a Number. Additional characters after the detected number value will
be ignored. Strings that cannot be interpreted as a Number, or whose
value exceeds that which can be represented in a Number, will result
in a +null+ value.
Returns [Toybox::Lang::Number] A Number representation of the String

@example
var myString;
var myNum;

myString = "123";
myNum = myString.toNumber(); // myNum is 123

myString = "3.14"
myNum = myString.toNumber(); // myNum is 3

myString = "1200 E. 151st. Street"
myNum = myString.toNumber(); // myNum is 1200

myString = "Hello There!"
myNum = myString.toNumber(); // null
@since 1.0.0
]]> SymbolNotAllowedException constructor.
@since 2.2.0
]]> InvalidValueException constructor.
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Get the absolute value of a Number.
Returns [Toybox::Lang::Number] The absolute value of the Number

@since 1.0.0
]]> Convert a Number to a Double.
Returns [Toybox::Lang::Double] A Double representation of the Number

@since 1.0.0
]]> Convert a Number to a Long.
Returns [Toybox::Lang::Long] A Long representation of the Number

@since 1.0.0
]]> Convert a Number to a Float.
Returns [Toybox::Lang::Float] A Float representation of the Number

@since 1.0.0
]]> Format a Number using a formatting String.

The formatting string is similar to that available in +printf+ from the
C stdio library, though the +length+ option is not available:
"%[flags][width][.precision]specifier"
[specifiers]
* *d* or *i* - signed decimal integer
* *e* - scientific notation (mantissa/exponent) using 'e' character
* *E* - scientific notation (mantissa/exponent) using 'E' character
* *f* - decimal floating point
* *o* - signed octal
* *u* - unsigned decimal integer
* *x* - unsigned hexadecimal integer
* *X* - unsigned hexadecimal integer (capital letters)
[flags]
* + - Prepends the result with a plus or minus sign ('+' or '-'), including positive numbers. By default, only negative numbers are preceded with a '-' sign.
* *0* - Left-pads the number with zeros (0) instead of spaces, where padding is specified (see width sub-specifier).
[width]
supports only numbers (* is not supported)
[.precision]
supports only numbers (* is not supported)
Returns [Toybox::Lang::String] A formatted String

@example Formatting time with leading zeros
// Format the time to display "08:03:15"
using Toybox.Lang;
var hours = 8;
var minutes = 3;
var seconds = 15;
var myTime = Lang.format(
"$1$:$2$:$3$",
[hours.format("%02d"), minutes.format("%02d"), seconds.format("%02d")]
);
@see https://forums.garmin.com/showthread.php?255191-Formatted-Output Formatted output forum thread
@since 1.0.0
]]> Convert a Number to a Number.
Returns [Toybox::Lang::Number] A Number representation of the Number

@since 1.0.0
]]> Convert a Number to a Char.
Returns [Toybox::Lang::Char] A Char representation of the Number

@since 1.3.0
]]> Convert a Char to lowercase.
Returns [Toybox::Lang::Char] A new lowercase Char

@since 1.3.0
]]> Convert a Char to uppercase.
Returns [Toybox::Lang::Char] A new uppercase Char

@since 1.3.0
]]> Convert a Char to a String.
Returns [Toybox::Lang::String] The String representation of the Char

@since 1.3.0
]]> Convert a Char to a Number.
Returns [Toybox::Lang::Number] The UTF-32 representation of the Char

interpreted as a Number
@since 1.3.0
]]> Get the Object referenced by the WeakReference
Returns [Toybox::Lang::Object] The Object referenced, or +null+ if

the Object no longer exists
@since 1.2.0
]]> Determine whether a WeakReference is still alive.
Returns [Toybox::Lang::Boolean] +true+ if object is still alive,

otherwise +false+
@note I feel FANTASTIC and I am still alive. When you're dying I'll
be still alive. And when you're dead I will be still alive.
@see http://knowyourmeme.com/memes/still-alive-portal-end-theme
@since 1.2.0
]]> Add a byte to the end of a ByteArray.

When adding a byte, the ByteArray size is increased and new
bytes are inserted at the end.
byte [Toybox::Lang::Number, Toybox::Lang::Char] The

Number or Char byte to be added
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type
other than {Toybox::Lang::Number Number} or
{Toybox::Lang::Char Char} is provided
@throws [Toybox::Lang::ValueOutOfBoundsException] Thrown if a
{Toybox::Lang::Number Number} greater than 255 or less than -128
is provided, or if a {Toybox::Lang::Char Char} with a code point
greater than 127 is provided. Negative numbers added are
interpreted as the positive 8-bit unsigned equivalent once added
to the ByteArray.
Returns [Toybox::Lang::ByteArray] A ByteArray composed of the

original ByteArray plus the added byte
@since 3.0.0
]]> Encodes a number into the byte array
value [Toybox::Lang::Object] The value to encode

format [Toybox::Lang::NumberFormat] A {Toybox::Lang::NUMBER_FORMAT_FLOAT Lang.NUMBER_FORMAT_*} value

representing the number format to encode.
options [Toybox::Lang::Dictionary] A Dictionary containing

conversion options
@option options [Toybox::Lang::Number] :offset The 0 based offset in the
array to begin encoding. Default value is 0.
@option options [Toybox::Lang::Endian] :endianness A {Toybox::Lang::Endian Lang.ENDIAN_*} value
representing the endianness of the number to encode. Default value is
{Toybox::Lang::ENDIAN_LITTLE Lang.ENDIAN_LITTLE}.
@throws [Toybox::Lang::InvalidOptionsException] Indicates that one of
the options provided is not valid.
@since 3.1.0
]]> Return a new ByteArray that contains the elements of a source
ByteArray in reverse order.

Returns [Toybox::Lang::ByteArray] A new ByteArray with elements in

reversed order
@since 3.0.0
]]> Decodes a portion of the array to a number based on a specified format
format [Toybox::Lang::NumberFormat] A {Toybox::Lang::NUMBER_FORMAT_FLOAT Lang.NUMBER_FORMAT_*} value

representing the number format to decode.
options [Toybox::Lang::Dictionary] A Dictionary containing

conversion options
@option options [Toybox::Lang::Number] :offset The 0 based offset in the
array to begin decode. Default value is 0.
@option options [Toybox::Lang::Endian] :endianness A {Toybox::Lang::Endian Lang.ENDIAN_*} value
representing the endianness of the number to decode. Default value is
{Toybox::Lang::ENDIAN_LITTLE Lang.ENDIAN_LITTLE}.
@throws [Toybox::Lang::InvalidOptionsException] Indicates that one of
the options provided is not valid.
Returns [Toybox::Lang::Number, Toybox::Lang::Long, Toybox::Lang::Float]

Converted Number.
@since 3.1.0
]]> Remove a byte from a ByteArray.

If the passed byte is found, the ByteArray size is decreased by one and
elements beyond it are shifted to the next lower index. If the ByteArray
has multiple matches, the matching byte at the lowest index will be
removed but the other matching bytes will not be removed.

If no byte is provided as an argument, the ByteArray will remain unchanged
and +remove()+ will return +false+.
byte [Toybox::Lang::Number, Toybox::Lang::Char] The byte to

remove from the ByteArray
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::Number Number} or {Toybox::Lang::Char Char}
is provided
@throws [Toybox::Lang::ValueOutOfBoundsException] Thrown if a
{Toybox::Lang::Number Number} greater than 255 or less than -128
is provided, or if a {Toybox::Lang::Char Char} with a code point
greater than 127 is provided. Negative numbers provided are
interpreted as the positive 8-bit unsigned equivalent when
searching the ByteArray.
Returns [Toybox::Lang::Boolean] Returns +true+ if instances of the byte are

found, otherwise +false+
@since 3.0.0
]]> Remove bytes from a ByteArray.

For each instance of the byte that is found, the ByteArray size is
decreased by one and elements beyond it are shifted to the next lower
index.

If no byte is given as an argument, the ByteArray will remain unchanged
and +removeAll()+ will return +false+.
byte [Toybox::Lang::Number, Toybox::Lang::Char] The byte to

remove from the ByteArray
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::Number Number} or {Toybox::Lang::Char Char}
is provided
@throws [Toybox::Lang::ValueOutOfBoundsException] Thrown if a
{Toybox::Lang::Number Number} greater than 255 or less than -128 is
provided, or if a {Toybox::Lang::Char Char} with a code point
greater than 127 is provided. Negative numbers provided
are interpreted as the positive 8-bit unsigned equivalent when
searching the ByteArray.
Returns [Toybox::Lang::Boolean] Returns +true+ if instances of

the byte are found, otherwise +false+.
@since 3.0.0
]]> Get the size of a ByteArray.

Returns [Toybox::Lang::Number] The number of elements in the ByteArray.

@since 3.0.0
]]> Add a ByteArray or an {Toybox::Lang::Array Array} of bytes to the end
of a ByteArray.

When adding an array of bytes, the ByteArray is expanded by the size
of the provided ByteArray or Array, and all of the new elements are
inserted starting at the new index.
array [Toybox::Lang::ByteArray, Toybox::Lang::Array] The

ByteArray or Array of bytes to be added to the ByteArray
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than ByteArray or an {Toybox::Lang::Array Array} of bytes is provided
Returns [Toybox::Lang::ByteArray] A ByteArray composed of the

original ByteArray plus the added byte(s)
@since 3.0.0
]]> Get a new ByteArray containing a portion of an existing ByteArray.

startIndex [Toybox::Lang::Number, null] A zero-based index of the

start of the new ByteArray. If a negative +startIndex+ is provided,
it will offset from the end of the ByteArray. If the +startIndex+
is +null+, the slice will begin at 0. An out-of-bounds index will
be truncated to the ByteArray limits.
endIndex [Toybox::Lang::Number, null] A zero-based index of the end

of the new ByteArray. Items are included up to, but not including
+endIndex+. If a negative +endIndex+ is provided, it will offset
from the end of the ByteArray. If +endIndex+ is +null+, the
slice will end at the last element. An out-of-bounds index is
truncated to the ByteArray limits.
Returns [Toybox::Lang::ByteArray] A new ByteArray containing the

elements from +startIndex+ to +endIndex+
@since 3.0.0
]]> Get a hash code value for a ByteArray.
Returns [Toybox::Lang::Number] The hash code for the ByteArray

@since 3.0.0
]]> Test if an Object instance is equal to another instance of an Object.
other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if Objects are equal, otherwise

+false+
@example
var a = [ 1, 2 ]b;
var b = [ 1, 2 ]b;
var c = [ 1, 2 ];
a.equals(b); // returns true
a.equals(c); // returns false
@since 3.0.0
]]> Convert a ByteArray to a String.

This does not convert the elements of the ByteArray into Strings, but
transforms the entire ByteArray into a String.
Returns [Toybox::Lang::String] A String representation of the ByteArray

@since 3.0.0
]]> Get the index of a byte within the ByteArray.

byte [Toybox::Lang::Number, Toybox::Lang::Char] The byte whose

index is to be found
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if a type other
than {Toybox::Lang::Number Number} or
{Toybox::Lang::Char Char} is provided
@throws [Toybox::Lang::ValueOutOfBoundsException] Thrown if a
{Toybox::Lang::Number Number} greater than 255 or less than -128 is
provided, or if a {Toybox::Lang::Char Char} with a code point greater
than 127 is provided. Negative numbers provided are interpreted
as the positive 8-bit unsigned equivalent when searching the ByteArray.
Returns [Toybox::Lang::Number] The index of the first instance of

the provided byte in the ByteArray. If the byte is not found, -1
is returned.
@since 3.0.0
]]> SerializationException constructor.
msg [Toybox::Lang::String] The exception message

@since 2.4.2
]]> Get a hash code value for a Method.
This computes a 32-bit Number that is typically used as an index when
placing Objects into a Dictionary. Hash code values have the following
characteristics:
* The computed hash code is constant for the lifetime of an Object
* If two Objects are equal, their hash codes will be equal
Returns [Toybox::Lang::Number] A hash code for the Method

@see https://en.wikipedia.org/wiki/Hash_function Hash Function
@see https://en.wikipedia.org/wiki/Hash_table Hash Tables
@since 1.0.0
]]> Invoke a Method.
parameters... [Toybox::Lang::Object] The parameters required by

the invoked Method
Returns [Toybox::Lang::Object] The return value from the invoked Method

@since 1.0.0
]]> Method Constructor.
aClass Classdef of method (e.g. Toybox.SensorHistory) or

a class instance.
aMethod [Toybox::Lang::Symbol] Symbol of class method

@since 1.0.0
]]> Get the absolute value of a Double.
Returns [Toybox::Lang::Double] The absolute value of the Double

@since 1.0.0
]]> Convert a Double to a Double.
Returns [Toybox::Lang::Double] A Double representation of the Double

@since 1.0.0
]]> Convert a Double to a Long.
Returns [Toybox::Lang::Long] A Long representation of the Double

@since 1.0.0
]]> Test if an Object instance is equal to another instance of an Object.
other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if the Objects are equal,

otherwise +false+
@since 1.3.0
]]> Convert a Double to a Float.
Returns [Toybox::Lang::Float] A Float representation of the Double

@since 1.0.0
]]> Format a Double using a formatting String.

The formatting string is similar to that available in +printf+ from the
C stdio library, though the +length+ option is not available:
"%[flags][width][.precision]specifier"
[specifiers]
* *d* or *i* - signed decimal integer
* *e* - scientific notation (mantissa/exponent) using 'e' character
* *E* - scientific notation (mantissa/exponent) using 'E' character
* *f* - decimal floating point
* *o* - signed octal
* *u* - unsigned decimal integer
* *x* - unsigned hexadecimal integer
* *X* - unsigned hexadecimal integer (capital letters)
[flags]
* + - Prepends the result with a plus or minus sign ('+' or '-'), including positive numbers. By default, only negative numbers are preceded with a '-' sign.
* *0* - Left-pads the number with zeros (0) instead of spaces, where padding is specified (see width sub-specifier).
[width]
supports only numbers (* is not supported)
[.precision]
supports only numbers (* is not supported)
Returns [Toybox::Lang::String] A formatted String

@since 1.0.0
]]> Convert a Double to a String.
Returns [Toybox::Lang::String] The String representation of the Double

@since 1.0.0
]]> Convert a Double to a Number.

The Double value will be rounded toward 0 upon conversion. For example,
6.8 becomes 6 and -5.7 becomes -5.
Returns [Toybox::Lang::Number] A Number representation of the Double

@since 1.0.0
]]> OperationNotAllowedException constructor.
@since 3.1.0
]]> Print the stack trace of the thrown Exception.
@since 1.1.2
]]> Exception constructor.
@since 1.1.2
]]> Get the error message for the Exception.
Returns [Toybox::Lang::String] The Exception's error message, or +null+

if no message is given
@since 1.2.0
]]> Add an Object to the end of an Array.

When adding an Object, the Array size is increased by one and the new
Object is inserted at the new index.
object [Toybox::Lang::Object] The Object to be added to the Array

Returns [Toybox::Lang::Array] self

@since 1.3.0
]]> Remove Objects from an Array.

For each instance of the Object that is found, the Array size is
decreased by one and elements beyond it are shifted to the next lower
index.
object [Toybox::Lang::Object] The Object to be removed from

the Array
Returns [Toybox::Lang::Boolean] +true+ if instances of the Object are

found, otherwise +false+
@since 1.3.0
]]> Get the size of an Array.
Returns [Toybox::Lang::Number] The number of elements in the Array

@since 1.0.0
]]> Add an Array of Objects to the end of an Array.

When adding an Array of Objects, the Array is expanded by the size of
the provided Array, and all of the new elements are inserted starting
at the new index.
array [Toybox::Lang::Array] The Array of Objects to be added

to the Array
Returns [Toybox::Lang::Array] self

@since 1.3.0
]]> Get a new Array containing a portion of an existing Array.
startIndex [Toybox::Lang::Number, null] A zero-based index of the

start of the new Array. If a negative +startIndex+ is provided, it
will offset from the end of the Array. If the +startIndex+ is +null+,
the slice will begin at 0. An out-of-bounds index will be truncated
to the array limits.
endIndex [Toybox::Lang::Number, null] A zero-based index of the end

of the new Array. Items are included up to, but not including +endIndex+.
If a negative +endIndex+ is provided, it will offset from the end of
the Array. If +endIndex+ is +null+, the the slice will end at the last
element. An out-of-bounds index will be truncated to the Array limits.
Returns [Toybox::Lang::Array] A new Array containing the elements from

+startIndex+ to +endIndex+
@example
var myArray = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];

// Get the first five elements of the Array
var newArray1 = myArray.slice(0, 5); // [1, 2, 3, 4, 5]

// Get the last element of the Array
var newArray2 = myArray.slice(-1, null); // [10]

// Slice off the first and last elements from the Array
var myArray3 = myArray.slice(1, -1); // [2, 3, 4, 5, 6, 7, 8, 9]
@since 1.3.0
]]> Convert an Array to a String.

This does not convert the elements of the Array into Strings, but
transforms the entire Array into a String.
Returns [Toybox::Lang::String] A String representation of the Array

@example
using Toybox.System;
var myArray = [1, 2, 3, 4, 5];
System.println(myArray[1]); // prints 1

var myString = myArray.toString();
System.println(myString); // "[1, 2, 3, 4, 5]"
System.println(myString[1]); // UnexpectedTypeException
System.println(myString.substring(0, 5)); // "[1, 2"
@since 1.0.0
]]> Return a new Array that contains the elements of a source Array in
reverse order.
Returns [Toybox::Lang::Array] A new Array with elements in reversed order

@since 1.3.0
]]> Get the index of an Object within the Array.
object [Toybox::Lang::Object] The Object whose index is to be found

Returns [Toybox::Lang::Number] The index of the first instance of the provided

Object in the Array. If the Object is not found, -1 is returned.
@since 1.3.0
]]> Remove an Object from an Array.

If the passed Object is found, the Array size is decreased by one and
elements beyond it are shifted to the next lower index. If the Array
has multiple matches, the matching Object at the lowest index will be
removed but the other matching Objects will not be removed.
object [Toybox::Lang::Object] The object to be removed from

the Array
Returns [Toybox::Lang::Boolean] +true+ if instances of the object are

found, otherwise +false+
@since 1.3.0
]]> Get the absolute value of a Float.
Returns [Toybox::Lang::Float] The absolute value of the Float

@since 1.0.0
]]> Convert a Float to a Double.
Returns [Toybox::Lang::Double] A Double representation of the Float

@since 1.0.0
]]> Convert a Float to a Long.
Returns [Toybox::Lang::Long] A Long representation of the Float

@since 1.0.0
]]> Convert a Float to a Float.
Returns [Toybox::Lang::Float] A Float representation of the Float

@since 1.0.0
]]> Format a Float using a formatting String.

The formatting string is similar to that available in +printf+ from the
C stdio library, though the +length+ option is not available:
"%[flags][width][.precision]specifier"
[specifiers]
* *d* or *i* - signed decimal integer
* *e* - scientific notation (mantissa/exponent) using 'e' character
* *E* - scientific notation (mantissa/exponent) using 'E' character
* *f* - decimal floating point
* *o* - signed octal
* *u* - unsigned decimal integer
* *x* - unsigned hexadecimal integer
* *X* - unsigned hexadecimal integer (capital letters)
[flags]
* + - Prepends the result with a plus or minus sign ('+' or '-'), including positive numbers. By default, only negative numbers are preceded with a '-' sign.
* *0* - Left-pads the number with zeros (0) instead of spaces, where padding is specified (see width sub-specifier).
[width]
supports only numbers (* is not supported)
[.precision]
supports only numbers (* is not supported)
Returns [Toybox::Lang::String] A formatted String

@since 1.0.0
]]> Convert a Float to a Number.

The Float value will be rounded toward 0 upon conversion. For example,
6.8 becomes 6 and -5.7 becomes -5.
Returns [Toybox::Lang::Number] A Number representation of the Float

@since 1.0.0
]]> Convert a ResourceId to a String

Returns [Toybox::Lang::String] The String representation of the ResourceId

@since 1.0.0
]]> ValueOutOfBoundsException constructor.
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Get the absolute value of a Long.
Returns [Toybox::Lang::Long] The absolute value of the Long

@since 1.0.0
]]> Convert a Long to a Double.
Returns [Toybox::Lang::Double] A Double representation of the Long

@since 1.0.0
]]> Convert a Long to a Long.
Returns [Toybox::Lang::Long] A Long representation of the Long

@since 1.0.0
]]> Test if an Object instance is equal to another instance of an Object.
other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if the Objects are equal,

otherwise +false+
@since 1.3.0
]]> Convert a Long to a Float.
Returns [Toybox::Lang::Float] A Float representation of the Long

@since 1.0.0
]]> Format a Long using a formatting String.

The formatting string is similar to that available in +printf+ from the
C stdio library, though the +length+ option is not available:
"%[flags][width][.precision]specifier"
[specifiers]
* *d* or *i* - signed decimal integer
* *e* - scientific notation (mantissa/exponent) using 'e' character
* *E* - scientific notation (mantissa/exponent) using 'E' character
* *f* - decimal floating point
* *o* - signed octal
* *u* - unsigned decimal integer
* *x* - unsigned hexadecimal integer
* *X* - unsigned hexadecimal integer (capital letters)
[flags]
* + - Prepends the result with a plus or minus sign ('+' or '-'), including positive numbers. By default, only negative numbers are preceded with a '-' sign.
* *0* - Left-pads the number with zeros (0) instead of spaces, where padding is specified (see width sub-specifier).
[width]
supports only numbers (* is not supported)
[.precision]
supports only numbers (* is not supported)
Returns [Toybox::Lang::String] A formatted String

@since 1.0.0
]]> Convert a Long to a String.
Returns [Toybox::Lang::String] A String representation of the Long

@since 1.0.0
]]> Convert a Long to a Number.
Returns [Toybox::Lang::Number] A Number representation of the Long

@since 1.0.0
]]> StorageFullException constructor.
msg [Toybox::Lang::String] The exception message

@since 2.4.0
]]> Retrieve a callback to a Method.

This is typically used when supplying a callback function to another method.
methodName [Toybox::Lang::Symbol] The Symbol of the specified Method

Returns [Toybox::Lang::Method] A Method object for the specified Symbol

@see Toybox::Lang::Method
@since 1.0.0
]]> Get a hash code value for an Object.

This computes a 32-bit Number that is typically used as an index when
placing Objects into a Dictionary. Hash code values have the following
characteristics:
* The computed hash code is constant for the lifetime of an Object
* If two Objects are equal, their hash codes will be equal
Returns [Toybox::Lang::Number] A hash code for the Object

@see https://en.wikipedia.org/wiki/Hash_function Hash Function
@see https://en.wikipedia.org/wiki/Hash_table Hash Tables
@since 1.0.0
]]> Test if an Object instance is equal to another instance of an Object.
other [Toybox::Lang::Object] The Object to test against

Returns [Toybox::Lang::Boolean] +true+ if Objects are equal, otherwise

+false+
@example
var a = 1;
var b = 1;
var c = 1.0;
a.equals(b); // returns true
a.equals(c); // returns false
@since 1.0.0
]]> Convert an Object to a String.
Returns [Toybox::Lang::String] A String representation of the Object

@example
var myNumber = 3219;
var myString = myNumber.toString();
@since 1.0.0
]]> Get a WeakReference to an Object.

A weak reference is an object that keeps a reference to an object but
does not increment the reference count. This means the object reference
can be destroyed, so is a case that should be handled.
@note Immutable types (Number, Float, Long, Double, Boolean, String)
will return their values. Other Object types will return a WeakReference
object.
Returns [Toybox::Lang::WeakReference] A WeakReference to the Object

@see Toybox::Lang::WeakReference
@since 1.2.0
]]> UnexpectedTypeException constructor.
msg [Toybox::Lang::String] The exception message

unused1 [Toybox::Lang::Object] Unused. Preserves argument count for compatibility

unused2 [Toybox::Lang::Object] Unused. Preserves argument count for compatibility

@since 1.2.0
]]> Get the next item in the list
@since 2.2.0
Returns [Toybox::Lang::Object] The next item, or +null+ if end of list

]]> Get a readable name for the content
Returns [Toybox::Lang::String] The readable name

@since 2.2.0
]]> Get a system intent for the content
Returns [Toybox::System::Intent] The System.Intent for the content

@since 2.2.0
]]> Get a unique serializable id
Returns [Toybox::Lang::Number] The unique serializable id

@since 2.2.0
]]> Remove a waypoint
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the given content is not owned
by the calling application.
@since 3.0.0
]]> Get a readable name for the content
Returns [Toybox::Lang::String] The readable name

@since 2.2.0
]]> Get a system intent for the content
Returns [Toybox::System::Intent] The System.Intent for the content

@since 2.2.0
]]> Get a unique serializable id
Returns [Toybox::Lang::Number] The unique serializable id

@since 2.2.0
]]> Remove a course
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the given content is not owned
by the calling application.
@since 3.0.0
]]> Get a readable name for the content
Returns [Toybox::Lang::String] The readable name

@since 2.2.0
]]> Get a system intent for the content
Returns [Toybox::System::Intent] The System.Intent for the content

@since 2.2.0
]]> Get a unique serializable id
Returns [Toybox::Lang::Number] The unique serializable id

@since 2.2.0
]]> Remove a workout
@throws [Toybox::Lang::InvalidOptionsException] Thrown if the given content is not owned
by the calling application.
@since 3.0.0
]]> Fill an ellipse with the foreground color.
x [Toybox::Lang::Numeric] The x location of the ellipse center

y [Toybox::Lang::Numeric] The y location of the ellipse center

a [Toybox::Lang::Numeric] The radius of the ellipse along the

x axis
b [Toybox::Lang::Numeric] The radius of the ellipse along the

y axis
@since 1.0.0
]]> Draw a point on the screen.
x [Toybox::Lang::Numeric] The x location of the point

y [Toybox::Lang::Numeric] The y location of the point

@since 1.0.0
]]> Fill a rounded rectangle with the foreground color.
x [Toybox::Lang::Numeric] The x location of the upper corner

y [Toybox::Lang::Numeric] The y location of the upper corner

width [Toybox::Lang::Numeric] The width value of the rectangle

height [Toybox::Lang::Numeric] The height value of the

rectangle
radius [Toybox::Lang::Numeric] The radius of the rounding

@since 1.0.0
]]> Reset the drawable area.
@since 2.3.0
]]> Get the width of the display region that is available to the app.
Returns [Toybox::Lang::Number] The width of display in pixels

@since 1.0.0
]]> Draw a bitmap to the screen.
x [Toybox::Lang::Numeric] The top left x coordinate to begin

the draw
y [Toybox::Lang::Numeric] The top left y coordinate to begin

the draw
bitmap [Toybox::WatchUi::BitmapResource, Toybox::Graphics::BufferedBitmap, Toybox::Graphics::BitmapReference] The object to draw.

The source color palette must be a subset of the destination color
palette.
@throws [Toybox::Graphics::InvalidPaletteException] Thrown if the
source color palette is not a subset of the destination palette
@note {Toybox::Graphics::BitmapReference BitmapReference} is only supported in CIQ 4.0.0 and later
@since 1.0.0
]]> Get the height of the display region that is available to the app.
Returns [Toybox::Lang::Number] The height of display in pixels

@since 1.0.0
]]> Fill a polygon with the foreground color.
pts [Toybox::Lang::Array] Array of coordinates with a 64

point limit
@since 1.0.0
]]> Draw a rectangle.
x [Toybox::Lang::Numeric] The x location of the upper corner

y [Toybox::Lang::Numeric] The y location of the upper corner

width [Toybox::Lang::Numeric] The width value of the rectangle

height [Toybox::Lang::Numeric] The height value of the

rectangle
@since 1.0.0
]]> Draw a rounded rectangle.
x [Toybox::Lang::Numeric] The x location of the upper corner

y [Toybox::Lang::Numeric] The y location of the upper corner

width [Toybox::Lang::Numeric] The width value of the rectangle

height [Toybox::Lang::Numeric] The height value of the

rectangle
radius [Toybox::Lang::Numeric] The radius of the rounding.

@since 1.0.0
]]> Draw an ellipse around a point.
x [Toybox::Lang::Numeric] The x location of the ellipse center

y [Toybox::Lang::Numeric] The y location of the ellipse center

a [Toybox::Lang::Number] The radius of the ellipse along the

x axis
b [Toybox::Lang::Number] The radius of the ellipse along the

y axis
@since 1.0.0
]]> Apply a clipping region to the Dc.

Pixels outside of the region will not be affected by any operations.
x [Toybox::Lang::Numeric] The x coordinate of the top left

corner of the clipping region
y [Toybox::Lang::Numeric] The y coordinate of the top left

corner of the clipping region
width [Toybox::Lang::Numeric] The width of the clipping region

in pixels.
height [Toybox::Lang::Numeric] The height of the clipping

region in pixels.
@since 2.3.0
]]> Get the width and height of a String.

This takes new lines into account when determining the height.
The width is the maximum width for a given line of the String. If a
String has two newline characters (\\n) in it, the height would be
for three lines and the width would be the width of the longest
String.
text [Toybox::Lang::String] The text to get the width for

font [Toybox::Graphics::FontType] The font of the text to measure.

Returns [Toybox::Lang::Array] The [width, height] of the String in pixels

@since 1.0.0
]]> Draw a circle around a point.
x [Toybox::Lang::Numeric] The x location of the circle center

y [Toybox::Lang::Numeric] The y location of the circle center

radius [Toybox::Lang::Number] The radius of the circle

@since 1.0.0
]]> Draw text at the given location.

This method is not supported for anti-aliased fonts
(including most built in fonts) for a
{Toybox::Graphics::BufferedBitmap BufferedBitmap} that has a
palette.
x [Toybox::Lang::Numeric] The x location of the text

y [Toybox::Lang::Numeric] The y location of the text

font [Toybox::Graphics::FontType] The font to use.

This can be a custom font loaded from resources or a Graphics.FONT_* value.
text [Toybox::Lang::Object] The Object to render.

justification Mask of Graphics.TEXT_JUSTIFY_* constants. This

may either be a single Graphics.TEXT_JUSTIFY_* constant, or a combination
of one vertical and one horizontal justification value as a bit mask
(e.g., Graphics.TEXT_JUSTIFY_CENTER | Graphics.TEXT_JUSTIFY_VCENTER).
@throws [Toybox::Graphics::InvalidPaletteException] Thrown if an
anti-aliased font is used on a paletted bitmap
@note {Toybox::Graphics::FontReference FontReference} is only supported in CIQ 4.0.0 and later
@since 1.0.0
]]> Erase the screen using the background color.

@note Starting form version 3.1.0, COLOR_TRANSPARENT will also be
honored as background color, which will cause the value of pixels
in the clip region to be replaced by COLOR_TRANSPARENT. For
example, this can be used to clear the transparent overlay layer
so animation background is visible.
@since 1.0.0
]]> Draw a line between two points.
x1 [Toybox::Lang::Numeric] The first x coordinate

y1 [Toybox::Lang::Numeric] The first y coordinate

x2 [Toybox::Lang::Numeric] The second x coordinate

y2 [Toybox::Lang::Numeric] The second y coordinate

@since 1.0.0
]]> Draw an arc.
* 0 degrees: 3 o'clock position.
* 90 degrees: 12 o'clock position.
* 180 degrees: 9 o'clock position.
* 270 degrees: 6 o'clock position.
@note All parameters are truncated towards zero. A complete circle will be drawn if degreeStart and degreeEnd are equal.
x [Toybox::Lang::Numeric] The x location of the arc center

y [Toybox::Lang::Numeric] The y location of the arc center

r [Toybox::Lang::Numeric] The radius of the arc

attr [Toybox::Graphics::ArcDirection] Arc drawing attributes.

(ARC_COUNTER_CLOCKWISE or ARC_CLOCKWISE)
degreeStart [Toybox::Lang::Numeric] The start angle of the arc

by degrees.
degreeEnd [Toybox::Lang::Numeric] The end angle of the arc by

degrees.
@since 1.2.0
]]> Get the height of a font.
font [Toybox::Graphics::FontType] The font to measure

Returns [Toybox::Lang::Number] The height of the font in pixels

@since 1.0.0
]]> Get the width of a String.
text [Toybox::Lang::String] The text to get width for

font [Toybox::Graphics::FontType] The font of the text to measure.

Returns [Toybox::Lang::Number] The width of String in pixels

@since 1.0.0
]]> Set the current foreground and background colors.
foreground [Toybox::Graphics::ColorType] Graphics.COLOR_* constant

or 24-bit integer of the form 0xRRGGBB.
background [Toybox::Graphics::ColorType] Graphics.COLOR_* constant

or 24-bit integer of the form 0xRRGGBB.
@since 1.0.0
]]> Set the width of a line.
width [Toybox::Lang::Numeric] The pen width in pixels

@since 1.0.0
]]> Fill a circle with the foreground color.
x [Toybox::Lang::Numeric] The x location of the circle center

y [Toybox::Lang::Numeric] The y location of the circle center

radius [Toybox::Lang::Numeric] The radius of the circle

@since 1.0.0
]]> Enable anti-aliased drawing for primitives
This method is not supported for a
{Toybox::Graphics::BufferedBitmap BufferedBitmap} that has a palette.
enabled [Toybox::Lang::Boolean] +true+ if AA is to be enabled, +false+ otherwise.

@throws [Toybox::Graphics::InvalidPaletteException] Thrown if antialiasing is enabled
for a paletted bitmap.
@since 3.2.0
]]> Fill a rectangle with the foreground color.
x [Toybox::Lang::Numeric] The x location of the upper corner

y [Toybox::Lang::Numeric] The y location of the upper corner

width [Toybox::Lang::Numeric] The width value of the rectangle

height [Toybox::Lang::Numeric] The height value of the

rectangle
@since 1.0.0
]]>
palette [Toybox::Lang::Array] A palette for this bitmap. The

number of colors must match the current palette. Each color in the
image will be replaced with the colors specified in the new
palette.
@throws [Toybox::Graphics::InvalidPaletteException] Thrown if the
palette size does not match the current palette.
@since 2.3.0
]]> Constructor
options [Toybox::Lang::Dictionary] Dictionary of options.

Must contain width and height, with optional palette, or a
{Toybox::WatchUi::BitmapResource BitmapResource}. This resource is
not allowed to have an alpha channel.
@option options [Toybox::Lang::Number] :width The width of the
surface in pixels
@option options [Toybox::Lang::Number] :height The height of the
surface in pixels
@option options [Toybox::Lang::Array] :palette The colors used in
this surface. Using less will reduce the bitmap size. The bitmap
will use the system default if not provided. The maximum palette
size allowed is 256 colors. If a palette is provided, the number of
colors must also be <= to the number of system colors.
@option options [Toybox::Lang::Number] :colorDepth Color depth in
terms of bits/pixel, when missing, default to system value.
@option options [Toybox::WatchUi::BitmapResource] :bitmapResource A
{Toybox::WatchUi::BitmapResource BitmapResource} to initialize
@option options [Toybox::Graphics::AlphaBlending] :alphaBlending A
{Toybox::Graphics::AlphaBlending AlphaBlending} enum to specify the
level of alpha blending support for this buffered bitmap object
@throws [Toybox::Graphics::InvalidPaletteException] Thrown if the
palette size exceeds the number of system colors.
@throws [Toybox::Graphics::InvalidPaletteException] Thrown if the
palette size exceeds 256 colors.
@throws [Toybox::Graphics::InvalidBitmapResourceException] Thrown if
the {Toybox::WatchUi::BitmapResource BitmapResource} provided has
an alpha channel.
@throws [Toybox::Graphics::OutOfGraphicsMemoryException] Thrown if there isn't
enough free memory available to load the resource.
@deprecated Use {Toybox::Graphics#createBufferedBitmap Graphics.createBufferedBitmap()} after
ConnectIQ version 4.0.0.
@since 2.3.0
]]>
Returns [Toybox::Lang::Array] The current palette for this bitmap.

+null+ if this surface uses the system palette
@since 2.3.0
]]> Get the Dc to draw on the buffered bitmap.
Returns [Toybox::Graphics::Dc] The draw context

@since 2.3.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.3.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.3.0
]]> Get the next entry in the iterator.

This must be called to get the initial data from the iterator.
@since 1.2.2
Returns [Toybox::ActivityMonitor::HeartRateSample] The next

{Toybox::ActivityMonitor::HeartRateSample HeartRateSample},
or +null+ if there are no more samples
]]> Get the minimum heart rate contained in this iterator.
@since 1.2.2
Returns [Toybox::Lang::Number] The minimum heart rate (bpm)

]]> Get the maximum heart rate contained in this iterator.
@since 1.2.2
Returns [Toybox::Lang::Number] The maximum heart rate in beats per

minute (bpm)
]]> Constructor
@since 3.1.0
]]> Callback when shifting system status is changed
data [Toybox::AntPlus::ShiftingStatus]

@since 3.1.0
]]> Constructor
@since 2.2.0
]]> Constructor
@since 3.1.0
]]> Bring all taillights under the control of whichever
light network mode has been chosen by the user.
@since 2.2.0
]]> Tell all taillights to enter the same mode.

You should check the capable modes of each taillight in the
network before sending light modes, as lights will ignore
commands to go into modes that they do not support.
Lights whose modes are set here will not be controlled by
the Light Network Mode until they are restored OR until the
user changes the Light Network Mode outside of ConnectIQ.
mode [Toybox::AntPlus::LightMode] The

{Toybox::AntPlus::LIGHT_MODE_AUTO LIGHT_MODE*} enum value
@since 2.2.0
]]> Bring all headlights under the control of whichever
light network mode has been chosen by the user.
@since 2.2.0
]]> Get the light network state.
Returns [Toybox::AntPlus::LightNetworkState] The

{Toybox::AntPlus::LIGHT_NETWORK_STATE_FORMED LIGHT_NETWORK_STATE_*} enum value
@since 2.2.0
]]> Tell all headlights to enter the same mode.

You should check the capable modes of each headlight in the
network before sending light modes, as lights will ignore
commands to go into modes that they do not support.
Lights whose modes are set here will not be controlled by
the Light Network Mode until they are restored OR until the
user changes the Light Network Mode outside of ConnectIQ.
mode [Toybox::AntPlus::LightMode] The

{Toybox::AntPlus::LIGHT_MODE_AUTO LIGHT_MODE_*} enum value
@since 2.2.0
]]> A signal switch for right and left signals.

* If signal light is engaged, disengage it.
* If signal light is disengaged, engage it.
*This will automatically disengage the opposite signal if it is currently engaged.
left [Toybox::Lang::Boolean]

* +true+ to control left signal
* +false+ to control right signal
@since 2.2.0
]]> Constructor
listener [Toybox::AntPlus::LightNetworkListener] The light network instance optionally

takes an extension of the {Toybox::AntPlus::LightNetworkListener LightNetworkListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data using
the get* methods.
@since 2.2.0
]]> Get the light network mode.
Returns [Toybox::AntPlus::LightNetworkMode] The

{Toybox::AntPlus::LIGHT_NETWORK_MODE_AUTO LIGHT_NETWORK_MODE_*} enum value
@since 2.2.0
]]> Get a list of lights in the network.
Returns [Toybox::Lang::Array] List of lights that are part of the

network, +null+ if light network state is not
{Toybox::AntPlus::LIGHT_NETWORK_STATE_FORMED LIGHT_NETWORK_STATE_FORMED}
@since 2.2.0
]]> Constructor
@since 2.2.0
]]> Get a list of the standard and custom light modes that a bike light supports.
Returns [Toybox::Lang::Array] list of supported

{Toybox::AntPlus::LIGHT_MODE_AUTO LIGHT_MODE_*} values, +null+ if unknown
@since 2.2.0
]]> Tell this light to enter a new mode.

You should check the capable modes before sending light modes as lights
will ignore commands to go into modes that they do not support. Lights
whose modes are set here will not be controlled by the Light Network Mode
until they are restored OR until the user changes the Light Network Mode
outside of ConnectIQ.
mode [Toybox::AntPlus::LightMode] The

{Toybox::AntPlus::LIGHT_MODE_AUTO LIGHT_MODE_*} enum number value
@since 2.2.0
]]> Constructor
@since 2.2.0
]]> Constructor
@since 2.2.0
]]> Callback when device state is updated.
data [Toybox::AntPlus::DeviceState] The data with updated device

state information.
@since 2.2.0
]]> Callback when manufacturer's information is received.
data [Toybox::AntPlus::ManufacturerInfo] The data with

manufacturer's information
@since 2.2.0
]]> Callback when battery status is received.
data [Toybox::AntPlus::BatteryStatus] The data with battery

status information
@since 2.2.0
]]> Callback when product information is received.
data [Toybox::AntPlus::ProductInfo] The data with product information

@since 2.2.0
]]> After sending a manufacturer message or page request this will be called to
indicate message sent status.
status [Toybox::AntPlus::MessageSendStatus]

The status of the sent message as a {AntPlus::MESSAGE_SENT_SUCCESS SENT_MESSAGE_*}
enum value
sentMesgData [Toybox::Lang::Dictionary]

The dictionary will have keys for message type and page number.
The message type is a {AntPlus::MESSAGE_TYPE_MANUFACTURER AntPlus.MESSAGE_TYPE_*}.
The page number is byte 0 of the manufacturer specific message or the requested
page number.
@since 3.1.0
]]> Callback when ANT message is received.
msg [Toybox::Ant::Message] The ANT message

@since 3.1.0
]]> Callback when radar data is updated
data [Toybox::Lang::Array] List of information for tracked targets (maximum of 8).

@since 3.0.0
]]> Constructor
@since 3.0.0
]]> Callback when speed data is updated
data [Toybox::AntPlus::BikeSpeedInfo] data Data with updated speed and distance information.

@since 3.0.0
]]> Constructor
@since 3.0.0
]]> Constructor
listener [Toybox::AntPlus::BikeSpeedListener] The bike speed instance optionally

takes an extension of the {Toybox::AntPlus::BikeSpeedListener BikeSpeedListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data
using the {Toybox::AntPlus::BikeSpeed getSpeedInfo} method.
@since 3.0.0
]]> getSpeedInfo - Returns the most recent BikeSpeedInfo
Returns [Toybox::AntPlus::BikeSpeedInfo] with current information.

@since 3.0.0
]]> Retrieve battery status for provided component identifier.
identifier [Toybox::Lang::Number] The component identifier

to retrieve battery status for
* +null+ if single-component
* Light index for bike lights.
Returns [Toybox::AntPlus::BatteryStatus] The current battery status

for this identifier, or +null+ if unknown identifier
@example
using Toybox.AntPlus;

// Assumes valid component identifier enum value (for bike lights)
// or null for a single component device

var batteryStatus = AntPlus.getBatteryStatus(null); // Get the batteryStatus Enum value
// for a single component system.
if (batteryStatus == AntPlus.BATT_STATUS_OK) {
System.println("Battery Status: Okay!");
} else {
// display another battery status message
}
@since 2.2.0
]]> Retrieve the state of the device.
Returns [Toybox::AntPlus::DeviceState] The current device state

@example
using Toybox.AntPlus;

// Get the DEVICE_STATE_* enum value
var deviceState = AntPlus.getDeviceState(null);
@since 2.2.0
]]> Send Manufacturer Message
message [Toybox::Ant::Message]

The Ant message to send.
Only exploration (0xE0-0xEF) and manufacturer specific (0xF0-0xFF)
pages are allowed. It is recommended to contact the ANT+ group when
exploration pages are used at thisisant.com.
The {Toybox::AntPlus::DeviceListener#onSentMessage onSentMessage()} will be called
to indicate sent manufacturer message status.
@see Toybox::Ant::Message
@throws [Toybox::AntPlus::AntPlusNotAllowedException]
Thrown if the page number (byte 0) is outside the exploration
and manufacturer page range.
@since 3.1.0
]]> Retrieve manufacturer information for provided component identifier.
identifier [Toybox::Lang::Number] The component identifier

to retrieve manufacturer information for
* +null+ if single-component
* Light index for bike lights
Returns [Toybox::AntPlus::ManufacturerInfo] The current manufacturer

information for this identifier
* +null+ if unknown identifier
@example
using Toybox.AntPlus;

// Get the ManufacturerInfo object
var manufacturerInfo = AntPlus.getManufacturerInfo(null);
@since 2.2.0
]]> Retrieve a list of known component identifiers for this Device.

This list may update over time as ANT+ devices with >1 component
periodically send information about each of their components. The
device reports its total number of components in
{Toybox::AntPlus::CommonData#numComponents CommonData.numComponents}.
The returned Array will only contain entries for components that the
ANT+ device has provided a component identifier for.
Returns [Toybox::Lang::Array] A list of known component identifiers

* +null+ if there are no known component identifiers
@example
using Toybox.AntPlus;

// Get the list of known components as an Array
var componentList = AntPlus.getComponentIdentifiers();
@since 2.2.0
]]> To set the listener for the device, use setListener().
listener [Toybox::AntPlus::DeviceListener] A Class object to call with

device info updates
* Must be an extension of DeviceListener
@since 2.2.0
]]> Constructor
deviceType [Toybox::Lang::Number] The ANT+ device type of the

device
listener [Toybox::AntPlus::DeviceListener] An extension of one of the

device-specific listener classes
@since 2.2.0
]]> Send Page request
Request 2 broadcast pages from connected sensor.
Use {Toybox::AntPlus::DeviceListener#onMessage onMessage()} to process requested page
broadcasts from the sensor.
pageNumber [Toybox::Lang::Number]

The requested page number. Requesting the ANTFS page (0x43) isn't allowed.
Page request can change the page rotation of the sensor so they will not be
allowed to be sent too frequently. Sending page requests is limited to once
every 2 seconds.
@throws [Toybox::AntPlus::AntPlusNotAllowedException] Thrown if the ANTFS page
is requested, if pageNumber is outside the range 0-255, or if page requests
are sent to frequently.
@since 3.1.0
]]> Retrieve product information for provided component identifier.
identifier [Toybox::Lang::Number] The component identifier to

retrieve product information for
* +null+ if single-component
* Light index for bike lights
Returns [Toybox::AntPlus::ProductInfo] The current product

information for this identifier
* +null+ if unknown identifier
@example
using Toybox.AntPlus;

// Get the ProductInfo object
var productInfo = AntPlus.getProductInfo(null);
@since 2.2.0
]]> Returns the most recent BikeCadenceInfo
Returns [Toybox::AntPlus::BikeCadenceInfo] with current information.

@since 3.0.0
]]> Constructor
listener [Toybox::AntPlus::BikeCadenceListener] The bike cadence instance optionally

takes an extension of the {Toybox::AntPlus::BikeCadenceListener BikeCadenceListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data
using the {Toybox::AntPlus::BikeCadence getCadenceInfo} method.
@since 3.0.0
]]> Constructor
@since 3.0.0
]]> Callback when speed / cadence data is updated
data [Toybox::AntPlus::BikeSpeedCadenceInfo] data Data with updated speed / cadence information.

@since 3.0.0
]]> Callback when a bike light's data is updated (max freq. 1Hz)
data [Toybox::AntPlus::BikeLight] The updated light information

@since 2.2.0
]]> Constructor
@since 2.2.0
]]> Callback when the light network state changes
data [Toybox::Lang::Number] {Toybox::AntPlus::LIGHT_NETWORK_STATE_FORMED LIGHT_NETWORK_STATE_*} enum value

@since 2.2.0
]]> Retrieves information on the current list of tracked targets.
Returns [Toybox::Lang::Array] An Array of {Toybox::AntPlus::RadarTarget RadarTarget} objects

@since 3.0.0
]]>
listener [Toybox::AntPlus::BikeRadarListener] The bike radar instance optionally

takes an extension of the {Toybox::AntPlus::BikeRadarListener BikeRadarListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data
using the {Toybox::AntPlus::BikeRadar getRadarInfo} method.
@since 3.0.0
]]> Get current shifting system status
Will not provide status for Shimano shifting systems.
Returns [Toybox::AntPlus::ShiftingStatus] Current shifting system status

@since 3.1.0
]]> Constructor
listener [Toybox::AntPlus::ShiftingListener] An extension of the ShiftingListener class.

@since 3.1.0
]]> Use getSensorPosition() to retrieve the position of the sensor on the body
@since 2.4.0
Returns [Toybox::AntPlus::SensorPosition] Current sensor position

]]> Use getRunningDynamics() to get the most current running dynamics.
@since 2.4.0
Returns [Toybox::AntPlus::RunningDynamicsData] Current running dynamics data

]]> Constructor
@since 2.4.0
listener [Toybox::AntPlus::RunningDynamicsListener] The running dynamics instance optionally

takes an extension of the {Toybox::AntPlus::RunningDynamicsListener RunningDynamicsListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data using the
get* methods.
]]> Callback when running dynamics are updated (max freq 1Hz)
@since 2.4.0
data [Toybox::AntPlus::RunningDynamicsData] Data with updated running dynamics information.

]]> Constructor
@since 2.4.0
]]> Callback when sensor position is updated (max freq 1Hz)
@since 2.4.0
data [Toybox::AntPlus::SensorPosition] Data with updated sensor position information.

]]> getSpeedCadenceInfo - Returns the most recent BikeSpeedCadenceInfo
Returns [Toybox::AntPlus::BikeSpeedCadenceInfo] with current information.

@since 3.0.0
]]> Constructor
listener [Toybox::AntPlus::BikeSpeedCadenceListener] The bike speed cadence instance optionally

takes an extension of the {Toybox::AntPlus::BikeSpeedCadenceListener BikeSpeedCadenceListener} class
as a parameter. +null+ can be passed in instead if the user plans to only poll for data using the
{Toybox::AntPlus::BikeSpeedCadence getSpeedCadenceInfo} method.
@since 3.0.0
]]> Constructor
@since 3.0.0
]]> Callback when cadence data is updated
data [Toybox::AntPlus::BikeCadenceInfo] data Data with updated cadence information.

@since 3.0.0
]]> Complete the Session by discarding the recorded data.
Returns [Toybox::Lang::Boolean] +true+ if the Session was

successfully discarded, otherwise +false+
@since 1.0.0
]]> Create a new {Toybox::FitContributor::Field Field}.

Field objects allow developers to store information in FIT developer
fields. This information can be displayed in Garmin Connect as a
per-second graph, as lap information, or as workout summary
information.
name [Toybox::Lang::String] The name of the Field as a String

* The maximum length may vary between products
* At least 64 bytes are available
fieldId [Toybox::Lang::Number] The unique Field Identifier

for the Field
type [Toybox::FitContributor::DataType] The type definition for the Field

from the DATA_TYPE_* enumerator in the
{Toybox::FitContributor FitContributor} module
options [Toybox::Lang::Dictionary] Optional parameters that

can be specified for Field creation
@option options [Toybox::Lang::Number] :count The number
of elements to add to the Field if it is an Array
* This is also the maximum combined size of strings plus +null+ terminators if the type is DATA_TYPE_STRING (Default 1)
* Apps are limited to 256 total bytes per message
* Data fields are limited to 32 bytes per message
* Messages larger than the limit will result in a "New Field out of memory for FIT data" error.
@option options [Toybox::Lang::Number] :mesgType The
message type that this Field should be added to
* Defaults to {Toybox::FitContributor::MESG_TYPE_RECORD MESG_TYPE_RECORD} if not provided
* If mesgType == {Toybox::FitContributor::MESG_TYPE_RECORD MESG_TYPE_RECORD}, {Toybox::FitContributor::DATA_TYPE_STRING DATA_TYPE_STRING} cannot be used as the Field type.
@option options [Toybox::Lang::String] :units The display
units as a String
* This should use the current device language
* The maximum length may vary between products
* At least 16 bytes are available
@option options [Toybox::Lang::Number] :nativeNum If this
Field can be treated equivalently to a Field that is included in
the FIT SDK use this to indicate the Field Number that is specified
by the FIT Profile.
Returns [Toybox::FitContributor::Field] The resulting Field object

@see https://www.thisisant.com/resources/fit The Message type
descriptions can be found in Profile.xlsx included in the FIT SDK
@see Toybox::FitContributor::Field FitContributor.Field
@see https://developer.garmin.com/connect-iq/core-topics/activity-recording/ Core Topics - Activity Recording
@since 1.3.0
]]> Check if recording is active for this Session.
Returns [Toybox::Lang::Boolean] +true+ if recording is active,

otherwise +false+
@since 1.0.0
]]> Stop recording a FIT file on the system.
Returns [Toybox::Lang::Boolean] +true+ if recording was successfully

stopped, otherwise +false+
@since 1.0.0
]]> Begin recording a FIT file on the system.
Returns [Toybox::Lang::Boolean] +true+ if recording was successfully

started, otherwise +false+
@since 1.0.0
]]> Complete the session by storing the FIT file on the file system.
Returns [Toybox::Lang::Boolean] +true+ if the session was

successfully saved, otherwise +false+
@since 1.0.0
]]> There is no public constructor; Session objects must be created with
createSession().
]]> Add a lap to the current recording.
Returns [Toybox::Lang::Boolean] +true+ if a lap was successfully

created, otherwise +false+
@since 1.0.0
]]> Set the listener for Session timer events

The listener method is called whenever a new timer event
occurs.

The keys in the Dictionary passed to the listener callback depend
on the the value of the eventType parameter.

listener [Toybox::Lang::Method] A reference to a callback which

must accept two arguments.
* eventType: A TIMER_EVENT_* enum that describes the event that occurred.
* eventData: A {Toybox::Lang::Dictionary Dictionary} containing data relevant
to the timer event or +null+. If eventType is TIMER_EVENT_LAP, the following
are provided if available:
* +:elapsedDistance+ {Toybox::Lang::Float Float} (meters)
* +:averageSpeed+ {Toybox::Lang::Float Float} (meters/second)
* +:maxSpeed+ {Toybox::Lang::Float Float} (meters/second)
* +:startTime+ {Toybox::Time::Moment Moment} (Moment)
* +:elapsedTime+ {Toybox::Lang::Number Number} (milliseconds)
* +:timerTime+ {Toybox::Lang::Number Number} (milliseconds)
@since 3.0.10
]]> Stops the Timer from running.

This only needs to be called for repeating timers. A Timer can be
started again by calling start().
@since 1.0.0
]]> Start the Timer.
callback [Toybox::Lang::Method] A function to call after the

Timer completes
time [Toybox::Lang::Number] The number of milliseconds to

wait before invoking callback
repeat [Toybox::Lang::Boolean] Set to +true+ to have the Timer

repeat until stop() is called
@note Will cause an app crash if called from a watch face app while
in low power mode
@since 1.0.0
]]> Constructor
@since 3.3.0
]]> Get the type of click event.
Returns [Toybox::WatchUi::ClickType] A

{Toybox::WatchUi::CLICK_TYPE_TAP WatchUi.CLICK_TYPE_*} value
@since 1.0.0
]]> Constructor
x [Toybox::Lang::Number] The x-coordinate of the click event

y [Toybox::Lang::Number] The y-coordinate of the click event

type [Toybox::WatchUi::ClickType] The

{Toybox::WatchUi::CLICK_TYPE_TAP WatchUi.CLICK_TYPE_*} value for
this event
@since 1.0.0
]]> Get the coordinates of a click event.
Returns [Toybox::Lang::Array] An array containing the x and y

coordinates of the click event as {Toybox::Lang::Number Numbers}
@since 1.0.0
]]> Handle an Animation event.
event [Toybox::WatchUi::AnimationEvent] The animation event, a

{Toybox::WatchUi::ANIMATION_EVENT_COMPLETE WatchUi.ANIMATION_EVENT*} value
options [Toybox::Lang::Dictionary] A Dictionary of options

@since 3.1.0
]]> Constructor
Initializes a Button object's foreground, background, and behavior.
The Button must be registered during
{Toybox::WatchUi::View#setLayout setLayout()} in order to be usable.
options [Toybox::Lang::Dictionary] A Dictionary containing

options for the Button object
@option options [Toybox::Lang::Symbol] :behavior A Symbol object to
call when the Button is selected; set to +null+ to use a
{Toybox::WatchUi::SelectableEvent SelectableEvent} (optional)
@option options [Toybox::Lang::Object] :background A
{Toybox::WatchUi::Drawable Drawable},
{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} constant, or 24-bit
integer of the form 0xRRGGBB (optional)
@see Toybox::WatchUi::Selectable#initialize Selectable.initialize()
@since 2.1.0
]]> Draw the Button to the device context ({Toybox::Graphics::Dc Dc}).

This method assumes that the device context has already been
configured to the proper options.
dc [Toybox::Graphics::Dc] The device context

@since 2.1.0
]]> Set the focused item height.

itemHeight [Toybox::Lang::Number, null] The value to assign

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if focusItemHeight
is not a Number or null.
@since 3.0.0
]]> Set the title item height.

itemHeight [Toybox::Lang::Number, null] The value to assign

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if itemHeight
is not a Number or null.
@since 3.2.7
]]> Validate a drawable option is +null+ or a Drawable.
drawable [Toybox::WatchUi::Drawable, null] A Drawable to render on top of

the menu items or +null+.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if drawable
is not a {Toybox::WatchUi::Drawable Drawable} or +null+.
@since 3.0.0
]]> Add a CustomMenuItem to a CustomMenu.

item [Toybox::WatchUi::CustomMenuItem] The CustomMenuItem

to add to the CustomMenu. Other MenuItem variants cannot be added
to a Custom Menu.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if item
is not a {Toybox::WatchUi::MenuItem MenuItem}.
@throws [Toybox::WatchUi::InvalidMenuItemTypeException] Thrown if item
is not a {Toybox::WatchUi::CustomMenuItem CustomMenuItem}.
@since 3.0.0
]]> Draw the CustomMenu foreground.

This is called after a menu's items and title have been rendered.
It can be used to draw overlay content for the menu.
dc [Toybox::Graphics::Dc] The menu's drawing context

@since 3.0.0
]]> Set the item height for a custom menu.
itemHeight [Toybox::Lang::Number] The default height of

{Toybox::WatchUi::CustomMenuItem CustomMenuItems} in this menu
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if itemHeight
is not a Number.
@since 3.0.0
]]> Set the background color.
color [Toybox::Graphics::ColorType] The color to fill the background

of the menu with.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if color
is not a {Toybox::Lang::Number Number}.
@since 3.0.0
]]> Set the foreground drawable.

drawable [Toybox::WatchUi::Drawable, null] A Drawable to render on top of

the menu items or +null+.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if drawable
is not a {Toybox::WatchUi::Drawable Drawable} or +null+.
@since 3.0.0
]]> Set the title drawable.

drawable [Toybox::WatchUi::Drawable, null] A drawable that will render

the title area or +null+.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if drawable
is not a {Toybox::WatchUi::Drawable Drawable} or +null+.
@since 3.0.0
]]> Set the footer item height.

itemHeight [Toybox::Lang::Number, null] The value to assign

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if itemHeight
is not a Number or null.
@since 3.2.7
]]> Draw the CustomMenu title.

This is called to render the menu title region.
dc [Toybox::Graphics::Dc] The menu's drawing context

@since 3.0.0
]]> Get the screen height of the device

Returns [Toybox::Lang::Number] the screen height

@since 3.0.0
]]> Return if the footer is selected

Returns [Toybox::Lang::Boolean] if the footer is selected

@since 3.0.6
]]> Set the footer drawable.

drawable [Toybox::WatchUi::Drawable, null] A drawable that will render

the footer area or +null+.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if drawable
is not a {Toybox::WatchUi::Drawable Drawable} or +null+.
@since 3.0.0
]]> Constructor
itemHeight [Toybox::Lang::Number] The pixel height of menu items

rendered by this menu.
backgroundColor [Toybox::Graphics::ColorType] The color that will be used

to fill the background of the menu.
options [Toybox::Lang::Dictionary] A Dictionary of options. Can be +null+

@option options [Toybox::Lang::Number] :focus The index
of the {Toybox::WatchUi::CheckboxMenuItem CheckboxMenuItem} that
should have initial focus. (optional)
@option options [Toybox::Lang::Number] :focusItemHeight The
pixel height of the center menu item of this menu. This option is ignored
on products with touch screens. (optional)
@option options [Toybox::WatchUi::Drawable] :title A Drawable
that will render the title area. (optional)
@option options [Toybox::WatchUi::Drawable] :footer A Drawable
that will render the area after the final item in the menu.(optional)
@option options [Toybox::WatchUi::Drawable] :foreground A
Drawable to render on top of menu items. (optional)
@option options [Toybox::Lang::Number] :titleItemHeight The pixel height
of the header menu item of this menu (optional)
@option options [Toybox::Lang::Number] :footerItemHeight The pixel height
of the footer menu item of this menu. (optional)
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
the default icon for the menu incase menuitem do not have it populated
@option options [Toybox::WatchUi::MenuTheme] :theme The menu theme, or +null+ for no theme.
Defaults to MENU_THEME_DEFAULT.
@option options [Toybox::WatchUi::Menu2::DividerType] :dividerType The divider type, if +null+ is
passed as value, divider will be disabled (non-visible).
Defaults to DIVIDER_TYPE_DEFAULT.
@see Toybox::WatchUi::CustomMenu#setDividerType
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if either +itemHeight+ or
+backgroundColor+ are not of the expected type
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +:focusItemHeight+,
+:titleItemHeight+, +:footerItemHeight+, or +:focus+ options are provided and are
not Number objects
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +:title+, +:footer+,
or +:foreground+ options are provided and are not Drawable objects.
@note The options +:titleItemHeight+ and +:footerItemHeight+ are only
supported with ConnectIQ 4.0.0 and later.
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@note The +:theme+ option is only used on ConnectIQ 4.1.8 devices with menu theme support. The
background color will not be used if themes are supported and the theme is non-null.
@note The +:dividerType+ option is only used on ConnectIQ 5.0.1 devices with divider support.
@since 3.0.0
]]> Draw the CustomMenu footer.

This is called to render the menu footer region.
dc [Toybox::Graphics::Dc] The menu's drawing context

@since 3.0.0
]]> Return if the title is selected

Returns [Toybox::Lang::Boolean] if the title is selected

@since 3.0.6
]]> Set a CheckboxMenuItem state.
checked [Toybox::Lang::Boolean] The intended state of the

CheckboxMenuItem; checked if +true+, unchecked if +false+
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
checked is not a valid type
@since 3.0.0
]]> Constructor
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The string label for the CheckboxMenuItem

subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] The substring label for the

CheckboxMenuItem, which can be +null+
identifier [Toybox::Lang::Object] The identifier for this

CheckboxMenuItem, which is typically a {Toybox::Lang::String String}
checked [Toybox::Lang::Boolean] The initial state of the

CheckboxMenuItem; checked if +true+, unchecked if +false+
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::WatchUi::MenuItem::Alignment] :alignment A
{Toybox::WatchUi::MenuItem::MENU_ITEM_LABEL_ALIGN_RIGHT WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN_*} constant representing the label
alignment, which defaults to the system default for check box menu items if not specified.
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
for the subscreen area when the menu item is in focus
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@since 3.0.0
]]> Get a CheckboxMenuItem state.
Returns [Toybox::Lang::Boolean] The current state of the CheckboxMenuItem

@since 3.0.0
]]> The device is exiting low power mode.

Timers and animations may be started here in preparation for once-per-second
updates.
@see Toybox::WatchUi::WatchFace
@since 1.0.0
]]> Update a portion of the screen.

Partial updates can be used to update a small part of the screen to
allow for Always On Watch Faces.

This method is called each second as long as the device power budget
is not exceeded. It is important to update as small of a portion of
the display as possible in this method to avoid exceeding the allowed
power budget. To do this, the application must set the clipping region
for the {Toybox::Graphics::Dc Graphics.Dc} object using the
{Toybox::Graphics::Dc#setClip setClip()} method. Calls to
{Toybox::System#println System.println()} and
{Toybox::System#print System.print()} will not execute on devices when
this function is being invoked, but can be used in the device simulator.

If the call to this method exceeds the power budget of the device, the
partial update will not draw and a call to
{Toybox::WatchUi::WatchFaceDelegate#onPowerBudgetExceeded onPowerBudgetExceeded()}
is made to report the limits that were exceeded.
@note See the Analog sample distributed with the SDK for an example
of onPartialUpdate() using clipping regions
dc [Toybox::Graphics::Dc] The device context

@see Toybox::WatchUi::WatchFaceDelegate
@see Toybox::WatchUi::WatchFaceDelegate#onPowerBudgetExceeded WatchFaceDelegate.onPowerBudgetExceeded()
@see Toybox::WatchUi::View#onUpdate View.onUpdate()
@since 2.3.0
]]> The device is entering low power mode.

Terminate any active timers and prepare for once-per-minute updates.
@see Toybox::WatchUi::WatchFace
@since 1.0.0
]]> Constructor
@since 1.0.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Return value for an item.
item [Toybox::Lang::Number] The item index

Returns [Toybox::Lang::Object] The item's value

@since 1.2.0
]]> Generate a Drawable instance for an item.
item [Toybox::Lang::Number] The item index

isSelected [Toybox::Lang::Boolean] +true+ if the current item

is the selected item, otherwise +false+
Returns [Toybox::WatchUi::Drawable] The Drawable object to render

@since 1.2.0
]]> Get the number of items in the PickerFactory.
Returns [Toybox::Lang::Number]

@since 1.2.0
]]> Set the visibility of a Drawable object.
visible [Toybox::Lang::Boolean] The visibility of the Drawable object

@since 3.3.0
]]> Set the size of a Drawable object.
w [Toybox::Lang::Number] The width of the Drawable object

h [Toybox::Lang::Number] The height of the Drawable object

@since 1.0.0
]]> Set the on-screen location for a Drawable object.
x [Toybox::Lang::Number] The horizontal position on the screen

y [Toybox::Lang::Number] The vertical position on the screen

@since 1.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

options for the Drawable object
@option options [Toybox::Lang::Object] :identifier The identifier
for the Drawable object
@option options [Toybox::Lang::Number] :locX The absolute, on-screen
x-coordinate for the Drawable object
@option options [Toybox::Lang::Number] :locY The absolute, on-screen
y-coordinate for the Drawable object
@option options [Toybox::Lang::Number] :width The clip width of the
Drawable object
@option options [Toybox::Lang::Number] :height The clip height of
the Drawable object
@option options [Toybox::Lang::Boolean] :visible The visibility of
the Drawable object
@note The option +:visible+ is only supported with ConnectIQ 3.3.0
and later.
@since 1.0.0
]]> Draw an object to the device context ({Toybox::Graphics::Dc Dc}).

This method assumes that the device context has already been
configured to the proper options.

Derived classes should check the isVisible property, if it exists,
before trying to draw.

dc [Toybox::Graphics::Dc] The device context

@since 1.0.0
]]> Invoked when certain glance event occurs, none for now
@since 3.1.0
]]> Constructor
@since 3.1.0
]]> Handle a cancel event from a Picker
@since 1.2.0
]]> Handle a confirm event from a Picker
values [Toybox::Lang::Array] The values chosen in the Picker.

@note A +null+ value will be returned for any
{Toybox::WatchUi::Drawable Drawable} entries
@since 1.2.0
]]> A lap event has occurred.

This method is called when a lap is added to the current activity.
A notification is triggered after the lap record has been written to
the FIT file.
@since 1.3.0
]]> The current workout step is complete.

This method is called when the a workout step has been completed.
@since 3.0.0
]]> Get the current Data Field background color.

Some devices provide a global Data Field background color setting.
This method will return the current value of that setting as a value
of either {Toybox::Graphics::COLOR_WHITE Graphics.COLOR_WHITE}
or {Toybox::Graphics::COLOR_BLACK Graphics.COLOR_BLACK}.
Returns [Toybox::Graphics::ColorType] A

{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value
@see Toybox::Graphics
@since 1.2.0
]]> The activity timer has started.

This method is called when the activity timer goes from a stopped
state to a started state. If the activity timer is running when the
app is loaded, this event will run immediately after startup.
@since 1.3.0
]]> Get the screen regions that are obscured.

Non-rectangular screens have certain portions of the screen obscured.
For example, a round screen effectively cuts off the corners of a
square screen. This method returns a sum of the enumerated values
defined by the WatchUi.DataField.OBSCURE_* constants that match the
obscured screen regions on the device. Use of this method is only
valid during the call to {Toybox::WatchUi::View#onUpdate onUpdate()}.
Returns [Toybox::WatchUi::DataField::Obscurity] A

{Toybox::WatchUi::DataField::OBSCURE_LEFT WatchUi.DataField.OBSCURE_*}
value
@since 1.0.0
]]> The device has transitioned to the next multisport leg.

This method is called when the device transitions to the next
multisport leg.
@since 3.0.0
]]> The current activity has ended.

This method is called when the time has stopped and current activity
is ended.
@since 1.3.0
]]> Retrieve {Toybox::Activity::Info Activity.Info} in a DataField.

This method is called once per second and automatically provides
{Toybox::Activity::Info Activity.Info} to the DataField object for
display or additional computation. It is necessary to override
+compute()+ when implementing a DataField.
info [Toybox::Activity::Info] The updated Activity.Info object

@example
function compute(info) {
if (info has :currentHeartRate) {
if (info.currentHeartRate != null) {
hrValue = info.currentHeartRate;
} else {
hrValue = 0.0f;
}
}
}
@see Toybox::Activity::Info Activity.Info
@since 1.0.0
]]> The current workout is started.

This method is called when the a workout is started.
@since 3.2.0
]]> Create a new custom FIT {Toybox::FitContributor::Field Field}.

To record custom activity data to a FIT file, a new
{Toybox::FitContributor::Field Field} must first be created to allow
Data Fields access to FIT recording without allowing access to the
session. Once created, a Field is updated in the FIT file by changing
the *value* of the data within the Field.
name [Toybox::Lang::String] The name of the Field

fieldId [Toybox::Lang::Number] The unique Field identifier of

the Field
type [Toybox::FitContributor::DataType] A

{Toybox::FitContributor::DATA_TYPE_SINT8 FitContributor.DATA_TYPE_*}
value representing the type definition of the Field
options [Toybox::Lang::Dictionary] Optional parameters for

field creation
@option options [Toybox::Lang::Number] :count The number of elements
to add to the field if it is an Array. This is also the maximum
combined size of the Strings plus their +null+ terminators if the Field
type is FitContributor.DATA_TYPE_STRING (Default 1).
@option options [Toybox::FitContributor::MessageType] :mesgType Optional. A
{Toybox::FitContributor::MESG_TYPE_SESSION FitContributor.MESG_TYPE_*}
value representing the Field message type.
This defaults to FitContributor.MESG_TYPE_RECORD if not specified.
Additionally, if FitContributor.MESG_TYPE_RECORD is used, the field
type cannot be FitContributor.DATA_TYPE_STRING.
@option options [Toybox::Lang::String] :units Optional. A String
representing the display units (e.g. "mph", "ft", "Pa")
Returns [Toybox::FitContributor::Field]

@see Toybox::FitContributor
@see https://www.thisisant.com/resources/fit The Messages Sheet in
Profile.xlsx included with the FIT SDK for native field numbers
@since 1.3.0
]]> The activity time has resumed.

This method is called when the activity timer goes from a paused state
to a running state.
@since 1.3.0
]]> The activity timer is paused.

This method is called when the activity timer goes from a running
state to a paused state. The paused state occurs when the auto-pause
feature pauses the timer. If the activity timer is paused when the
app is loaded, this event will run immediately after startup.
@since 1.3.0
]]> Constructor
@since 1.0.0
]]> Show an alert.
alertView [Toybox::WatchUi::DataFieldAlert] View to push

* Only {Toybox::WatchUi::DataFieldAlert} is supported for this operation
@throws [Toybox::Lang::OperationNotAllowedException] Thrown
if called from an app type other than data field
@throws [Toybox::Lang::UnexpectedTypeException]
Thrown if the view type is not {Toybox::WatchUi::DataFieldAlert DataFieldAlert}
@since 3.2.0
]]> The activity timer has stopped.

This method is called when the activity timer goes from a running
state to a stopped state.
@since 1.3.0
]]> Set a ToggleMenuItem state.
enabled [Toybox::Lang::Boolean] The intended state of the

ToggleMenuItem; enabled if +true+, disabled if +false+
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
enabled is not a valid type
@since 3.0.0
]]> Get a ToggleMenuItem state.
Returns [Toybox::Lang::Boolean] The current state of the ToggleMenuItem

@since 3.0.0
]]> Constructor
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The string label for the ToggleMenuItem

subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::Lang::Dictionary] The

substring label for the item or a dictionary of toggle states mapped
to sub-label strings, which can be +null+
@option subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] :enabled The string displayed
when the ToggleMenuItem is enabled, or +null+
@option subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] :disabled The string displayed
when the ToggleMenuItem is disabled, or +null+
identifier [Toybox::Lang::Object] The identifier for this

ToggleMenuItem, which is typically a {Toybox::Lang::String String}
enabled [Toybox::Lang::Boolean] The initial state of the

ToggleMenuItem; enabled if +true+, disabled if +false+
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::WatchUi::MenuItem::Alignment] :alignment A
{Toybox::WatchUi::MenuItem::MENU_ITEM_LABEL_ALIGN_RIGHT WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN_*}
constant representing the label alignment, which defaults to the
system default for toggle menu items if not specified.
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
for the subscreen area when the menu item is in focus
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@since 3.0.0
]]> Get a ToggleMenuItem label substring.
Returns [Toybox::Lang::String, Toybox::Lang::Dictionary] The substring

text label for the ToggleMenuItem
@since 3.0.0
]]> Set a ToggleMenuItem label substring.
subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::Lang::Dictionary] The

substring label for the item or a dictionary of toggle states mapped
to sub-label strings, which can be +null+
@option subLabel [Toybox::Lang::String] :enabled The string displayed
when the ToggleMenuItem is enabled, or +null+
@option subLabel [Toybox::Lang::String] :disabled The string displayed
when the ToggleMenuItem is disabled, or +null+
@since 3.0.0
]]> Constructor
initialText [Toybox::Lang::String] The initial text for the

TextPicker
@since 1.1.0
]]> A touch screen hold event has occurred.

This is sent when the touch screen is touched and not released.
clickEvent [Toybox::WatchUi::ClickEvent] The click event that

has occurred
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::ClickEvent
@since 1.0.0
]]> Maps low level events to delegate events.
@note DO NOT OVERRIDE.
@todo This should be a hidden function, but +TVM_obj_invoke()+ only
looks at public functions
@since 1.0.0
]]> A physical button has been released.

To find out which key was pressed, use
{Toybox::WatchUi::KeyEvent#getKey KeyEvent.getKey()} to get the button's
{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} enum value.
keyEvent [Toybox::WatchUi::KeyEvent] The key event that occurred

Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::KeyEvent
@since 1.1.2
]]> A touch screen swipe event has occurred.

This is sent when the touch screen is swiped.
swipeEvent [Toybox::WatchUi::SwipeEvent] The swipe event that

has occurred
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::SwipeEvent
@since 1.0.0
]]> The state of a {Toybox::WatchUi::Selectable Selectable} has changed.
selectableEvent [Toybox::WatchUi::SelectableEvent] The selectable

event containing the information about the Selectable whose state
has changed
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::Selectable
@see Toybox::WatchUi::SelectableEvent
@since 2.1.0
]]> A screen tap event has occurred.

This is sent when the touch screen is tapped (a quick touch and release).
clickEvent [Toybox::WatchUi::ClickEvent] The click event that

occurred
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::ClickEvent
@since 1.0.0
]]> A physical button has been pressed and released.

To find out which key was pressed, use
{Toybox::WatchUi::KeyEvent#getKey KeyEvent.getKey()} to get the button's
{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} enum value.
keyEvent [Toybox::WatchUi::KeyEvent] The key event that occurred

Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::KeyEvent
@since 1.0.0
]]> A physical button has been pressed down.

To find out which key was pressed, use
{Toybox::WatchUi::KeyEvent#getKey KeyEvent.getKey()} to get the button's
{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} enum value.
keyEvent [Toybox::WatchUi::KeyEvent] The key event that occurred.

Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::KeyEvent
@since 1.1.2
]]> A touch screen release event has occurred.

This is only sent after an {Toybox::WatchUi::InputDelegate#onHold onHold()}
event, once the hold on the touch screen is released.
clickEvent [Toybox::WatchUi::ClickEvent] The click event that

has occurred
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@see Toybox::WatchUi::ClickEvent
@since 1.0.0
]]> Get the current state of a Selectable object.
Returns [Toybox::Lang::Symbol] The current state:

* :stateDefault
* :stateHighlighted
* :stateSelected
* :stateDisabled
@since 2.1.0
]]> Set the current state of a Selectable object.
state [Toybox::Lang::Symbol] The desired state:

* :stateDefault
* :stateHighlighted
* :stateSelected
* :stateDisabled
@throws [Toybox::WatchUi::InvalidSelectableStateException]
@since 2.1.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

options for the Selectable object
@option options [Toybox::Lang::Numeric] :locX The absolute, on-screen
x-coordinate for the Selectable object (required)
@option options [Toybox::Lang::Numeric] :locY The absolute, on-screen
y-coordinate for the Selectable object (required)
@option options [Toybox::Lang::Numeric] :width The clip width of the
Selectable object (required)
@option options [Toybox::Lang::Numeric] :height The clip height of
the Selectable object (required)
@option options [Toybox::Graphics::ColorType,Toybox::WatchUi::Drawable] :stateDefault The Drawable or
color to display in default state (optional)
@option options [Toybox::Graphics::ColorType,Toybox::WatchUi::Drawable] :stateHighlighted The Drawable
or color to display in highlighted state (optional)
@option options [Toybox::Graphics::ColorType,Toybox::WatchUi::Drawable] :stateSelected The Drawable
or color to display in selected state (optional)
@option options [Toybox::Graphics::ColorType,Toybox::WatchUi::Drawable] :stateDisabled The Drawable
or color to display in disabled state (optional)
@see Toybox::WatchUi::Drawable#initialize Drawable.initialize()
@since 2.1.0
]]> Draw the Selectable to the device context ({Toybox::Graphics::Dc Dc}).

This method assumes that the device context has already been
configured to the proper options.
dc [Toybox::Graphics::Dc] The device context

@since 2.1.0
]]> Add an entry to a Menu.
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The item text as a String or string ResourceId

identifier [Toybox::Lang::Symbol] A Symbol representing the Menu item

value
@since 1.0.0
]]> Set a Menu title.
title [Toybox::Lang::String, Toybox::Lang::ResourceId] The title text or a string ResourceId

@since 1.0.0
]]> Set the value of the ProgressBar.
progressValue [Toybox::Lang::Float] The current value of the

ProgressBar:
* An increment from 0 to 100
* +null+ for "busy"
@since 1.0.0
]]> Constructor
displayString [Toybox::Lang::String] The string to display on

the ProgressBar
startValue [Toybox::Lang::Float] The initial value for the

ProgressBar:
* An increment from 0 to 100
* +null+ for "busy"
@since 1.0.0
]]> Set the string to display on the ProgressBar.
displayString [Toybox::Lang::String] The string to display on

the ProgressBar
@since 1.0.0
]]> Constructor
@since 2.1.0
]]> Get the height of an animation resource.
Returns [Toybox::Lang::Number] Height of the animation in pixels

@since 3.1.0
]]> Get the number of frames of an animation resource.
Returns [Toybox::Lang::Number] Number of frames

@since 3.1.0
]]> Get the color depth in terms of bit/pixel of the animation resource.
Returns [Toybox::Lang::Number] Color depth in terms of bit/pixel

@since 3.2.0
]]> Get info about an animation resource as a String.

The info String is formatted as "Animation X x Y" where "X" is the width
of the animation and "Y" is the height.
Returns [Toybox::Lang::String] A String representation of the

AnimationResource object
@since 3.1.0
]]> Get the width of an animation resource.
Returns [Toybox::Lang::Number] Width of the animation in pixels

@since 3.1.0
]]> Get the target frame rate of an animation resource.
Returns [Toybox::Lang::Number] Frame rate of the animation in seconds

@since 3.1.0
]]> Get the height of a bitmap resource.
Returns [Toybox::Lang::Number] Height of the bitmap in pixels

@since 1.0.0
]]> Get info about a bitmap resource as a String.

The info String is formatted as "Bitmap X x Y" where "X" is the width
of the bitmap and "Y" is the height.
Returns [Toybox::Lang::String] A String representation of the

BitmapResource object
@since 1.0.0
]]> Get the width of a bitmap resource.
Returns [Toybox::Lang::Number] Width of the bitmap in pixels

@since 1.0.0
]]> Set the color of a Text object.
color [Toybox::Graphics::ColorType] A

{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value
representing the desired text color
@since 1.0.0
]]> Set the background color of a Text object.
color [Toybox::Graphics::ColorType] A

{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value
representing the desired background color
@since 1.3.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

the options for the Text object
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId] :text
The text string or ResourceId of a string resource
@option options [Toybox::Graphics::ColorType] :color A
{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value representing
the desired text color, defaults to COLOR_WHITE
@option options [Toybox::Graphics::ColorType] :backgroundColor
A {Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value representing
the desired background color, defaults to COLOR_TRANSPARENT
@option options [Toybox::Graphics::FontType] :font A
value representing the desired font face, defaults to FONT_MEDIUM
@option options [Toybox::Graphics::TextJustification, Toybox::Lang::Number] :justification
A {Toybox::Graphics::TEXT_JUSTIFY_RIGHT Graphics.TEXT_JUSTIFY_*} value
representing the desired justification, defaults to TEXT_JUSTIFY_LEFT
@see Toybox::WatchUi::Drawable#initialize Drawable.initialize()
@since 1.0.0
]]> Draw Text to the device context ({Toybox::Graphics::Dc Dc}).
dc [Toybox::Graphics::Dc] The device context

@since 1.0.0
]]> Set the font face of a Text object.
font [Toybox::Graphics::FontDefinition] A

{Toybox::Graphics::FONT_XTINY Graphics.FONT_*} value representing
the desired font face or a resource object from
{Toybox::WatchUi#loadResource WatchUi.loadResource()}
@see Toybox::WatchUi#loadResource WatchUi.loadResource()
@since 1.0.0
]]> Set the justification of a Text object.
justification [Toybox::Graphics::TextJustification] A

{Toybox::Graphics::TEXT_JUSTIFY_RIGHT Graphics.TEXT_JUSTIFY_*}
value representing the desired justification
@since 1.0.0
]]> Set the text string of a Text object.
text [Toybox::Lang::String, Toybox::Lang::ResourceId] The text

String or a string ResourceId
@since 1.0.0
]]> Set visibility of the layer, if the layer hasn't been added to a view, or the view isn't on top of view stack,
the value will be saved.
visible [Toybox::Lang::Boolean] +true+ for visible (or to show), +false+ for invisible (or to hide).

@since 3.1.0
]]> Set Y-axis absolute draw offset relative to the screen origin
y [Toybox::Lang::Number] new y offset from screen origin

@since 3.1.0
]]> Set X-axis absolute draw offset relative to the screen origin
x [Toybox::Lang::Number] new x offset from screen origin

@since 3.1.0
]]> Layer identifier, can be +null+
Returns [Toybox::Lang::Number, Toybox::Lang::Object] the identifier of the layer, can be +null+

@since 3.1.0
]]>
Returns [Toybox::Lang::Boolean] +true+ if the layer is visible otherwise +false+

@since 3.1.0
]]> Get the {Toybox::Graphics::Dc Graphics.Dc} to draw on.
@since 3.1.0
]]> Get X-axis absolute draw offset relative to the screen origin
Returns [Toybox::Lang::Number] X-axis absolute draw offset relative to the screen origin

@since 3.1.0
]]> Get Y-axis absolute draw offset relative to the screen origin
Returns [Toybox::Lang::Number] Y-axis absolute draw offset relative to the screen origin

@since 3.1.0
]]> Set draw offset relative to the screen origin
x [Toybox::Lang::Number] new x offset from screen origin

y [Toybox::Lang::Number] new y offset from screen origin

@since 3.1.0
]]> Constructor

options [Toybox::Lang::Dictionary] A Dictionary of options; can be +null+,

which defaults to full screen layer
@option options [Toybox::Lang::Number] :locX The x coordinate of the top left
corner of the layer (optional defaults to 0)
@option options [Toybox::Lang::Number] :locY The y coordinate of the top left
corner of the layer (optional defaults to 0)
@option options [Toybox::Lang::Number] :width The width of the layers in pixels,
@option options [Toybox::Lang::Number] :height The height of the layers in pixels,
@option options [Toybox::Lang::Number] :colorDepth hidden option, Color depth
in terms of bits/pixel, when missing, default to system value.
@option options [Toybox::Lang::Boolean] :visibility +true+ if the layer is visible,
otherwise +false+ (optional, default to +true+)
@option options [Toybox::Lang::Object] :identifier unique object for identification (optional)
@since 3.1.0
]]> A Menu item was chosen.

This method is called when a Menu item has been selected, and receives
the Menu item as an argument.
item [Toybox::Lang::Symbol] The identifier of the chosen Menu

item
@since 1.0.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 3.0.0
]]> Set the background color of a Text object.
color [Toybox::Graphics::ColorType] A

{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value
representing the desired background color
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
color is not a valid type
@since 3.1.0
]]> Draw Text to the device context ({Toybox::Graphics::Dc Dc}).
dc [Toybox::Graphics::Dc] The device context

@since 3.1.0
]]> Set the justification of a Text object.
justification [Toybox::Graphics::TextJustification] A

{Toybox::Graphics::TEXT_JUSTIFY_RIGHT Graphics.TEXT_JUSTIFY_*}
value representing the desired justification
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
justification is not a valid type
@since 3.1.0
]]> Set the color of a Text object.
color [Toybox::Graphics::ColorType] A

{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value
representing the desired text color
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
color is not a valid type
@since 3.1.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

the options for the Text object
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId] :text
The text string or ResourceId of a string resource
@option options [Toybox::Graphics::ColorType] :color A
{Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value representing
the desired text color, defaults to COLOR_WHITE
@option options [Toybox::Graphics::ColorType] :backgroundColor
A {Toybox::Graphics::COLOR_WHITE Graphics.COLOR_*} value representing
the desired background color, defaults to COLOR_TRANSPARENT
@option options [Toybox::Lang::Array, Toybox::Graphics::FontDefinition] :font A
{Toybox::Graphics::FONT_XTINY Graphics.FONT_*} value representing the
desired font face, or an array of such values. Defaults to FONT_MEDIUM
@option options [Toybox::Graphics::TextJustification] :justification
A {Toybox::Graphics::TEXT_JUSTIFY_RIGHT Graphics.TEXT_JUSTIFY_*} value
representing the desired justification, defaults to TEXT_JUSTIFY_LEFT
@see Toybox::WatchUi::Drawable#initialize Drawable.initialize()
@since 3.1.0
]]> Set the font face of a Text object.
font [Toybox::Graphics::FontDefinition] A

{Toybox::Graphics::FONT_XTINY Graphics.FONT_*} value representing
the desired font face or a resource object from
{Toybox::WatchUi#loadResource WatchUi.loadResource()}, or an
{Toybox::Lang::Array Array} of such values.
@see Toybox::WatchUi#loadResource WatchUi.loadResource()
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
font is not a valid type
@since 3.1.0
]]> Set the text string of a Text object.
text [Toybox::Lang::String, Toybox::Lang::ResourceId] The text

String or a string ResourceId
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
text is not a valid type
@since 3.1.0
]]> A confirmation selection was made.

This method is called when a {Toybox::WatchUi::Confirmation Confirmation}
response is selected, and receives the response as an argument. The
response is either a {Toybox::WatchUi::CONFIRM_NO CONFIRM_NO} or
{Toybox::WatchUi::CONFIRM_YES CONFIRM_YES} value.
response [Toybox::WatchUi::Confirm] The

{Toybox::WatchUi::CONFIRM_NO WatchUi.CONFIRM_*} value from this
Confirmation
@see Toybox::WatchUi::Confirmation
@since 1.0.0
]]> Represents the _Previous_ _Page_ behavior.

This is typically triggered by the up button
({Toybox::WatchUi::KEY_UP KEY_UP})) or by a
{Toybox::WatchUi::SWIPE_DOWN SWIPE_DOWN}
{Toybox::WatchUi::SwipeEvent SwipeEvent} on a touch screen.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> Represents the _Menu_ behavior.

This is typically triggered by the menu button
({Toybox::WatchUi::KEY_MENU KEY_MENU}).
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> This maps low level events to delegate events.
@note DO NOT OVERRIDE.
@todo Make this hidden once TVM_obj_invoke() is reworked
@since 1.0.0
]]> Represents the _Next_ behavior.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> Represents the _Selection_ behavior.

This is typically triggered by the Start/Enter button
({Toybox::WatchUi::KEY_ENTER KEY_ENTER}) or by a
{Toybox::WatchUi::CLICK_TYPE_TAP CLICK_TYPE_TAP}
{Toybox::WatchUi::ClickEvent ClickEvent} on a touch screen.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.2.0
]]> Represents the _Back_ behavior.

This is typically triggered by the back button
({Toybox::WatchUi::KEY_ESC KEY_ESC}).
@note Some devices interpret {Toybox::WatchUi::SWIPE_RIGHT SWIPE_RIGHT}
{Toybox::WatchUi::SwipeEvent SwipeEvents} as {Toybox::WatchUi::KEY_ESC KEY_ESC}
events. On these devices, returning +false+ will cause
{Toybox::WatchUi::InputDelegate#onKey onKey()} to be called
rather than {Toybox::WatchUi::InputDelegate#onSwipe onSwipe()}.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> Constructor
@since 1.0.0
]]> Represents the _Next_ _Page_ behavior.

This is typically triggered by the down button
({Toybox::WatchUi::KEY_DOWN KEY_DOWN}) or by a
{Toybox::WatchUi::SWIPE_UP SWIPE_UP}
{Toybox::WatchUi::SwipeEvent SwipeEvent} on a touch screen.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> Represents the _Previous_ _Mode_ behavior.
Returns [Toybox::Lang::Boolean] +true+ if handled, otherwise +false+

@since 1.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A dictionary of options. There are no options at the moment.

@since 3.0.3
]]> Get the previous state of the Selectable that generated the event.
Returns [Toybox::Lang::Symbol] A symbol representing one of the four

available states:
* {Toybox::WatchUi::Selectable#stateDefault stateDefault}
* {Toybox::WatchUi::Selectable#stateHighlighted stateHighlighted}
* {Toybox::WatchUi::Selectable#stateSelected stateSelected}
* {Toybox::WatchUi::Selectable#stateDisabled stateDisabled}
@since 2.1.0
]]> Constructor
instance [Toybox::WatchUi::Selectable] The Selectable that

generated the event
previousState [Toybox::Lang::Symbol] The previous Selectable

state (e.g. :stateDefault, :stateHighlighted, etc.)
@since 2.1.0
]]> Get the instance of the manipulated {Toybox::WatchUi::Selectable Selectable}.
Returns [Toybox::Lang::Object] A reference to the Selectable

@since 2.1.0
]]> Add a CheckboxMenuItem to a CheckboxMenu.
item [Toybox::WatchUi::CheckboxMenuItem] The CheckboxMenuItem

to add to the CheckboxMenu
@throws [Toybox::WatchUi::InvalidMenuItemTypeException] Thrown if
item is not a [Toybox::WatchUi::CheckboxMenuItem]
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
item is not a valid type
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

* Can be +null+
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::WatchUi::Drawable] :title
The menu title
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::WatchUi::Drawable] :footer
The menu footer
@option options [Toybox::Lang::Number] :focus The index of the
{Toybox::WatchUi::CheckboxMenuItem CheckboxMenuItem} that should have
initial focus
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
the default icon for menu items
@option options [Toybox::WatchUi::MenuTheme] :theme The menu theme, or +null+ for no theme.
Defaults to MENU_THEME_DEFAULT.
@option options [Toybox::WatchUi::Menu2::DividerType] :dividerType The divider type,
Defaults to DIVIDER_TYPE_DEFAULT or when +null+ is passed as value.
@see Toybox::WatchUi::Menu2#setDividerType
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@note The +:theme+ option is only used on ConnectIQ 4.1.8 devices with menu theme support.
@note The +:dividerType+ option is only used on ConnectIQ 5.0.1 devices with divider support.
@note The +:footer+ option is only used on ConnectIQ 5.1.0 devices.
@since 3.0.0
]]> Get the direction of the swipe.
Returns [Toybox::WatchUi::SwipeDirection] A

{Toybox::WatchUi::SWIPE_UP WatchUi.SWIPE_*} value
@since 1.0.0
]]> Constructor
direction [Toybox::WatchUi::SwipeDirection] The

{Toybox::WatchUi::SWIPE_UP WatchUi.SWIPE_*} value for
this event
@since 1.0.0
]]> A CustomMenu title was selected.

This method is triggered on products with touch input when the user
selects the title area of a CustomMenu.

@note Prior to ConnectIQ API version 5.1.0, this function was only
called on {Toybox::WatchUi::CustomMenu CustomMenu}. It is now used
for all {Toybox::WatchUi::Menu2 Menu2} types.
@since 3.0.0
]]> A Menu2 Back key was pressed.
If this method is not overridden, it will pop the active view.
@since 3.0.0
]]> A Menu2 is preparing to wrap.

This method is triggered on button-based products when the user
attempts to navigate off the end of a menu. If this method returns
+false+ the list will not wrap to the opposite end.
If this method is not overridden, it will return +true+ and allow
the menu to wrap.
key [Toybox::WatchUi::Key] The key from the

{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} enumeration that is
triggering the menu wrap.
Returns [Toybox::Lang::Boolean] +true+ if wrap is allowed, +false+ otherwise

@since 3.0.0
]]> A Menu2 Done item was selected.
This method is only triggered by a
{Toybox::WatchUi::CheckboxMenu CheckboxMenu}
If this method is not overridden, it will pop the active view.
@since 3.0.0
]]> A CustomMenu footer was selected.

This method is triggered on products with touch input when the user
selects the footer area of a CustomMenu.

@note Prior to ConnectIQ API version 5.1.0, this function was only
called on {Toybox::WatchUi::CustomMenu CustomMenu}. It is now used
for all {Toybox::WatchUi::Menu2 Menu2} types.
@since 3.0.0
]]> A Menu2 MenuItem was selected.
item [Toybox::WatchUi::MenuItem] The selected MenuItem.

@since 3.0.0
]]> Constructor
message [Toybox::Lang::String] The confirmation message to

display in the confirmation dialog
@since 1.0.0
]]> Play animation, animation must be added to and not abandoned by the view
before it can be played.

This will stop the existing playback first.

options [Toybox::Lang::Dictionary] A Dictionary of options, can be +null+

@option options [Toybox::WatchUi::AnimationDelegate] :delegate An
{Toybox::WatchUi::AnimationDelegate AnimationDelegate }
Returns [Toybox::Lang::Boolean] +true+ if playback started, otherwise +false+

@since 3.1.0
]]> Get the animation resource
Returns [Toybox::WatchUi::AnimationResource] the {Toybox::WatchUi::AnimationResource WatchUi.AnimationResource}

@since 3.1.0
]]> Stop a playing animation.
The last frame of the animation will be persisted in the frame buffer.
@since 3.1.0
]]> Constructor
rez [Toybox::Lang::ResourceId, Toybox::WatchUi::AnimationResource]

either an animation ResourceId or a {Toybox::WatchUi::AnimationResource WatchUi.AnimationResource}
options [Toybox::Lang::Dictionary] A Dictionary of options, can be +null+

@option options [Toybox::Lang::Number] :locX The initial absolute, on-screen
x-coordinate for the Animation object (optional defaults to 0)
@option options [Toybox::Lang::Number] :locY The initial absolute, on-screen
y-coordinate for the Animation object (optional defaults to 0)
@option options [Toybox::Lang::Object] :identifier unique object for identification (optional)
@option options [Toybox::Lang::Boolean] :visibility +true+ if the layer is visible,
otherwise +false+ (optional, default to +true+)
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +rez+ is not an animation resource or ResourceId
@since 3.1.0
]]> getDc will always return +null+, as the dc buffer of animations can not be updated by user.
@since 3.1.0
]]> Constructor
@since 3.1.0
]]> Retrieve {Toybox::Activity::Info Activity.Info} in a SimpleDataField.

This method is called once per second and automatically provides
{Toybox::Activity::Info Activity.Info} to the SimpleDataField object
for display or additional computation. It is necessary to override
+compute()+ when implementing a SimpleDataField. The value to be
displayed in the field must be returned by this method.
info [Toybox::Activity::Info] The updated Activity.Info object

Returns [Toybox::Lang::Number, Toybox::Lang::Long, Toybox::Lang::Float,

Toybox::Lang::Double, Toybox::Time::Duration, Toybox::Lang::String, null]
The value to be displayed in the field or +null+
@example
function compute(info) {
return info.currentHeartRate;
}
@see Toybox::Activity::Info Activity.Info
@since 1.0.0
]]> Constructor
@since 1.0.0
]]> A text string was entered into a TextPicker.

This method is called when text has been specified by a TextPicker,
and receives the text String as an argument.
text [Toybox::Lang::String] The entered text

changed [Toybox::Lang::Boolean] The entered text differs from

the initially specified text of the TextPicker
@since 1.1.0
]]> Text entry has been canceled.
@since 1.1.0
]]> Get the key value of this event.
Returns [Toybox::WatchUi::Key] A

{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} value
@since 1.0.0
]]> Get the type of click event.
Returns [Toybox::WatchUi::KeyPressType] A

{Toybox::WatchUi::PRESS_TYPE_DOWN WatchUi.PRESS_TYPE_*} value
@since 1.1.2
]]> Constructor
keyValue [Toybox::WatchUi::Key] A

{Toybox::WatchUi::KEY_POWER WatchUi.KEY_*} value
keyPressType [Toybox::WatchUi::KeyPressType] A

{Toybox::WatchUi::PRESS_TYPE_DOWN WatchUi.PRESS_TYPE_*}
value for the event (since 1.1.2)
@since 1.0.0
]]> Get the dimensions of a Bitmap.
Returns [Toybox::Lang::Array] A two element array containing the

width and height of the Bitmap object
@since 1.0.0
]]> Set the resource associated with the Bitmap.

bitmap [Toybox::Graphics::BitmapType, Toybox::Lang::ResourceId] The ResourceId or

the Bitmap object.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if bitmap is not a valid type
@note A +null+ value passed for the bitmap parameter is only
supported with ConnectIQ 5.0.0 and later.
@since 1.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

the options for the Bitmap object
@option options [Toybox::Lang::ResourceId] :rezId The resource
identifier for the Bitmap object
@option options [Toybox::Graphics::BitmapType] :bitmap The BitmapResource,
BufferedBitmap, BitmapReference, or BufferedBitmapReference object to use
@see Toybox::WatchUi::Drawable#initialize Drawable.initialize()
@since 1.0.0
]]> Draw a Bitmap to the device context ({Toybox::Graphics::Dc Dc}).
dc [Toybox::Graphics::Dc] The device context

@since 1.0.0
]]> Constructor
@since 3.2.0
]]> Set the options for the Picker.
options [Toybox::Lang::Dictionary] A Dictionary containing

the options for the Picker object
@option options [Toybox::WatchUi::Drawable] :title The title for the
Picker (required)
@option options [Toybox::Lang::Array] :pattern An Array of either
{Toybox::WatchUi::Drawable Drawable} or
{Toybox::WatchUi::PickerFactory PickerFactory} objects for the Picker
to display. A PickerFactory presents a choice of
Pickers, while a Drawable immediately displays the Picker (required)
@option options [Toybox::Lang::Array] :defaults An Array of
{Toybox::Lang::Number Number} objects indicating the starting index
for each entry in the supplied pattern (optional)
@option options [Toybox::WatchUi::Drawable] :nextArrow A custom next
icon for the Picker (optional)
@option options [Toybox::WatchUi::Drawable] :previousArrow A custom
previous icon for the Picker (optional)
@option options [Toybox::WatchUi::Drawable] :confirm A custom
confirmation icon for the Picker (optional)
@see Toybox::WatchUi::PickerFactory
@see Toybox::WatchUi::Drawable
@since 1.2.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary containing

the options for the Picker object
@see Toybox::WatchUi::Picker#setOptions Picker.setOptions()
@since 1.2.0
]]> Get a MenuItem label.
Returns [Toybox::Lang::String] The text label for the MenuItem

@since 3.0.0
]]> Get a MenuItem identifier.
Returns [Toybox::Lang::Object] The identifier for the MenuItem

@since 3.0.0
]]> Set a MenuItem label.
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The text label for the MenuItem

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
label is an invalid type, or if a ResourceId does not reference
to a valid string resource
@since 3.0.0
]]> Constructor
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The string label for the MenuItem

subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] The substring label for the

MenuItem, which can be +null+
identifier [Toybox::Lang::Object] The identifier for this

MenuItem, which is typically a {Toybox::Lang::String String}
options [Toybox::Lang::Dictionary] A Dictionary of options. Can be +null+

@option options [Toybox::WatchUi::MenuItem::Alignment] :alignment One of the
{Toybox::WatchUi::MenuItem::MENU_ITEM_LABEL_ALIGN_RIGHT WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN*} values that
indicates the text alignment for the menu item.
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
The icon displayed in the subscreen area when this MenuItem has the focus.
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@since 3.0.0
]]> Get a MenuItem substring label.
Returns [Toybox::Lang::String] The substring text label for the

MenuItem
@since 3.0.0
]]> Set a MenuItem substring label.
subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] The substring text label for

the MenuItem, which can be +null+
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
label is an invalid type, or if a resource ID does not point
to a valid string resource
@since 3.0.0
]]> Handle a partial update exceeding the power budget.

If the {Toybox::WatchUi::WatchFace#onPartialUpdate onPartialUpdate()}
callback of the associated {Toybox::WatchUi::WatchFace WatchFace}
exceeds the power budget of the device, this method will be called
with information about the limits that were exceeded.
powerInfo [Toybox::WatchUi::WatchFacePowerInfo]

@see Toybox::WatchUi::WatchFace
@see Toybox::WatchUi::WatchFace#onPartialUpdate onPartialUpdate()
@since 2.3.0
]]> Get the CustomMenuItem selected state.

Returns [Toybox::Lang::Boolean] The current selected state of the

CustomMenuItem
@since 3.0.0
]]> Constructor
identifier [Toybox::Lang::Object] The identifier for this item

which is typically a {Toybox::Lang::String String}
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::WatchUi::Drawable] :drawable A Drawable
that draws the item. (required)
@see Toybox::WatchUi::MenuItem#initialize MenuItem.initialize()
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +:drawable+
option is not a {Toybox::WatchUi::Drawable Drawable} or is +null+.
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
for the subscreen area when the menu item is in focus
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :dividerIcon
icon for the divider area.
@see Toybox::WatchUi::CustomMenuItem#setDividerIcon CustomMenuItem.setDividerIcon()
@since 3.0.0
]]> Draw method for a CustomMenuItem.

This is called when a menu item is rendering.
dc [Toybox::Graphics::Dc] The item's drawing context

@since 3.0.0
]]> Get the CustomMenuItem focus state.

Returns [Toybox::Lang::Boolean] The current focus state of the

CustomMenuItem
@since 3.0.0
]]> Set a CustomMenuItem Drawable.

drawable [Toybox::WatchUi::Drawable] A Drawable to render on top of

the menu items, or +null+.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if +drawable+
is not a {Toybox::WatchUi::Drawable Drawable} or is +null+.
@since 3.0.0
]]> Remove a layer from the view layer stack, this will stop animation playback.
layer a {Toybox::WatchUi::Layer WatchUi.Layer} to remove from the layer stack.

Returns [Toybox::Lang::Boolean] +true+, if layer is removed successfully, otherwise +false+

@since 3.1.0
]]> Show the View.

This is called when the View is brought into the foreground. Resources
should be loaded into system memory for use in the View at this point.
@since 1.0.0
]]> The entry point for the View.

onLayout() is called before the View is shown to load resources and
set up the layout of the View.
dc [Toybox::Graphics::Dc] The device context

@since 1.0.0
]]> Get a copy of the layer stack currently added to the view, sorted by the drawing order,
i.e. from the bottom to the top.
Returns [Toybox::Lang::Array] an array of {Toybox::WatchUi::Layer WatchUi.Layer} or +null+

@since 3.1.0
]]> Set the layout for the View.

Set the array of Drawable objects to be managed by this View. The
specified Drawables will be:
* Drawn automatically via calls to {Toybox::WatchUi::View#onUpdate onUpdate()}
* Searched via calls to {Toybox::WatchUi::View#findDrawableById findDrawableById()}
layout [Toybox::Lang::Array] An array of Drawables or +null+.

@since 1.0.0
]]> Clear all layers that are added to the view
@since 3.1.0
]]> Iterate over all the layouts and draw them in dc
]]> Enter Selectable interaction mode.

When enabled, physical buttons may be used to cycle through on-screen
{Toybox::WatchUi::Selectable Selectable} objects. The first registered
Selectable in the current layout will be highlighted initially.
enable [Toybox::Lang::Boolean] Set to +true+ if the mode

should be enabled, otherwise +false+
@example Toggle the Selectable interaction mode with the Menu button
var selectableMode = false;
function onMenu() {
selectableMode = !selectableMode;
// currentView is a View containing Selectable objects
currentView.setKeyToSelectableInteraction(selectableMode);
return true;
}
@throws [Toybox::Lang::SymbolNotAllowedException] Thrown if called from
a data field app
@since 2.1.0
]]> Add a {Toybox::WatchUi::Layer WatchUi.Layer} on the top of view's layer stack.
Users do not need to draw the layer on the screen manually, instead, once
a layer is added to the view, the system will draw all layers during screen
updates which include View update (e.g. onUpdate/onPartialUpdate) and animation playback.

Disabled for DataFiled and Background Apps

layer [Toybox::WatchUi::Layer] a {Toybox::WatchUi::Layer WatchUi.Layer} object to add

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +layer+ is not a WatchUi.Layer
@since 3.1.0
]]> Return the index of the layer from the bottom of the view layer stack
layer a {Toybox::WatchUi::Layer WatchUi.Layer} a layer object

Returns [Toybox::Lang::Number] index of the layer from the bottom of the layer stack

@since 3.1.0
]]> Constructor
@since 2.1.0
]]> Find a Drawable by its ID.

A common use for this method is to get layout information to format
dynamic content, such as a string that updates at runtime.
identifier [Toybox::Lang::Object] The identifier of the Drawable to find

Returns [Toybox::WatchUi::Drawable] A Drawable if found, otherwise

+null+
@example Formatting the clock time as centered, blue text
// The layout.xml file contents:
//
//

using Toybox.Graphics;
using Toybox.Lang;
using Toybox.System;
using Toybox.WatchUi.View;

var clockTime = System.getClockTime();
var timeString = Lang.format(
"$1$:$2$",
[clockTime.hour, clockTime.min.format("%02d")]
);
var view = View.findDrawableById("TimeLabel");
view.setText(timeString);
@see Toybox::System#getClockTime System.getClockTime()
@since 1.0.0
]]> Hide the View.

This is called before the View is removed from the foreground. This
occurs when a new View object is pushed on top of the current one,
when the current View is popped, or when the app is closed. Resources
should be freed from memory at this point if the current View will be
left on the page stack.
@since 1.0.0
]]> Update the View.

This is called when a View is brought to the foreground, after the
call to {Toybox::WatchUi::View#onShow onShow()}. While a View is
active, this method is generally used to update dynamic content in
the View. There are also some special cases when it will be invoked:
* On {Toybox::WatchUi#requestUpdate WatchUi.requestUpdate()} calls within Widgets and Watch Apps
* Once per minute in Watch Faces when in low power mode
* Once per second in Watch Faces when in high power mode
* Once per second in Data Fields
* At an increased rate while an {Toybox::WatchUi#animate animation} is active
* More than one call to onUpdate() may occur during View transitions
If a class that extends View does not implement this function then any
Drawable objects contained in the View will automatically be drawn.
dc [Toybox::Graphics::Dc] The device context

@see Toybox::WatchUi::WatchFace#onPartialUpdate WatchFace.onPartialUpdate()
@since 1.0.0
]]> Insert the layer at the given index in the layer stack, this will stop animation playback.
layer [Toybox::WatchUi::Layer] a layer to insert.

idx [Toybox::Lang::Number] position in the layer stack to insert layer.

@since 3.1.0
]]> Set the IconMenuItem icon.
icon [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable] The

Drawable or ResourceId used to render the icon for this item
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
icon is not a valid type
@since 3.0.0
]]> Constructor
label [Toybox::Lang::String, Toybox::Lang::ResourceId] The string label for the IconMenuItem

subLabel [Toybox::Lang::String, Toybox::Lang::ResourceId] The substring label for the

IconMenuItem, which can be +null+
identifier [Toybox::Lang::Object] The identifier for this

IconMenuItem, which is typically a {Toybox::Lang::String String}
icon [Toybox::WatchUi::Drawable, Toybox::WatchUi::BitmapResource, Toybox::Graphics::BitmapReference]

The Drawable used to render the icon for this item or the {Toybox::Graphics::BitmapReference Graphics::BitmapReference} object.
options [Toybox::Lang::Dictionary] A Dictionary of options

@option options [Toybox::WatchUi::MenuItem::Alignment] :alignment A
{Toybox::WatchUi::MenuItem::MENU_ITEM_LABEL_ALIGN_RIGHT WatchUi.MenuItem.MENU_ITEM_LABEL_ALIGN_*}
constant representing the label alignment, which defaults to
MENU_ITEM_LABEL_ALIGN_LEFT
@since 3.0.0
]]> Get IconMenuItem icon.
Returns [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable] The IconMenuItem icon

@since 3.0.0
]]> Set a Menu2 title.
title [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::WatchUi::Drawable]

The menu title text, +null+, a string ResourceId, or a Drawable
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
title is not a valid type
@since 3.0.0
]]> Get a MenuItem from a Menu2.
index [Toybox::Lang::Number] The index of the

{Toybox::WatchUi::MenuItem MenuItem} to get
Returns [Toybox::WatchUi::MenuItem]

@since 3.0.0
]]> Set the focus of a MenuItem in a Menu2.
focus [Toybox::Lang::Number] The index of the

{Toybox::WatchUi::MenuItem MenuItem} that
should have focus
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
focus is not a valid type
@since 3.0.0
]]> Update a MenuItem in a Menu2.
item [Toybox::WatchUi::MenuItem] The MenuItem to update

index [Toybox::Lang::Number] The index of the MenuItem to update

@since 3.0.0
]]> Add a MenuItem to a Menu2.
item [Toybox::WatchUi::MenuItem] The MenuItem to add

to the Menu2
* May not be a {Toybox::WatchUi::CheckboxMenuItem CheckboxMenuItem}
@throws [Toybox::WatchUi::InvalidMenuItemTypeException] Thrown if
item is a {Toybox::WatchUi::CheckboxMenuItem CheckboxMenuItem}
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
item is not a valid type
@since 3.0.0
]]> Delete a MenuItem from a Menu2.
index [Toybox::Lang::Number] The index of the

{Toybox::WatchUi::MenuItem MenuItem} that should be deleted from the
Menu2.
Returns {Toybox::Lang::Boolean} +true+ if the item exists, or +null+ if the specified

index it outside of the bounds of the menu items array.
@since 3.0.0
]]> Constructor
options [Toybox::Lang::Dictionary] A Dictionary of options

* Can be +null+
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::WatchUi::Drawable] :title
The menu title
@option options [Toybox::Lang::String, Toybox::Lang::ResourceId, Toybox::WatchUi::Drawable] :footer
The menu footer
@option options [Toybox::Lang::Number] :focus The index of the
{Toybox::WatchUi::MenuItem MenuItem} that should have initial focus
@option options [Toybox::Graphics::BitmapType, Toybox::WatchUi::Drawable, Toybox::Lang::ResourceId] :icon
The icon to display in the subscreen area when the focused MenuItem does not have an icon.
@option options [Toybox::WatchUi::MenuTheme] :theme The menu theme, or +null+ for no theme.
Defaults to MENU_THEME_DEFAULT.
@option options [Toybox::WatchUi::Menu2::DividerType] :dividerType The divider type,
Defaults to DIVIDER_TYPE_DEFAULT.
@see Toybox::WatchUi::Menu2#setDividerType
@note The +:icon+ option is only used on ConnectIQ 3.4.0 devices with subscreen support.
@note The +:theme+ option is only used on ConnectIQ 4.1.8 devices with menu theme support.
@note The +:dividerType+ option is only used on ConnectIQ 5.0.1 devices with divider support.
@note The +:footer+ option is only used on ConnectIQ 5.1.0 devices.
@since 3.0.0
]]> Find a MenuItem by ID in a Menu2.
identifier [Toybox::Lang::Object] The identifier for which to

search
Returns [Toybox::Lang::Number] The index of the

{Toybox::WatchUi::MenuItem MenuItem} assigned the supplied identifier
* -1 if not found
@since 3.0.0
]]> Set the value to write to this Field.
input [Toybox::Lang::Object] The data to be written to the Field

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if the +input+
type does not match the type specified in
{Toybox::ActivityRecording::Session#createField createField()} at
definition
@since 1.3.0
]]> There is no public constructor; Field objects must be created with
createField().
]]> Get audio provider icon information.

Returns {Toybox::Media::ProviderIconInfo} The icon for the audio content provider

@since 3.0.0
]]> Override to provide the initial View and Input Delegate for configuring playback.

@note This method must be overridden in derived classes. If called, this
function will cause the application to crash.
Returns [Toybox::Lang::Array] An Array containing a

{Toybox::WatchUi::View WatchUi.View} and an optional
{Toybox::WatchUi::BehaviorDelegate WatchUi.BehaviorDelegate},
{Toybox::WatchUi::ConfirmationDelegate WatchUi.ConfirmationDelegate},
{Toybox::WatchUi::InputDelegate WatchUi.InputDelegate},
{Toybox::WatchUi::MenuInputDelegate WatchUi.MenuInputDelegate},
{Toybox::WatchUi::NumberPickerDelegate WatchUi.NumberPickerDelegate},
{Toybox::WatchUi::PickerDelegate WatchUi.PickerDelegate},
{Toybox::WatchUi::TextPickerDelegate WatchUi.TextPickerDelegate}, or
{Toybox::WatchUi::WatchFaceDelegate WatchUi.WatchFaceDelegate}
@since 3.0.0
]]> Get the audio provider icon for the sync page

backgroundColor {Toybox::Lang::Number} a RRGGBB value indicating the

background color of the page the icon is being drawn on
Returns {Toybox::Graphics::BitmapType} A

{Toybox::WatchUi::Drawable Drawable} for the icon.
@since 3.0.1
@deprecated This method may be removed after System 9.
@see Toybox::Application::AppBase#getSyncIcon AppBase.getSyncIcon()
]]> Get a {Toybox::Media::ContentDelegate ContentDelegate} for use by
the system to get and iterate through media content on the device.

@note This method must be overridden in derived classes. If called, this
function will cause the application to crash.
Returns [Toybox::Media::ContentDelegate]

@since 3.0.0
]]> Get a {Toybox::Communications::SyncDelegate SyncDelegate} object that
communicates sync status to the system for syncing media content to
the device.

Returns [Toybox::Communications::SyncDelegate]

@since 3.0.0
@deprecated This method may be removed after System 9.
@see Toybox::Application::AppBase#getSyncDelegate AppBase.getSyncDelegate()
]]> Get the Spotify client ID for the app

Returns {Toybox::Lang::String} The Spotify Client ID

@since 3.0.1
]]> Constructor
@since 3.0.0
]]> Override to provide the initial View and Input Delegate for configuring sync.

@note This method must be overridden in derived classes. If called, this
function will cause the application to crash.
Returns [Toybox::Lang::Array] An Array containing a

{Toybox::WatchUi::View WatchUi.View} and an optional
{Toybox::WatchUi::BehaviorDelegate WatchUi.BehaviorDelegate},
{Toybox::WatchUi::ConfirmationDelegate WatchUi.ConfirmationDelegate},
{Toybox::WatchUi::InputDelegate WatchUi.InputDelegate},
{Toybox::WatchUi::MenuInputDelegate WatchUi.MenuInputDelegate},
{Toybox::WatchUi::NumberPickerDelegate WatchUi.NumberPickerDelegate},
{Toybox::WatchUi::PickerDelegate WatchUi.PickerDelegate},
{Toybox::WatchUi::TextPickerDelegate WatchUi.TextPickerDelegate}, or
{Toybox::WatchUi::WatchFaceDelegate WatchUi.WatchFaceDelegate}
@since 3.0.0
]]> Clear the object store for the application.
@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process on device that does not have
ConnectIQ 3.2.0 support.
@since 2.4.0
]]> Get the data associated with a given key from the object store.

Values must first be set with
{Toybox::Application::Storage#setValue setValue()} before they are
can be obtained with +getValue+.
@note Symbols can change from build to build and are not to be used
for for Keys or Values
key [Toybox::Application::Storage::KeyType] The key of the value to retrieve from

the object store
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
key is a disallowed data type
Returns [Toybox::Application::Storage::ValueType] The content associated with the key,

or +null+ if the key is not in the object store
@see Toybox::Application::Storage#setValue setValue()
@see Toybox::Background
@since 2.4.0
]]> Store the given data in the object.

Support for storing object types has been expanded over time.
* {Toybox::WatchUi::BitmapResource BitmapResource} (Since 3.0.0)
* {Toybox::WatchUi::AnimationResource AnimationResource} (Since 3.0.8)
* {Toybox::BluetoothLowEnergy::ScanResult ScanResult} (Since 3.2.0)
* {Toybox::Complications::Id Complications.Id} (Since 4.2.0)
* {Toybox::Application::WatchFaceConfig::Id WatchFaceConfig.Id} (Since 5.1.0)
There is a limit on the size of the Object Store that can vary between devices.
If you reach this limit, the value will not be saved and an
exception will be thrown. Also, values are limited to 32 KB in size.
@note Symbols can change from build to build and are not to be used
for for Keys or Values
key [Toybox::Application::Storage::KeyType] The key used to store and retrieve

the value from the object store (cannot be a Symbol)
value [Toybox::Application::Storage::ValueType] The value to put into the object store

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
key is a disallowed data type
@throws [Toybox::Lang::StorageFullException] Thrown if
there is not enough remaining space in the Object Store for the given
key and value
@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process on device that does not have
ConnectIQ 3.2.0 support. Data can always be passed to the foreground
process from a background process with {Toybox::Background#exit Background.exit()}.
@example
using Toybox.Application.Storage;

Storage.setValue("number", 2); // set value for "number" key
Storage.setValue("float", 3.14); // set value for "float" key
Storage.setValue("string", "Hello World!"); // set value for "string" key
Storage.setValue("boolean", true); // set value for "boolean" key

var int = Storage.getValue("number"); // get value for "number" key
var float = Storage.getValue("float"); // get value for "float" key
var string = Storage.getValue("string"); // get value for "string" key
var boolean = Storage.getValue("boolean"); // get value for "boolean" key
@see Toybox::Application::Storage#getValue getValue()
@see Toybox::Background
@see https://developer.garmin.com/connect-iq/core-topics/persisting-data/ Core Topics - Persisting Data
@since 2.4.0
]]> Delete the given key from the object store.
key [Toybox::Application::Storage::KeyType] The key to delete

@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
key is a disallowed data type
@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process on device that does not have
ConnectIQ 3.2.0 support
@see Toybox::Application::Storage#setValue setValue()
@since 2.4.0
]]> Constructor
@since 2.3.0
]]> Get the data associated with a given key from application settings.

Property values must be defined in the application settings xml. If a key
that is not present in application settings is passed to getValue(),
an exception will be thrown.
key [Toybox::Lang::String] The key of the value to retrieve

from Application Properties
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
key is a disallowed data type
@throws [Toybox::Application::Properties::InvalidKeyException] Thrown if
key does not exist in Application Settings
Returns [Toybox::Application::Properties::ValueType] The content associated with the key

@see Toybox::Application::Properties#setValue setValue()
@since 2.4.0
]]> Store the given Application Property.

@note Background processes cannot save Application Properties
key [Toybox::Lang::String] The key used to store and retrieve

the value from Application Properties
value [Toybox::Application::Properties::ValueType] The value to put into Application

Properties
@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process on device that does not have
ConnectIQ 3.2.0 support. Data can always be passed to the foreground
process from a background process with {Toybox::Background#exit Background.exit()}.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
key is a disallowed data type
@throws [Toybox::Application::Properties::InvalidKeyException]
Thrown if key does not exist in Application Properties
@since 2.4.0
]]> Clear the object store for the application.
@note Background processes cannot clear properties.
@throws [Toybox::Application::ObjectStoreAccessException] Thrown if called
from a background process
@see Toybox::Application::Storage
@since 1.0.0
@deprecated This method may be removed after System 4.
@see Toybox::Application::Properties
@see Toybox::Application::Storage
]]> Override to provide the initial View and Input Delegate of the application.

@note This method must be overridden in derived classes. If called, this
function will cause the application to crash.
Returns [Toybox::Lang::Array] An Array containing a

{Toybox::WatchUi::View WatchUi.View} and an optional
{Toybox::WatchUi::BehaviorDelegate WatchUi.BehaviorDelegate},
{Toybox::WatchUi::ConfirmationDelegate WatchUi.ConfirmationDelegate},
{Toybox::WatchUi::InputDelegate WatchUi.InputDelegate},
{Toybox::WatchUi::MenuInputDelegate WatchUi.MenuInputDelegate},
{Toybox::WatchUi::NumberPickerDelegate WatchUi.NumberPickerDelegate},
{Toybox::WatchUi::PickerDelegate WatchUi.PickerDelegate},
{Toybox::WatchUi::TextPickerDelegate WatchUi.TextPickerDelegate}, or
{Toybox::WatchUi::WatchFaceDelegate WatchUi.WatchFaceDelegate}
@since 1.0.0
]]> Check if the application is in trial mode.

This will always return +true+ for development
build apps. If the app has been signed by the store
it will return the current unlock state of the app.
This method should not be overridden or your trial mode functionality
could cease to function correctly.
Returns [Toybox::Lang::Boolean] Return +true+ if the app is "locked"

and considered to be in trial mode, otherwise +false+ if the app
has been unlocked.
@since 2.3.0
]]> Delete the given key from the object store.
@note Background processes cannot delete properties.
key [Toybox::Application::PropertyKeyType] The key to delete

@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process
@see Toybox::Application::Storage
@since 1.0.0
@deprecated This method may be removed after System 4.
@see Toybox::Application::Properties
@see Toybox::Application::Storage
]]> The callback method that is triggered in the background when the app is updated
Requires the Background permission to be enabled and your application class to
carry the :background annotation.
@since 3.0.0
]]> Method called at startup to allow handling of app initialization.

Before the initial {Toybox::WatchUi::View WatchUi.View} is retrieved,
onStart() is called. Application level settings can be initialized or
retrieved from the object store before the initial View is created.
This method must be overridden to handle your own app initialization.
state [Toybox::Lang::Dictionary] Required. If an

{Toybox::System::Intent Intent} is not used to launch the application,
then an empty "state" Dictionary is used. If an Intent is used to
start the application the Dictionary contains the arguments from
the Intent.
@option state [Toybox::Lang::Boolean] :resume If true, indicates
app has been resumed from suspension, restore the previously saved
app state if needed.
@note the suspension state can be cleared in the event of reboot or app update.
@option state [Toybox::Lang::Boolean] :launchedFromGlance If true,
indicates the app is started from glance list as opposed to the
the app list.
@option state [Toybox::Lang::Number] :launchedFromComplication If present,
indicates the complication index the app was launched from.
@option state [Toybox::Lang::Number] :launchedFromPostInstall If present,
indicates the app was launched from a post-install page.
@option state [Toybox::Lang::Boolean] :launchedFromWatchFaceSettingsEditor If +true+
indicates the watchface is started in watchface config mode.
@option state [Toybox::Application::WatchFaceConfig::Id] :configId If present, represents the
desired watch face settings to launch watch face with.
use {Toybox::Application::WatchFaceConfig#getSettings WatchFaceConfig.getSettings()} to fetch
given settings.
@example onStart() used with Intent
function onStart(state) {
if (state != null) {
infoString = "Args:" + state.toString();
}
}
@see Toybox::System::Intent
@since 1.0.0
]]> Save the properties for the application
@since 1.0.0
@deprecated This method may be removed after System 4.
]]> Override to provide the settings View and Input Delegate of the application.

* This function is only applicable to watch faces and data fields.
Returns [Toybox::Lang::Array] An Array containing a

{Toybox::WatchUi::View WatchUi.View} and an optional
{Toybox::WatchUi::BehaviorDelegate WatchUi.BehaviorDelegate},
{Toybox::WatchUi::ConfirmationDelegate WatchUi.ConfirmationDelegate},
{Toybox::WatchUi::InputDelegate WatchUi.InputDelegate},
{Toybox::WatchUi::MenuInputDelegate WatchUi.MenuInputDelegate},
{Toybox::WatchUi::NumberPickerDelegate WatchUi.NumberPickerDelegate},
{Toybox::WatchUi::PickerDelegate WatchUi.PickerDelegate},
{Toybox::WatchUi::TextPickerDelegate WatchUi.TextPickerDelegate}, or
{Toybox::WatchUi::WatchFaceDelegate WatchUi.WatchFaceDelegate}
@since 3.2.0
]]> Called when the application settings have been changed by Garmin
Connect Mobile (GCM) while while the app is running. Override this
method to change app behavior when settings change. This is
typically used to call for an update to the
{Toybox::WatchUi#requestUpdate WatchUi.requestUpdate()}
@example
function onSettingsChanged() { // triggered by settings change in GCM
_mainView.handleSettingUpdate();
WatchUi.requestUpdate(); // update the view to reflect changes
}
@see Toybox::WatchUi#requestUpdate WatchUi.requestUpdate()
details
@since 1.2.0
]]> Called when Application storage is changed by the other running instance,
of the app i.e Background Process while the CIQ app is running or vice-versa.
Override this function to receive a callback when the storage is updated. Use this
function to reload storage data from the application storage.

@since 3.2.0
]]> Called when an Application requests to run code on demand,
during an authentication process.

@since 3.3.0
]]> Load the properties for the application
@since 1.0.0
@deprecated This method may be removed after System 4.
]]> Override to handle application cleanup upon termination.

If the application needs to save data to the object store it should
be done in this function. Once the function is complete, the
application will terminate.
state [Toybox::Lang::Dictionary] Required. If

an {Toybox::System::Intent Intent} is not used to launch an application
on stop of the current application an empty "state" Dictionary is
used. If an Intent is used to start another application, then the
Dictionary contains the arguments from the Intent.
@option state [Toybox::Lang::Boolean] :suspend If true, the app has
been suspended and the current state can be resumed at a later time.
@note the suspension state can be cleared in the event of reboot or app update.
@see Toybox::System::Intent
@since 1.0.0
]]> Check if application trial messages are allowed.

Returns +true+ if the application should allow the product
to push unlock instruction pages for locked apps.
Returns +true+ by default.
@since 2.3.0
Returns [Toybox::Lang::Boolean] Returns +true+ if trial messages

should be shown, otherwise +false+.
]]> Validate a property being stored.

key [Toybox::Application::PropertyKeyType] The key to validate

value [Toybox::Application::PropertyValueType] The value to validate

@since 1.0.0
]]> Get the data associated with a given key from the object store.

Properties must first be set with
{Application::AppBase#setProperty setProperty()} before they are
can be obtained with +getProperty+.
@note Symbols can change from build to build and are not to be used
for for Keys or Values.
key [Toybox::Application::PropertyKeyType] The key of the value to retrieve

from the object store (cannot be a Symbol)
Returns [Toybox::Application::PropertyValueType] The content associated with the key,

or +null+ if the key is not in the object store
@see Toybox::Application::AppBase#setProperty setProperty()
@see Toybox::Background
@see Toybox::Application::Properties
@see Toybox::Application::Storage
@since 1.0.0
@deprecated This method may be removed after System 4.
]]> Override to provide a {Toybox::WatchUi::View WatchUi.View} for a goal that
has triggered within a watch face.

* If a goal is reached when a watch face is running, this function will be triggered.
* The type of goal that was met will be provided, and the AppBase should return a View that displays a goal reached message and/or animations for that goal.
* If a View is returned from this function, the main watch face view will be shutdown, and then new View will pushed.
* If this method is not overridden in the AppBase, or if it returns +null+, the native goal screens will be shown.
goalType [Toybox::Application::GoalType] The goal type that has triggered.

The goalType will be from the GOAL_TYPE_* enumeration.

Returns [Toybox::Lang::Array] An Array containing a {Toybox::WatchUi::View WatchUi.View}

@since 1.3.0
]]> Handle data passed from a ServiceDelegate to the application.

When the {Toybox::Background Background} process terminates, a data
payload may be available. If the main application is active when this
occurs, the data will be passed directly to the application's
+onBackgroundData()+ method. If the main application is not active,
the data will be saved until the next time the application is launched
and will be passed to the application after the
{Toybox::Application::AppBase#onStart onStart()} method completes.
data [Toybox::Lang::Object] The data passed from the

background process.
@see Toybox::Background
@since 2.3.0
]]> Get the icon for the sync page
backgroundColor {Toybox::Lang::Number} a RRGGBB value indicating the

background color of the page the icon is being drawn on
Returns [Toybox::Graphics::BitmapType] An object representing the icon bitmap.

@since 3.1.0
]]> The callback method that is triggered in the background when the app is installed.
Requires the Background permission to be enabled and your application class to
carry the :background annotation.
@since 3.0.0
]]> Get a {Toybox::System::ServiceDelegate ServiceDelegate} to run
background tasks for this app.

When a ServiceDelegate is retrieved, the following will occur:
* The method triggered within the ServiceDelegate will be run
* The background task will exit using {Toybox::Background#exit Background.exit()} or {Toybox::System#exit System.exit()}
* The background task will be automatically terminated after 30 seconds if it is not exited by these methods
Returns [Toybox::Lang::Array] An Array containing a

{Toybox::System::ServiceDelegate System.ServiceDelegate}
@see Toybox::Background
@since 2.3.0
]]> Store the given data in the object.

@note Background processes cannot save properties.
@note Symbols can change from build to build and are not to be used
for for Keys or Values.
key [Toybox::Application::PropertyKeyType] The key used to store and retrieve

the value from the object store (cannot be a Symbol)
value [Toybox::Application::PropertyValueType] The value to put into the object store

@throws [Toybox::Application::ObjectStoreAccessException] Thrown
if called from a background process on device that does not have
ConnectIQ 3.2.0 support. Data can always be passed to the foreground
process from a background process with {Toybox::Background#exit Background.exit()}.
@throws [Toybox::Lang::UnexpectedTypeException] Thrown if
called with a key or value of a disallowed type
@example
using Toybox.Application;
var app = Application.getApp();

app.setProperty("number", 2); // set value for "number" key
app.setProperty("float", 3.14); // set value for "float" key
app.setProperty("string", "Hello World!"); // set value for "string" key
app.setProperty("boolean", true); // set value for "boolean" key

var int = app.getProperty("number"); // get value for "number" key
var float = app.getProperty("float"); // get value for "float" key
var string = app.getProperty("string"); // get value for "string" key
var boolean = app.getProperty("boolean"); // get value for "boolean" key
@see Toybox::Application::AppBase#getProperty getProperty()
@see Toybox::Background
@see https://developer.garmin.com/connect-iq/core-topics/persisting-data/ Core Topics - Persisting Data
@see Toybox::Application::Properties
@see Toybox::Application::Storage
@since 1.0.0
@deprecated This method may be removed after System 4.
]]> Get a {Toybox::Communications::SyncDelegate SyncDelegate} object
that communicates sync status to the system for syncing content
to the device.
Returns [Toybox::Communications::SyncDelegate]

@since 3.1.0
]]> Override to provide the {Toybox::WatchUi::GlanceView WatchUi.GlanceView} and {Toybox::WatchUi::GlanceViewDelegate WatchUi.GlanceViewDelegate} for the glance preview.

Returns [Toybox::Lang::Array] An Array containing a

{Toybox::WatchUi::GlanceView WatchUi.GlanceView} and an optional
{Toybox::WatchUi::GlanceViewDelegate WatchUi.GlanceViewDelegate}. If
this function returns +null+ the app name will be used as preview content.
@since 3.1.0
]]> Override to return the number of days remaining in the trial

If a developer wishes to implement time-based app trials, they
will need to override this function to return the number of days
remaining in the trial. This function will be called on app startup
to determine if a trial is active and push a notice to the user of
how many days remain in the trial. Note that if
{Toybox::Application::AppBase#allowTrialMessage allowTrialMessage()}
is overridden to return +false+, no notifications will be displayed.
Returns [Toybox::Lang::Number] A Number object indicating the number

of days remaining in the trial, or +null+ if no timed trial is active.
@since 2.3.0
]]> Get the current {Toybox::Sensor::SensorInfo SensorInfo} and advance.

Get the current {Toybox::Sensor::SensorInfo SensorInfo} and advance
self to refer to the next.

Returns {Toybox::Sensor::SensorInfo SensorInfo}

@since 3.2.0
]]> Constructor
msg [Toybox::Lang::String] The exception message

@since 2.3.0
]]> @since 1.0.0
]]> Constructor
@since 2.4.0
]]>