Module: Toybox.Application.Properties

Overview

The Properties module provides access to application properties.

Storage provides access to properties defined in application properties.

Since:

API Level 2.4.0

Classes Under Namespace

Classes: InvalidKeyException

Typedef Summary

• ValueType as Lang.Number or Lang.Float or Lang.Long or Lang.Double or Lang.String or Lang.Boolean or Lang.Array<Properties.ValueType>

Instance Method Summary

• getValue(key as Lang.String) as Properties.ValueType

  Get the data associated with a given key from application settings.

• setValue(key as Lang.String, value as Properties.ValueType) as Void

  Store the given Application Property.

Typedef Details

ValueType as Lang.Number or Lang.Float or Lang.Long or Lang.Double or Lang.String or Lang.Boolean or Lang.Array<Properties.ValueType>

Since:

API Level 2.4.0

Instance Method Details

getValue(key as Lang.String) as Properties.ValueType

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.

Parameters:

• key — (Lang.String) —

  The key of the value to retrieve from Application Properties

Returns:

• Properties.ValueType —

  The content associated with the key

See Also:

• setValue()

Since:

API Level 2.4.0

Throws:

• (Lang.UnexpectedTypeException) —

  Thrown if key is a disallowed data type

• (Properties.InvalidKeyException) —

  Thrown if key does not exist in Application Settings

setValue(key as Lang.String, value as Properties.ValueType) as Void

Store the given Application Property.

Note:

Background processes cannot save Application Properties

Parameters:

• key — (Lang.String) —

  The key used to store and retrieve the value from Application Properties

• value — (Properties.ValueType) —

  The value to put into Application Properties

Since:

API Level 2.4.0

Throws:

• (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 Background.exit().

• (Lang.UnexpectedTypeException) —

  Thrown if key is a disallowed data type

• (Properties.InvalidKeyException) —

  Thrown if key does not exist in Application Properties