Properties API

Interfaces for accessing persistent configuration. More...

Namespaces
	alexaClientSDK::propertiesInterfaces
	Properties API Interfaces and Data Types.

Classes
class	alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface
	Factory interface to component properties. More...
class	alexaClientSDK::propertiesInterfaces::PropertiesInterface
	This class provides an interface to a simple key/value container. More...
class	alexaClientSDK::propertiesInterfaces::test::MockProperties
	Mock class for PropertiesInterface. More...
class	alexaClientSDK::propertiesInterfaces::test::MockPropertiesFactory
	Mock class for PropertiesFactoryInterface. More...
class	alexaClientSDK::propertiesInterfaces::test::StubProperties
	In-memory stub implementation of PropertiesInterface. More...
class	alexaClientSDK::propertiesInterfaces::test::StubPropertiesFactory
	In-memory stub implementation of PropertiesFactoryInterface. More...

Detailed Description

Interfaces for accessing persistent configuration.

Properties API provides interfaces for accessing persistent configuration. The API doesn't mandate how the configuration is stored, but assumes that it can be accessed as a group of containers. A single container can be identified by configuration URI (Uniform ResourceLocator).

Usage Example:

auto properties = propertiesFactory->getProperties("componentName/tableName");
properties->putString("propertyName", "stringValue");

ACSDK provides reference implementation of Properties API to use with MiscStorageInterface and to store properties values in encrypted form. See Properties Implementation for documentation on reference implementation.

See also

Properties Implementation

propertiesInterfaces Namespace

propertiesInterfaces::test Namespace