![]() |
AlexaClientSDK
1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
Namespaces | |
test | |
Classes | |
class | LocaleHandler |
class | ReportStateHandler |
class | RevokeAuthorizationHandler |
class | SoftwareInfoSender |
class | SoftwareInfoSendRequest |
class | StateReportGenerator |
class | StateReportGeneratorTest |
class | SystemCapabilityProvider |
class | TimeZoneHandler |
class | UserInactivityMonitor |
This class implements a CapabilityAgent that handles the SetEndpoint directive. More... | |
Typedefs | |
using | MockSettingManager = SettingsManager< SettingInterface< bool >, SettingInterface< int >, SettingInterface< std::string > > |
Alias for setting manager configuration. More... | |
Enumerations | |
enum | Index { BOOL, INT, STRING } |
Index used for setting access. More... | |
Functions | |
static const std::string | TAG ("LocaleHandler") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("ReportStateHandler") |
String to identify log entries originating from this file. More... | |
static bool | initializeDataBase (storage::MiscStorageInterface &storage) |
static const std::string | TAG ("StateReportGenerator") |
String to identify log entries originating from this file. More... | |
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration > | getSystemCapabilityConfiguration (const std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface > &localeAssetsManager) |
static const std::string | TAG ("TimeZoneHandler") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("UserInactivityMonitor") |
String to identify log entries originating from this file. More... | |
TEST_F (StateReportGeneratorTest, test_createWithoutSettingManagerShouldFail) | |
TEST_F (StateReportGeneratorTest, test_createWithEmptySettingManagerShouldSucceed) | |
TEST_F (StateReportGeneratorTest, test_createWithFullSettingManagerShouldSucceed) | |
TEST_F (StateReportGeneratorTest, test_generateReportWithFullSettingManager) | |
TEST_F (StateReportGeneratorTest, test_generateReportWithPartialSettingManager) | |
Variables | |
static const std::string | LOCALE_NAMESPACE = "System" |
This string holds the namespace for AVS enpointing. More... | |
static const std::string | SET_LOCALE_DIRECTIVE = "SetLocales" |
This string holds the name of the directive that's being sent for setting the locale. More... | |
static const std::string | LOCALE_REPORT_EVENT = "LocalesReport" |
This string holds the name of the event to report the locale. More... | |
static const std::string | LOCALE_CHANGED_EVENT = "LocalesChanged" |
This string holds the name of the event to change the locale. More... | |
static const std::string | LOCALE_PAYLOAD_KEY = "locales" |
This string holds the key for the locale in the payload. More... | |
static const std::string | REPORT_STATE_NAMESPACE = "System" |
This string holds the namespace for AVS enpointing. More... | |
static const std::string | REPORT_STATE_DIRECTIVE = "ReportState" |
This string holds the name of the directive that's being sent for report states. More... | |
static const std::string | PENDING_REPORT_STATE_KEY = "pendingReportState" |
Key for pending report value. More... | |
static const std::string | REPORT_STATE_COMPONENT_NAME = "ReportStateHandler" |
Component name used to store pending value in the misc storage. More... | |
static const std::string | REPORT_STATE_TABLE = "ReportStateTable" |
The report state table name. More... | |
static const std::string | PENDING_REPORT_VALUE = "true" |
The value we add to the database when a report is pending. More... | |
static const settings::SettingEventMetadata | REPORT_STATE_METADATA |
This structure represents the report state event metadata. More... | |
static const std::string | TAG {"RevokeAuthorizationHandler"} |
String to identify log entries originating from this file. More... | |
static const std::string | REVOKE_NAMESPACE = "System" |
This string holds the namespace for AVS revoke. More... | |
static const std::string | REVOKE_DIRECTIVE_NAME = "RevokeAuthorization" |
This string holds the name of the directive that's being sent for revoking. More... | |
static const std::string | TAG {"SoftwareInfoSender"} |
String to identify log entries originating from this file. More... | |
static const std::string | NAMESPACE_SYSTEM = "System" |
static const NamespaceAndName | REPORT_SOFTWARE_INFO (NAMESPACE_SYSTEM, "ReportSoftwareInfo") |
Namespace, Name pair for System.ReportSoftwareInfo. More... | |
static const std::string | TAG {"SoftwareInfoSendRequest"} |
String to identify log entries originating from this file. More... | |
static const std::string | NAMESPACE_SYSTEM = "System" |
This string holds the "System" namespace. More... | |
static const std::string | NAME_SOFTWARE_INFO = "SoftwareInfo" |
This string holds the name of the "SoftwareInfo" event. More... | |
static const char | FIRMWARE_VERSION_STRING [] = "firmwareVersion" |
JSON value for the firmwareVersion field of the SoftwareInfo event. More... | |
static std::vector< int > | RETRY_TABLE |
Approximate amount of time to wait between retries. More... | |
static avsCommon::utils::RetryTimer | RETRY_TIMER (RETRY_TABLE) |
Object for calculating retry timeout values. More... | |
static const std::string | TAG {"SystemCapabilityProvider"} |
String to identify log entries originating from this file. More... | |
static const std::string | SYSTEM_CAPABILITY_INTERFACE_TYPE = "AlexaInterface" |
static const std::string | SYSTEM_CAPABILITY_INTERFACE_NAME = "System" |
System interface name. More... | |
static const std::string | SYSTEM_CAPABILITY_INTERFACE_VERSION = "2.1" |
System interface version. More... | |
static const std::string | LOCALES_CONFIGURATION_KEY = "locales" |
LOCALES_CONFIGURATION_KEY. More... | |
static const std::string | LOCALE_COMBINATION_CONFIGURATION_KEY = "localeCombinations" |
Locale Combinations Key. More... | |
static const std::string | TIMEZONE_NAMESPACE = "System" |
This string holds the namespace for AVS enpointing. More... | |
static const std::string | SET_TIMEZONE_DIRECTIVE = "SetTimeZone" |
This string holds the name of the directive that's being sent for setting the timezone. More... | |
static const std::string | TIMEZONE_REPORT_EVENT = "TimeZoneReport" |
This string holds the name of the event to report the timezone. More... | |
static const std::string | TIMEZONE_CHANGED_EVENT = "TimeZoneChanged" |
This string holds the name of the event to change the timezone. More... | |
static const std::string | TIMEZONE_PAYLOAD_KEY = "timeZone" |
This string holds the key for the timezone in the payload. More... | |
static const int | SECONDS_IN_HOUR = 3600 |
Number of seconds in one hour. More... | |
static const std::string | USER_INACTIVITY_MONITOR_NAMESPACE = "System" |
String to identify the AVS namespace of the event we send. More... | |
static const std::string | INACTIVITY_EVENT_NAME = "UserInactivityReport" |
String to identify the AVS name of the event we send. More... | |
static const std::string | INACTIVITY_EVENT_PAYLOAD_KEY = "inactiveTimeInSeconds" |
String to identify the key of the payload associated to the inactivity. More... | |
static const std::string | RESET_DIRECTIVE_NAME = "ResetUserInactivity" |
String to identify the AVS name of the directive we receive. More... | |
Mock values and string representantion. | |
constexpr bool | BOOL_SETTING_VALUE = true |
constexpr int | INT_SETTING_VALUE = 10 |
static const std::string | BOOL_SETTING_STRING_VALUE = "true" |
static const std::string | INT_SETTING_STRING_VALUE = "10" |
static const std::string | STRING_SETTING_VALUE = "string" |
static const std::string | STRING_SETTING_STRING_VALUE = R"("string")" |
using alexaClientSDK::capabilityAgents::system::MockSettingManager = typedef SettingsManager<SettingInterface<bool>, SettingInterface<int>, SettingInterface<std::string> > |
Alias for setting manager configuration.
|
static |
Creates the System capability configuration.
localeAssetsManager | The locale assets manager that provides supported locales. |
|
static |
Initialize the storage.
storage | The storage to be initialized. |
true
if it succeeded, false otherwise.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
alexaClientSDK::capabilityAgents::system::TEST_F | ( | StateReportGeneratorTest | , |
test_createWithEmptySettingManagerShouldSucceed | |||
) |
alexaClientSDK::capabilityAgents::system::TEST_F | ( | StateReportGeneratorTest | , |
test_createWithFullSettingManagerShouldSucceed | |||
) |
alexaClientSDK::capabilityAgents::system::TEST_F | ( | StateReportGeneratorTest | , |
test_createWithoutSettingManagerShouldFail | |||
) |
alexaClientSDK::capabilityAgents::system::TEST_F | ( | StateReportGeneratorTest | , |
test_generateReportWithFullSettingManager | |||
) |
alexaClientSDK::capabilityAgents::system::TEST_F | ( | StateReportGeneratorTest | , |
test_generateReportWithPartialSettingManager | |||
) |
|
static |
|
constexpr |
|
static |
JSON value for the firmwareVersion field of the SoftwareInfo event.
|
static |
String to identify the AVS name of the event we send.
|
static |
String to identify the key of the payload associated to the inactivity.
|
static |
|
constexpr |
|
static |
This string holds the name of the event to change the locale.
|
static |
Locale Combinations Key.
|
static |
This string holds the namespace for AVS enpointing.
|
static |
This string holds the key for the locale in the payload.
|
static |
This string holds the name of the event to report the locale.
|
static |
LOCALES_CONFIGURATION_KEY.
|
static |
This string holds the name of the "SoftwareInfo" event.
|
static |
|
static |
This string holds the "System" namespace.
|
static |
Key for pending report value.
|
static |
The value we add to the database when a report is pending.
|
static |
Namespace, Name pair for System.ReportSoftwareInfo.
|
static |
Component name used to store pending value in the misc storage.
|
static |
This string holds the name of the directive that's being sent for report states.
|
static |
This structure represents the report state event metadata.
|
static |
This string holds the namespace for AVS enpointing.
|
static |
The report state table name.
|
static |
String to identify the AVS name of the directive we receive.
|
static |
Approximate amount of time to wait between retries.
|
static |
Object for calculating retry timeout values.
|
static |
This string holds the name of the directive that's being sent for revoking.
|
static |
This string holds the namespace for AVS revoke.
|
static |
Number of seconds in one hour.
|
static |
This string holds the name of the directive that's being sent for setting the locale.
|
static |
This string holds the name of the directive that's being sent for setting the timezone.
|
static |
|
static |
|
static |
System interface name.
|
static |
System capability constants System interface type
|
static |
System interface version.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
This string holds the name of the event to change the timezone.
|
static |
This string holds the namespace for AVS enpointing.
|
static |
This string holds the key for the timezone in the payload.
|
static |
This string holds the name of the event to report the timezone.
|
static |
String to identify the AVS namespace of the event we send.
AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0