AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Macros | Functions | Variables
NotificationsCapabilityAgent.cpp File Reference
#include <rapidjson/error/en.h>
#include <rapidjson/stringbuffer.h>
#include <rapidjson/writer.h>
#include <acsdkNotificationsInterfaces/NotificationsObserverInterface.h>
#include <AVSCommon/AVS/CapabilityConfiguration.h>
#include <AVSCommon/Utils/JSON/JSONUtils.h>
#include <AVSCommon/Utils/Metrics/DataPointCounterBuilder.h>
#include <AVSCommon/Utils/Metrics/MetricEventBuilder.h>
#include <AVSCommon/Utils/Timing/TimeUtils.h>
#include "acsdkNotifications/NotificationsCapabilityAgent.h"
#include "acsdkNotifications/NotificationsNotifier.h"
Include dependency graph for NotificationsCapabilityAgent.cpp:

Namespaces

 alexaClientSDK
 Whether or not curl logs should be emitted.
 
 alexaClientSDK::acsdkNotifications
 

Macros

#define LX(event)   alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)
 

Functions

static const std::string alexaClientSDK::acsdkNotifications::TAG ("NotificationsCapabilityAgent")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< avsCommon::avs::CapabilityConfiguration > alexaClientSDK::acsdkNotifications::getNotificationsCapabilityConfiguration ()
 
static void alexaClientSDK::acsdkNotifications::submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName)
 

Variables

static const std::string alexaClientSDK::acsdkNotifications::NOTIFICATIONS_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string alexaClientSDK::acsdkNotifications::NOTIFICATIONS_CAPABILITY_INTERFACE_NAME = "Notifications"
 Notifications interface name. More...
 
static const std::string alexaClientSDK::acsdkNotifications::NOTIFICATIONS_CAPABILITY_INTERFACE_VERSION = "1.0"
 Notifications interface version. More...
 
static const std::string alexaClientSDK::acsdkNotifications::NAMESPACE = "Notifications"
 The namespace for this capability agent. More...
 
static const std::string alexaClientSDK::acsdkNotifications::NOTIFICATION_METRIC_SOURCE_PREFIX = "NOTIFICATION-"
 Metric Activity Name Prefix for NOTIFICATION metric source. More...
 
static const NamespaceAndName alexaClientSDK::acsdkNotifications::INDICATOR_STATE_CONTEXT_KEY {NAMESPACE, "IndicatorState"}
 The NotificationsCapabilityAgent context state signature. More...
 
static const NamespaceAndName alexaClientSDK::acsdkNotifications::SET_INDICATOR {NAMESPACE, "SetIndicator"}
 The SetIndicator directive signature. More...
 
static const NamespaceAndName alexaClientSDK::acsdkNotifications::CLEAR_INDICATOR {NAMESPACE, "ClearIndicator"}
 The SetIndicator directive signature. More...
 
static const std::string alexaClientSDK::acsdkNotifications::PERSIST_VISUAL_INDICATOR_KEY = "persistVisualIndicator"
 Keys for directive payload values. More...
 
static const std::string alexaClientSDK::acsdkNotifications::PLAY_AUDIO_INDICATOR_KEY = "playAudioIndicator"
 
static const std::string alexaClientSDK::acsdkNotifications::ASSET_KEY = "asset"
 
static const std::string alexaClientSDK::acsdkNotifications::ASSET_ID_KEY = "assetId"
 
static const std::string alexaClientSDK::acsdkNotifications::ASSET_URL_KEY = "url"
 
static const char alexaClientSDK::acsdkNotifications::IS_ENABLED_KEY [] = "isEnabled"
 The key used to provide the "isEnabled" property in the state payload. More...
 
static const char alexaClientSDK::acsdkNotifications::IS_VISUAL_INDICATOR_PERSISTED_KEY [] = "isVisualIndicatorPersisted"
 
static const std::chrono::milliseconds alexaClientSDK::acsdkNotifications::SHUTDOWN_TIMEOUT {500}
 

Macro Definition Documentation

◆ LX

#define LX (   event)    alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)

Create a LogEntry using this file's TAG and the specified event string.

Parameters
Theevent string for this LogEntry.

AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0