AlexaClientSDK  1.20.1
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Functions | Variables
alexaClientSDK::capabilityAgents::doNotDisturb Namespace Reference

Namespaces

 test
 

Classes

class  DNDMessageRequest
 
class  DNDSettingProtocol
 
class  DoNotDisturbCapabilityAgent
 

Functions

static const std::string TAG ("DNDMessageRequest")
 String to identify log entries originating from this file. More...
 
static bool parseDirectivePayload (const std::string &payload, Document *document)
 

Variables

static const std::string INVALID_VALUE = ""
 String to designate invalid value for the DND setting. NOTE: Valid values are "true" and "false". More...
 
static const std::string TAG {"DoNotDisturbCapabilityAgent"}
 String to identify log entries originating from this file. More...
 
static const std::string NAMESPACE = "Alexa.DoNotDisturb"
 The Alexa.DoNotDisturb interface namespace. More...
 
static const NamespaceAndName DIRECTIVE_SETDONOTDISTURB {NAMESPACE, "SetDoNotDisturb"}
 The SetDoNotDisturb directive identifier. More...
 
static const NamespaceAndName EVENT_DONOTDISTURBCHANGED {NAMESPACE, "DoNotDisturbChanged"}
 The DoNotDisturbChanged event identifier. More...
 
static const NamespaceAndName EVENT_REPORTDONOTDISTURB {NAMESPACE, "ReportDoNotDisturb"}
 The ReportDoNotDisturb event identifier. More...
 
static const std::string DND_JSON_INTERFACE_TYPE = "AlexaInterface"
 AVS Interface type. More...
 
static const std::string DND_JSON_INTERFACE_NAME = "Alexa.DoNotDisturb"
 AVS Interface name. More...
 
static const std::string DND_JSON_INTERFACE_VERSION = "1.0"
 AVS interface version. More...
 
static constexpr char JSON_KEY_ENABLED [] = "enabled"
 Name for "enabled" JSON branch. More...
 

Function Documentation

◆ parseDirectivePayload()

static bool alexaClientSDK::capabilityAgents::doNotDisturb::parseDirectivePayload ( const std::string &  payload,
Document *  document 
)
static

Parses a directive payload JSON and returns a parsed document object.

Parameters
payloadJSON string to parse.
[out]documentPointer to a parsed document.
Returns
True if parsing was successful, false otherwise.

◆ TAG()

static const std::string alexaClientSDK::capabilityAgents::doNotDisturb::TAG ( "DNDMessageRequest"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ DIRECTIVE_SETDONOTDISTURB

const NamespaceAndName alexaClientSDK::capabilityAgents::doNotDisturb::DIRECTIVE_SETDONOTDISTURB {NAMESPACE, "SetDoNotDisturb"}
static

The SetDoNotDisturb directive identifier.

◆ DND_JSON_INTERFACE_NAME

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::DND_JSON_INTERFACE_NAME = "Alexa.DoNotDisturb"
static

AVS Interface name.

◆ DND_JSON_INTERFACE_TYPE

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::DND_JSON_INTERFACE_TYPE = "AlexaInterface"
static

AVS Interface type.

◆ DND_JSON_INTERFACE_VERSION

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::DND_JSON_INTERFACE_VERSION = "1.0"
static

AVS interface version.

◆ EVENT_DONOTDISTURBCHANGED

const NamespaceAndName alexaClientSDK::capabilityAgents::doNotDisturb::EVENT_DONOTDISTURBCHANGED {NAMESPACE, "DoNotDisturbChanged"}
static

The DoNotDisturbChanged event identifier.

◆ EVENT_REPORTDONOTDISTURB

const NamespaceAndName alexaClientSDK::capabilityAgents::doNotDisturb::EVENT_REPORTDONOTDISTURB {NAMESPACE, "ReportDoNotDisturb"}
static

The ReportDoNotDisturb event identifier.

◆ INVALID_VALUE

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::INVALID_VALUE = ""
static

String to designate invalid value for the DND setting. NOTE: Valid values are "true" and "false".

◆ JSON_KEY_ENABLED

constexpr char alexaClientSDK::capabilityAgents::doNotDisturb::JSON_KEY_ENABLED[] = "enabled"
static

Name for "enabled" JSON branch.

◆ NAMESPACE

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::NAMESPACE = "Alexa.DoNotDisturb"
static

The Alexa.DoNotDisturb interface namespace.

◆ TAG

const std::string alexaClientSDK::capabilityAgents::doNotDisturb::TAG {"DoNotDisturbCapabilityAgent"}
static

String to identify log entries originating from this file.

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