alexaClientSDK::properties::MiscStorageUriMapperInterface Class Reference

Interface to map properties config URI into component name and table name. More...

#include <MiscStorageAdapter.h>

Inheritance diagram for alexaClientSDK::properties::MiscStorageUriMapperInterface:

Public Member Functions
virtual	~MiscStorageUriMapperInterface () noexcept=default
	Default destructor. More...
virtual bool	extractComponentAndTableName (const std::string &configUri, std::string &componentName, std::string &tableName) noexcept=0
	Extracts component name and table name from configuration URI. More...

Detailed Description

Interface to map properties config URI into component name and table name.

This interface connects Properties API and MiscStorageInterface.

PropertiesFactoryInterface uses configuration URI to open properties container. When working with MiscStorageInterface this URI must be mapped into componentName and tableName parameters.

See also

Properties API

alexaClientSDK::propertiesInterfaces::PropertiesFactoryInterface

alexaClientSDK::avsCommon::sdkInterfaces::storage::MiscStorageInterface

Constructor & Destructor Documentation

~MiscStorageUriMapperInterface()

virtual alexaClientSDK::properties::MiscStorageUriMapperInterface::~MiscStorageUriMapperInterface ( )

virtualdefaultnoexcept

Default destructor.

Member Function Documentation

extractComponentAndTableName()

virtual bool alexaClientSDK::properties::MiscStorageUriMapperInterface::extractComponentAndTableName ( const std::string &  configUri, std::string &  componentName, std::string &  tableName  )

pure virtualnoexcept

Extracts component name and table name from configuration URI.

This method maps configuration URI from PropertiesFactoryInterface into component name and table name for MiscStorageInterface.

This method must be idempotent, and always return the same result for the same input.

Parameters

[in]	configUri	Configuration URI.
[out]	componentName	Component.
[out]	tableName	Table name.

Returns

True if operation succeeds. If false is returned the state of componentName and tableName is undefined.

Implemented in alexaClientSDK::properties::SimpleMiscStorageUriMapper.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/core/Properties/Properties/include/acsdk/Properties/MiscStorageAdapter.h