AlexaClientSDK  1.20.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
alexaClientSDK::avsCommon::avs Namespace Reference

Namespaces

 attachment
 
 constants
 
 directiveRoutingRule
 
 externalMediaPlayer
 
 initialization
 
 resources
 
 speakerConstants
 
 test
 

Classes

class  AbstractAVSConnectionManager
 
class  AVSContext
 
class  AVSDirective
 
struct  AVSDiscoveryEndpointAttributes
 
class  AVSMessage
 
struct  AVSMessageEndpoint
 
class  AVSMessageHeader
 
class  BlockingPolicy
 
class  CapabilityAgent
 
struct  CapabilityConfiguration
 
class  CapabilityResources
 
struct  CapabilityState
 
struct  CapabilityTag
 
struct  ComponentConfiguration
 
class  DialogUXStateAggregator
 
class  ExceptionEncounteredSender
 
class  HandlerAndPolicy
 
class  MessageRequest
 
class  NamespaceAndName
 
struct  PlayRequestor
 
class  WaitableMessageRequest
 

Typedefs

using AudioInputStream = utils::sds::SharedDataStream< utils::sds::InProcessSDSTraits >
 The type used store and stream binary data. More...
 
using DirectiveHandlerConfiguration = std::unordered_map< directiveRoutingRule::DirectiveRoutingRule, BlockingPolicy >
 

Enumerations

enum  AlexaResponseType {
  AlexaResponseType::SUCCESS, AlexaResponseType::ALREADY_IN_OPERATION, AlexaResponseType::BRIDGE_UNREACHABLE, AlexaResponseType::ENDPOINT_BUSY,
  AlexaResponseType::ENDPOINT_LOW_POWER, AlexaResponseType::ENDPOINT_UNREACHABLE, AlexaResponseType::FIRMWARE_OUT_OF_DATE, AlexaResponseType::HARDWARE_MALFUNCTION,
  AlexaResponseType::INSUFFICIENT_PERMISSIONS, AlexaResponseType::INTERNAL_ERROR, AlexaResponseType::INVALID_VALUE, AlexaResponseType::NOT_CALIBRATED,
  AlexaResponseType::NOT_SUPPORTED_IN_CURRENT_MODE, AlexaResponseType::NOT_IN_OPERATION, AlexaResponseType::POWER_LEVEL_NOT_SUPPORTED, AlexaResponseType::RATE_LIMIT_EXCEEDED,
  AlexaResponseType::TEMPERATURE_VALUE_OUT_OF_RANGE, AlexaResponseType::VALUE_OUT_OF_RANGE
}
 
enum  ContentType { ContentType::MIXABLE, ContentType::NONMIXABLE, ContentType::UNDEFINED, ContentType::NUM_CONTENT_TYPE }
 
enum  ExceptionErrorType { ExceptionErrorType::UNEXPECTED_INFORMATION_RECEIVED, ExceptionErrorType::UNSUPPORTED_OPERATION, ExceptionErrorType::INTERNAL_ERROR }
 
enum  FocusState { FocusState::FOREGROUND, FocusState::BACKGROUND, FocusState::NONE }
 
enum  IndicatorState { IndicatorState::OFF = 0, IndicatorState::ON = 1, IndicatorState::UNDEFINED }
 
enum  MixingBehavior {
  MixingBehavior::PRIMARY, MixingBehavior::MAY_DUCK, MixingBehavior::MUST_PAUSE, MixingBehavior::MUST_STOP,
  MixingBehavior::UNDEFINED
}
 
enum  PlaybackButton {
  PlaybackButton::PLAY, PlaybackButton::PAUSE, PlaybackButton::NEXT, PlaybackButton::PREVIOUS,
  PlaybackButton::SKIP_FORWARD, PlaybackButton::SKIP_BACKWARD
}
 Enumeration class for supported playback buttons. More...
 
enum  PlaybackToggle {
  PlaybackToggle::SHUFFLE, PlaybackToggle::LOOP, PlaybackToggle::REPEAT, PlaybackToggle::THUMBS_UP,
  PlaybackToggle::THUMBS_DOWN
}
 
enum  PlayBehavior { PlayBehavior::REPLACE_ALL, PlayBehavior::ENQUEUE, PlayBehavior::REPLACE_ENQUEUED }
 Used to determine how a client must handle queueing and playback of a stream. More...
 
enum  PlayerActivity {
  PlayerActivity::IDLE, PlayerActivity::PLAYING, PlayerActivity::STOPPED, PlayerActivity::PAUSED,
  PlayerActivity::BUFFER_UNDERRUN, PlayerActivity::FINISHED
}
 Identifies the player state. More...
 
enum  Requester { Requester::CLOUD, Requester::DEVICE }
 An enum class indicating whether an operation originated from a Device or Cloud (AVS). More...
 
enum  StateRefreshPolicy { StateRefreshPolicy::NEVER, StateRefreshPolicy::ALWAYS, StateRefreshPolicy::SOMETIMES }
 

Functions

std::ostream & operator<< (std::ostream &stream, AlexaResponseType responseType)
 
std::string avsDirectiveParseStatusToString (AVSDirective::ParseStatus status)
 
std::ostream & operator<< (std::ostream &stream, const AVSDirective::ParseStatus &status)
 
std::ostream & operator<< (std::ostream &stream, const BlockingPolicy &policy)
 
bool operator== (const BlockingPolicy &lhs, const BlockingPolicy &rhs)
 
bool operator!= (const BlockingPolicy &lhs, const BlockingPolicy &rhs)
 
bool operator== (const CapabilityConfiguration::Properties &lhs, const CapabilityConfiguration::Properties &rhs)
 
bool operator!= (const CapabilityConfiguration::Properties &lhs, const CapabilityConfiguration::Properties &rhs)
 
bool operator== (const CapabilityConfiguration &lhs, const CapabilityConfiguration &rhs)
 
bool operator!= (const CapabilityConfiguration &lhs, const CapabilityConfiguration &rhs)
 
bool operator== (const std::shared_ptr< CapabilityConfiguration > &lhs, const std::shared_ptr< CapabilityConfiguration > &rhs)
 
bool operator!= (const std::shared_ptr< CapabilityConfiguration > &lhs, const std::shared_ptr< CapabilityConfiguration > &rhs)
 
std::ostream & operator<< (std::ostream &stream, const CapabilityTag &identifier)
 
bool operator== (const ComponentConfiguration &lhs, const ComponentConfiguration &rhs)
 
bool operator!= (const ComponentConfiguration &lhs, const ComponentConfiguration &rhs)
 
bool operator== (const std::shared_ptr< ComponentConfiguration > lhs, const std::shared_ptr< ComponentConfiguration > rhs)
 
bool operator!= (const std::shared_ptr< ComponentConfiguration > lhs, const std::shared_ptr< ComponentConfiguration > rhs)
 
std::string contentTypeToString (ContentType contentType)
 
std::ostream & operator<< (std::ostream &stream, const ContentType &contentType)
 
const std::pair< std::string, std::string > buildJsonEventString (const std::string &nameSpace, const std::string &eventName, const std::string &dialogRequestIdValue="", const std::string &jsonPayloadValue="{}", const std::string &jsonContext="")
 
std::string buildJsonEventString (const AVSMessageHeader &eventHeader, const utils::Optional< AVSMessageEndpoint > &endpoint=utils::Optional< AVSMessageEndpoint >(), const std::string &jsonPayloadValue="{}", const utils::Optional< AVSContext > &context=utils::Optional< AVSContext >())
 
std::ostream & operator<< (std::ostream &stream, ExceptionErrorType type)
 
std::string focusStateToString (FocusState state)
 
std::ostream & operator<< (std::ostream &stream, const FocusState &state)
 
bool operator== (const HandlerAndPolicy &lhs, const HandlerAndPolicy &rhs)
 
bool operator!= (const HandlerAndPolicy &lhs, const HandlerAndPolicy &rhs)
 
int indicatorStateToInt (IndicatorState state)
 
IndicatorState intToIndicatorState (int stateNum)
 
std::ostream & operator<< (std::ostream &stream, IndicatorState state)
 
std::string mixingBehaviorToString (MixingBehavior behavior)
 
MixingBehavior getMixingBehavior (const std::string &input)
 
std::ostream & operator<< (std::ostream &stream, const MixingBehavior &behavior)
 
std::string PlaybackButtonToString (PlaybackButton button)
 
std::string PlaybackToggleToString (PlaybackToggle toggle)
 
std::ostream & operator<< (std::ostream &stream, const PlaybackButton &button)
 
std::ostream & operator<< (std::ostream &stream, const PlaybackToggle &toggle)
 
std::string playBehaviorToString (PlayBehavior playBehavior)
 
bool stringToPlayBehavior (const std::string &text, PlayBehavior *playBehavior)
 
std::ostream & operator<< (std::ostream &stream, const PlayBehavior &playBehavior)
 
bool convertToValue (const rapidjson::Value &documentNode, PlayBehavior *playBehavior)
 
std::string playerActivityToString (PlayerActivity playerActivity)
 
std::ostream & operator<< (std::ostream &stream, const PlayerActivity &playerActivity)
 
std::istream & operator>> (std::istream &is, PlayerActivity &value)
 
bool operator== (const PlayRequestor &playRequestorA, const PlayRequestor &playRequestorB)
 
std::string requesterToString (Requester requester)
 
std::ostream & operator<< (std::ostream &stream, Requester requester)
 
static const std::string TAG ("AbstractAVSConnectionManager")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("AVSContext")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("AvsDirective")
 String to identify log entries originating from this file. More...
 
static bool parseDocument (const std::string &unparsedDirective, Document *document)
 
static std::shared_ptr< AVSMessageHeaderparseHeader (const Document &document, AVSDirective::ParseStatus *parseStatus)
 
static std::string parsePayload (const Document &document, AVSDirective::ParseStatus *parseStatus)
 
static utils::Optional< AVSMessageEndpointparseEndpoint (const Document &document)
 
static const std::string TAG ("BlockingPolicy")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("CapabilityAgent")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("CapabilityResources")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("ComponentConfiguration")
 String to identify log entries originating from this file. More...
 
static bool isValidConfiguration (std::string name, std::string version)
 
static const std::string TAG ("DialogUXStateAggregator")
 String to identify log entries originating from this file. More...
 
static void submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName)
 
static const std::string TAG ("EventBuilder")
 String to identify log entries originating from this file. More...
 
static std::string buildHeader (const std::string &nameSpace, const std::string &eventName, const std::string &dialogRequestIdValue, json::JsonGenerator &jsonGenerator)
 
static void addJsonObjectFromMap (const std::string &name, const std::map< std::string, std::string > &map, json::JsonGenerator &jsonGenerator)
 
static void addEndpointToJson (const AVSMessageEndpoint &endpoint, json::JsonGenerator &jsonGenerator)
 
static const std::string TAG ("ExceptionEncountered")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("MessageRequest")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("WaitableMessageRequest")
 String to identify log entries originating from this file. More...
 

Variables

static const std::string CAPABILITY_INTERFACE_TYPE_KEY = "type"
 Key for interface type in the CapabilityConfiguration map. More...
 
static const std::string CAPABILITY_INTERFACE_NAME_KEY = "interface"
 Key for interface name in the CapabilityConfiguration map. More...
 
static const std::string CAPABILITY_INTERFACE_VERSION_KEY = "version"
 Key for interface version in the CapabilityConfiguration map. More...
 
static const std::string CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations"
 Key for interface configurations in the CapabilityConfiguration map. More...
 
static const std::string PROPERTIES_KEY_STRING = "properties"
 Key used to identify the context properties. More...
 
static const std::string INSTANCE_KEY_STRING = "instance"
 Key used to identify an instance. More...
 
static const std::string VALUE_KEY_STRING = "value"
 Key used to identify the state value. More...
 
static const std::string TIME_OF_SAMPLE_KEY_STRING = "timeOfSample"
 Key used to identify the time of sample. More...
 
static const std::string UNCERTAINTY_KEY_STRING = "uncertaintyInMilliseconds"
 
static const std::string JSON_MESSAGE_DIRECTIVE_KEY = "directive"
 JSON key to get the directive object of a message. More...
 
static const std::string JSON_MESSAGE_HEADER_KEY = "header"
 JSON key to get the header object of a message. More...
 
static const std::string JSON_MESSAGE_NAMESPACE_KEY = "namespace"
 JSON key to get the namespace value of a header. More...
 
static const std::string JSON_MESSAGE_NAME_KEY = "name"
 JSON key to get the name value of a header. More...
 
static const std::string JSON_MESSAGE_ID_KEY = "messageId"
 JSON key to get the messageId value of a header. More...
 
static const std::string JSON_MESSAGE_DIALOG_REQUEST_ID_KEY = "dialogRequestId"
 JSON key to get the dialogRequestId value of a header. More...
 
static const std::string JSON_MESSAGE_PAYLOAD_KEY = "payload"
 JSON key to get the payload object of a message. More...
 
static const std::string JSON_MESSAGE_INSTANCE_KEY = "instance"
 JSON key to get the optional instance object of a message. More...
 
static const std::string JSON_MESSAGE_PAYLOAD_VERSION_KEY = "payloadVersion"
 JSON key to get the payload version object of a message. More...
 
static const std::string JSON_CORRELATION_TOKEN_KEY = "correlationToken"
 JSON key to get the correlationToken value of a header. More...
 
static const std::string JSON_EVENT_CORRELATION_TOKEN_KEY = "eventCorrelationToken"
 JSON key to get the eventCorrelationToken value of the header. More...
 
static const std::string JSON_ENDPOINT_KEY = "endpoint"
 JSON key to get the endpoint object of a message. More...
 
static const std::string JSON_ENDPOINT_ID_KEY = "endpointId"
 JSON key to get the endpointId value of the endpoint. More...
 
static const std::string JSON_ENDPOINT_COOKIE_KEY = "cookie"
 JSON key to get the cookie value for the endpoint. More...
 
static const std::string MESSAGE_ID_KEY_STRING = "messageId"
 The message id key in the header of the event. More...
 
static const std::string DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId"
 The dialog request Id key in the header of the event. More...
 
static const std::string EVENT_CORRELATION_KEY_STRING = "eventCorrelationToken"
 The event correlation token key. More...
 
static const std::string CORRELATION_TOKEN_KEY_STRING = "correlationToken"
 The correlation token key. More...
 
static const std::string PAYLOAD_VERSION_KEY_STRING = "payloadVersion"
 The payload version key. More...
 
static const std::string INSTANCE_KEY_STRING = "instance"
 The instance key. More...
 
static const long MEDIUM_FLAG_AUDIO = 1
 Flag indicating AUDIO medium is used. More...
 
static const long MEDIUM_FLAG_VISUAL = 2
 Flag indicating VISUAL medium is used. More...
 
static const int CAPABILITY_QUEUE_WARN_SIZE = 10
 Maximum number of directives that Can be Queued before we emit warning logs. More...
 
static constexpr size_t MAX_FRIENDLY_NAME_LENGTH = 16000
 Maximum length of the friendly name. More...
 
static const std::chrono::milliseconds SHORT_TIMEOUT {200}
 
static const std::string CUSTOM_METRIC_PREFIX = "CUSTOM-"
 Custom Metrics prefix used by DialogUXStateAggregator. More...
 
static const std::string LISTENING_TIMEOUT_EXPIRES = "LISTENING_TIMEOUT_EXPIRES"
 error metric for Listening timeout expires More...
 
static const std::string THINKING_TIMEOUT_EXPIRES = "THINKING_TIMEOUT_EXPIRES"
 error metric for Thinking timeout expires More...
 
static const std::string CONTEXT_KEY_STRING = "context"
 The context key in the event. More...
 
static const std::string COOKIE_KEY_STRING = "cookie"
 The cookie key. More...
 
static const std::string DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId"
 The dialog request Id key in the header of the event. More...
 
static const std::string ENDPOINT_KEY_STRING = "endpoint"
 The endpoint key. More...
 
static const std::string ENDPOINT_ID_KEY_STRING = "endpointId"
 The endpointId key. More...
 
static const std::string EVENT_KEY_STRING = "event"
 The event key. More...
 
static const std::string INSTANCE_KEY_STRING = "instance"
 The instance key. More...
 
static const std::string MESSAGE_KEY_STRING = "message"
 The message key in the event. More...
 
static const std::string MESSAGE_ID_KEY_STRING = "messageId"
 The message id key in the header of the event. More...
 
static const std::string SCOPE_KEY_STRING = "scope"
 The scope key. More...
 
static const std::string SCOPE_TYPE_KEY_STRING = "type"
 The scope type. More...
 
static const std::string SCOPE_TOKEN_KEY_STRING = "token"
 The scope token. More...
 
static const std::string SCOPE_PARTITION_KEY_STRING = "partition"
 The scope partition. More...
 
static const std::string SCOPE_USER_ID_KEY_STRING = "userId"
 The scope user id. More...
 
static const std::string BEARER_TOKEN_TYPE = "BearerToken"
 The bearer token type. More...
 
static const std::string BEARER_TOKEN_WITH_PARTITION_TYPE = "BearerTokenWithPartition"
 The bearer token with partition type. More...
 
static const std::string TYPE_KEY_STRING = "type"
 The type key in the event. More...
 
static const std::string NAMESPACE = "System"
 The namespace for this event. More...
 
static const std::string EXCEPTION_ENCOUNTERED_EVENT_NAME = "ExceptionEncountered"
 JSON value for a ExceptionEncountered event's name. More...
 
static const char UNPARSED_DIRECTIVE_KEY_STRING [] = "unparsedDirective"
 JSON key for the unparsedDirective field of the ExceptionEncountered event. More...
 
static const char ERROR_KEY [] = "error"
 JSON key for the error field of the ExceptionEncountered event. More...
 
static const char ERROR_TYPE_KEY [] = "type"
 JSON key for the ExceptionEncountered event's error type. More...
 
static const char ERROR_MESSAGE_KEY [] = "message"
 JSON key for the ExceptionEncountered event's error message. More...
 
static const auto CONNECTION_TIMEOUT = std::chrono::seconds(15)
 The connection timeout indicating how long to wait for the response to be received. More...
 

Typedef Documentation

◆ AudioInputStream

The type used store and stream binary data.

◆ DirectiveHandlerConfiguration

Map of blocking policies per DirectiveRoutingRule. This is used by a DirectiveHandlerInterface to declare which directives it can handle.

Enumeration Type Documentation

◆ AlexaResponseType

An enum class indicating possible response from the endpoint on a controller API call. Response are derived from

See also
https://developer.amazon.com/docs/alexa/device-apis/alexa-errorresponse.html
Enumerator
SUCCESS 

Success.

ALREADY_IN_OPERATION 

Endpoint already in operation.

BRIDGE_UNREACHABLE 

The bridge is unreachable or offline.

ENDPOINT_BUSY 

The endpoint was busy and could not perform the requested operation.

ENDPOINT_LOW_POWER 

The endpoint could not perform the requested operation as its battery was low.

ENDPOINT_UNREACHABLE 

The endpoint is unreachable or offline.

FIRMWARE_OUT_OF_DATE 

The endpoint was busy and could not perform because its firmware is out of date.

HARDWARE_MALFUNCTION 

The endpoint was busy and could not perform because it has experienced a hardware malfunction.

INSUFFICIENT_PERMISSIONS 

The caller does not have the permission to perform specified operation on endpoint.

INTERNAL_ERROR 

An error occurred that can't be described by one of the other error types.

INVALID_VALUE 

Invalid value or unsupported value passed.

NOT_CALIBRATED 

The endpoint can't handle the requested operation because it is in a calibration phase, such as warming up.

NOT_SUPPORTED_IN_CURRENT_MODE 

The endpoint can't be set to the specified value because of its current mode of operation.

NOT_IN_OPERATION 

The endpoint is not in operation.

POWER_LEVEL_NOT_SUPPORTED 
RATE_LIMIT_EXCEEDED 

The maximum rate at which an endpoint or bridge can handle the requests has been exceeded.

TEMPERATURE_VALUE_OUT_OF_RANGE 

The endpoint can't be set to the specified value because it's outside the acceptable temperature range.

VALUE_OUT_OF_RANGE 

The endpoint can't be set to the specified value because it's outside the acceptable range.

◆ ContentType

Enumerator
MIXABLE 

Indicates that the corresponding Activity is mixable with other channels Such Activities may duck upon receiving FocusState::BACKGROUND focus

NONMIXABLE 

Indicates that the corresponding Activity is not mixable with other channels Such Activities must pause upon receiving FocusState::BACKGROUND focus

UNDEFINED 

Indicates that the corresponding ContentType was undefined/unitialized.

NUM_CONTENT_TYPE 

Indicates the Number of ContentType enumerations.

◆ ExceptionErrorType

Enumerator
UNEXPECTED_INFORMATION_RECEIVED 

The directive sent to your client was malformed or the payload does not conform to the directive specification.

UNSUPPORTED_OPERATION 

The operation specified by the namespace/name in the directive's header are not supported by the client.

INTERNAL_ERROR 

An error occurred while the device was handling the directive and the error does not fall into the specified categories.

◆ FocusState

An enum class used to specify the levels of focus that a Channel can have.

Enumerator
FOREGROUND 

Represents the highest focus a Channel can have.

BACKGROUND 

Represents the intermediate level focus a Channel can have.

NONE 

This focus is used to represent when a Channel is not being used or when an observer should stop.

◆ IndicatorState

An enum class used to represent the state of the notification indicator.

Note
These values shouldn't be changed before evaluating the effect a change will have on existing databases.
Enumerator
OFF 
ON 
UNDEFINED 

◆ MixingBehavior

Enumerator
PRIMARY 

Indicates that the corresponding Activity is the primary Activity on the AFML Channel.

MAY_DUCK 

Indicates that the corresponding Activity may duck If ducking is not possible, the Activity must pause instead

MUST_PAUSE 

Indicates that the corresponding Activity must pause.

MUST_STOP 

Indicates that the corresponding Activity must stop.

UNDEFINED 

Indicates that the corresponding Activity may adopt any one of the above behaviors.

◆ PlaybackButton

Enumeration class for supported playback buttons.

Enumerator
PLAY 

Playback Controller 'Play' button.

PAUSE 

Playback Controller 'Pause' button.

NEXT 

Playback Controller 'Next' button.

PREVIOUS 

Playback Controller 'Previous' button.

SKIP_FORWARD 
SKIP_BACKWARD 

◆ PlaybackToggle

Enumerator
SHUFFLE 
LOOP 
REPEAT 
THUMBS_UP 
THUMBS_DOWN 

◆ PlayBehavior

Used to determine how a client must handle queueing and playback of a stream.

Enumerator
REPLACE_ALL 

Immediately begin playback of the stream returned with the Play directive, and replace current and enqueued streams.

ENQUEUE 

Adds a stream to the end of the current queue.

REPLACE_ENQUEUED 

Replace all streams in the queue. This does not impact the currently playing stream.

◆ PlayerActivity

Identifies the player state.

Enumerator
IDLE 

Initial state, prior to acting on the first Play directive.

PLAYING 

Indicates that audio is currently playing.

STOPPED 

Indicates that audio playback was stopped due to an error or a directive which stops or replaces the current stream.

PAUSED 

Indicates that the audio stream has been paused.

BUFFER_UNDERRUN 

Indicates that a buffer underrun has occurred and the stream is buffering.

FINISHED 

Indicates that playback has finished.

◆ Requester

An enum class indicating whether an operation originated from a Device or Cloud (AVS).

Enumerator
CLOUD 

The request came from AVS as a result of a directive.

DEVICE 

The request came from the device. Can be from either the AVS device or a connected device.

◆ StateRefreshPolicy

An enum class used to specify the refresh policy for the state information provided by a stateProviderInterface. The stateProviderInterface must specify the refresh policy when it updates its state via setState.

Note: When a stateProviderInterface provides an empty state, the behavior is as follows:

  • For StateRefreshPolicy ALWAYS and NEVER, the empty state is included in the context.
  • For StateRefreshPolicy SOMETIMES, the empty state is NOT included in the context.
Enumerator
NEVER 

Indicates to the ContextManager that the state information need not be updated on a getContext request. The stateProviderInterface is responsible for updating its state manually.

ALWAYS 

Indicates to the ContextManager that the stateProvider needs to be queried and the state refreshed every time it processes a getContext request.

SOMETIMES 

Indicates to the ContextManager that the stateProvider needs to be queried and the state refreshed every time it processes a getContext request. The stateProvider may choose to not report context by supplying an empty jsonState via setState.

Function Documentation

◆ addEndpointToJson()

static void alexaClientSDK::avsCommon::avs::addEndpointToJson ( const AVSMessageEndpoint endpoint,
json::JsonGenerator jsonGenerator 
)
static

Adds a json object representing the endpoint.

Parameters
endpointThe endpoint to be encoded as a json object.
jsonGeneratorThe json generator being used to generate the json object.

◆ addJsonObjectFromMap()

static void alexaClientSDK::avsCommon::avs::addJsonObjectFromMap ( const std::string &  name,
const std::map< std::string, std::string > &  map,
json::JsonGenerator jsonGenerator 
)
static

Add a json object from a map with the given name.

Parameters
nameThe name of the object.
mapThe key, value pairs to add.
jsonGeneratorThe json generator being used to generate the json object.

◆ avsDirectiveParseStatusToString()

std::string alexaClientSDK::avsCommon::avs::avsDirectiveParseStatusToString ( AVSDirective::ParseStatus  status)
inline

This function converts the provided ParseStatus to a string.

Parameters
statusThe ParseStatus to convert to a string.
Returns
The string conversion of the ParseStatus.

◆ buildHeader()

static std::string alexaClientSDK::avsCommon::avs::buildHeader ( const std::string &  nameSpace,
const std::string &  eventName,
const std::string &  dialogRequestIdValue,
json::JsonGenerator jsonGenerator 
)
static

Builds a JSON header object. The header includes the namespace, name, message Id and an optional dialogRequestId. The message Id required for the header is a random string that is generated and added to the header.

Parameters
nameSpaceThe namespace of the event to be included in the header.
eventNameThe name of the event to be included in the header.
dialogRequestIdValueThe value associated with the "dialogRequestId" key.
jsonGeneratorThe generator that will be populated with the header json.
Returns
The generated messageId of the header.

◆ buildJsonEventString() [1/2]

const std::pair< std::string, std::string > alexaClientSDK::avsCommon::avs::buildJsonEventString ( const std::string &  nameSpace,
const std::string &  eventName,
const std::string &  dialogRequestIdValue = "",
const std::string &  jsonPayloadValue = "{}",
const std::string &  jsonContext = "" 
)

Builds a JSON event string which includes the header, the payload and an optional context. The header includes the namespace, name, message Id and an optional dialogRequestId. The message Id required for the header is a random string that is generated and added to the header.

Deprecated:
This method is being deprecated in favor of the method with Endpoint information.
Parameters
nameSpaceThe namespace of the event to be include in the header.
eventNameThe name of the event to be include in the header.
dialogRequestIdStringOptional value associated with the "dialogRequestId" key.
payloadOptional payload value associated with the "payload" key.
contextOptional context to be sent with the event message.
Returns
A pair object consisting of the messageId and the event JSON string if successful, else a pair of empty strings.

◆ buildJsonEventString() [2/2]

std::string alexaClientSDK::avsCommon::avs::buildJsonEventString ( const AVSMessageHeader eventHeader,
const utils::Optional< AVSMessageEndpoint > &  endpoint = utils::Optional<AVSMessageEndpoint>(),
const std::string &  jsonPayloadValue = "{}",
const utils::Optional< AVSContext > &  context = utils::Optional<AVSContext>() 
)

Builds a JSON event string which includes the header, the payload and an optional context. The header includes the namespace, name, message Id and an optional dialogRequestId. The message Id required for the header is a random string that is generated and added to the header.

Parameters
eventHeaderThe event's AVSMessageHeader.
endpointThe endpoint which was the source of this event.
payloadThe payload value associated with the "payload" key. The value must be a stringified json.
contextOptional AVSContext to be sent with the event message.
Returns
The event JSON string if successful, else an empty string.

◆ contentTypeToString()

std::string alexaClientSDK::avsCommon::avs::contentTypeToString ( ContentType  contentType)
inline

This function converts the provided ContentType to a string.

Parameters
contentTypeThe ContentType to convert to a string.
Returns
The string conversion of contentType.

◆ convertToValue()

bool alexaClientSDK::avsCommon::avs::convertToValue ( const rapidjson::Value &  documentNode,
PlayBehavior playBehavior 
)
inline

Convert a PlayBehavior to a rapidjson::Value.

Parameters
documentNodeThe rapidjson::Value to write to.
playBehaviorThe PlayBehavior to convert.
Returns
true if conversion is successful, else false.

◆ focusStateToString()

std::string alexaClientSDK::avsCommon::avs::focusStateToString ( FocusState  state)
inline

This function converts the provided FocusState to a string.

Parameters
stateThe FocusState to convert to a string.
Returns
The string conversion of state.

◆ getMixingBehavior()

MixingBehavior alexaClientSDK::avsCommon::avs::getMixingBehavior ( const std::string &  input)
inline

This function reverse maps the provided string to corresponding MixingBehavior Implementation as specified by mixingBehaviorToString

Parameters
inputstring to convert to corresponding MixingBehavior
Returns
MixingBehavior that corresponds to the input string. In case of error the API returns MixingBehavior::UNDEFINED

◆ indicatorStateToInt()

int alexaClientSDK::avsCommon::avs::indicatorStateToInt ( IndicatorState  state)
inline

Convert an IndicatorState to an int.

Parameters
stateThe IndicatorState to convert.
Returns
The int representation of state

◆ intToIndicatorState()

IndicatorState alexaClientSDK::avsCommon::avs::intToIndicatorState ( int  stateNum)
inline

Convert an int into an IndicatorState.

Parameters
stateNumThe int to convert.
Returns
The IndicatorState representation of stateNum or nullptr if stateNum is invalid.

◆ isValidConfiguration()

static bool alexaClientSDK::avsCommon::avs::isValidConfiguration ( std::string  name,
std::string  version 
)
static

Helper Function to determine if a configuration is valid

Parameters
nameThe name of the configuration
versionThe version of the configuration
Returns
Bool indicated if configuration is valid. True if valid, false if invalid.

◆ mixingBehaviorToString()

std::string alexaClientSDK::avsCommon::avs::mixingBehaviorToString ( MixingBehavior  behavior)
inline

This function converts the provided MixingBehavior to a string.

Parameters
behaviorThe MixingBehavior to convert to a string.
Returns
The string conversion of behavior.

◆ operator!=() [1/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const ComponentConfiguration lhs,
const ComponentConfiguration rhs 
)

Operator != for ComponentConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [2/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const HandlerAndPolicy lhs,
const HandlerAndPolicy rhs 
)

!= operator.

Parameters
lhsThe HandlerAndPolicy instance on the left hand side of the == operation.
rhsThe HandlerAndPolicy instance on the right hand side of the != operation.
Returns
Whether the lhs instance is NOT equal to the rhs instance.

◆ operator!=() [3/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const std::shared_ptr< ComponentConfiguration lhs,
const std::shared_ptr< ComponentConfiguration rhs 
)

Operator != for shared_ptr of ComponentConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [4/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const CapabilityConfiguration::Properties lhs,
const CapabilityConfiguration::Properties rhs 
)

Operator != for CapabilityConfiguration::Properties

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [5/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const BlockingPolicy lhs,
const BlockingPolicy rhs 
)

Not Equal-to operator comparing two BlockingPolicys *

Parameters
lhsThe left side argument.
rhsThe right side argument.
Returns
true if lhs and rhs are not equal

◆ operator!=() [6/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const CapabilityConfiguration lhs,
const CapabilityConfiguration rhs 
)

Operator != for CapabilityConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [7/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const std::shared_ptr< CapabilityConfiguration > &  lhs,
const std::shared_ptr< CapabilityConfiguration > &  rhs 
)

Operator != for std::shared_ptr<CapabilityConfiguration>

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator<<() [1/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
ExceptionErrorType  type 
)
inline

◆ operator<<() [2/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
Requester  requester 
)
inline

Write a Requester value to an ostream as a string.

Parameters
streamThe stream to write the value to.
requesterThe Requester value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [3/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
IndicatorState  state 
)
inline

◆ operator<<() [4/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const FocusState state 
)
inline

Write a FocusState value to an ostream as a string.

Parameters
streamThe stream to write the value to.
stateThe FocusState value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [5/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const ContentType contentType 
)
inline

Write a ContentType value to an ostream as a string.

Parameters
streamThe stream to write the value to.
contenTypeThe ContentType value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [6/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlayerActivity playerActivity 
)
inline

Write a PlayerActivity value to an ostream.

Parameters
streamThe stream to write the value to.
playerActivityThe PlayerActivity value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [7/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const CapabilityTag identifier 
)
inline

Write a CapabilityMessageIdentifier value to an ostream as a string.

Parameters
streamThe stream to write the value to.
identifierThe CapabilityMessageIdentifier value to be written.
Returns
The ostream that was passed in and written to.

◆ operator<<() [8/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlayBehavior playBehavior 
)
inline

Write a PlayBehavior value to an ostream.

Parameters
streamThe stream to write the value to.
playBehaviorThe PlayBehavior value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [9/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
AlexaResponseType  responseType 
)
inline

Insertion operator.

Parameters
streamThe std::ostream we are inserting into.
responseTypeThe AlexaResponseType whose name to insert into the stream.
Returns
The stream with the name inserted on success, "Unknown AlexaResponseType" on failure.

◆ operator<<() [10/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const MixingBehavior behavior 
)
inline

Write a MixingBehavior value to an ostream as a string.

Parameters
streamThe stream to write the value to.
behaviorThe MixingBehavior value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [11/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const BlockingPolicy policy 
)
inline

Write a BlockingPolicy value to an ostream as a string.

Parameters
streamThe stream to write the value to.
policyThe policy value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [12/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlaybackButton button 
)
inline

Write a Button value to an ostream as a string.

Parameters
streamThe stream to write the value to.
buttonThe Button value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [13/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlaybackToggle toggle 
)
inline

Write a Toggle value to an ostream as a string.

Parameters
streamThe stream to write the value to.
toggleThe Toggle value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [14/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const AVSDirective::ParseStatus status 
)
inline

Write a ParseStatus value to an ostream as a string.

Parameters
streamThe stream to write the value to.
statusThe ParseStatus value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator==() [1/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const PlayRequestor playRequestorA,
const PlayRequestor playRequestorB 
)
inline

◆ operator==() [2/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const ComponentConfiguration lhs,
const ComponentConfiguration rhs 
)

Operator == for ComponentConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [3/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const HandlerAndPolicy lhs,
const HandlerAndPolicy rhs 
)

== operator.

Parameters
lhsThe HandlerAndPolicy instance on the left hand side of the == operation.
rhsThe HandlerAndPolicy instance on the right hand side of the == operation.
Returns
Whether the lhs instance is equal to the rhs instance.

◆ operator==() [4/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const std::shared_ptr< ComponentConfiguration lhs,
const std::shared_ptr< ComponentConfiguration rhs 
)

Operator == for shared_ptr of ComponentConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [5/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const BlockingPolicy lhs,
const BlockingPolicy rhs 
)

Equal-to operator comparing two BlockingPolicys

Parameters
lhsThe left side argument.
rhsThe right side argument.
Returns
true if lhs and rhs are equal

◆ operator==() [6/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const CapabilityConfiguration::Properties lhs,
const CapabilityConfiguration::Properties rhs 
)

Operator == for CapabilityConfiguration::Properties

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [7/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const CapabilityConfiguration lhs,
const CapabilityConfiguration rhs 
)

Operator == for CapabilityConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [8/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const std::shared_ptr< CapabilityConfiguration > &  lhs,
const std::shared_ptr< CapabilityConfiguration > &  rhs 
)

Operator == for std::shared_ptr<CapabilityConfiguration>

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator>>()

std::istream& alexaClientSDK::avsCommon::avs::operator>> ( std::istream &  is,
PlayerActivity value 
)
inline

Converts an input string stream value to PlayerActivity.

Parameters
isThe string stream to retrieve the value from.
[out]valueThe value to write to.
Returns
The stream that was passed in.

◆ parseDocument()

static bool alexaClientSDK::avsCommon::avs::parseDocument ( const std::string &  unparsedDirective,
Document *  document 
)
static

Utility function to attempt a JSON parse of the passed in string, and inform the caller if this succeeded or failed.

Parameters
unparsedDirectiveThe unparsed JSON string which should represent an AVS Directive.
[out]documentThe rapidjson Document which will be set to the parsed structure if the parse succeeds.
Returns
Whether the parse was successful.

◆ parseEndpoint()

static utils::Optional<AVSMessageEndpoint> alexaClientSDK::avsCommon::avs::parseEndpoint ( const Document &  document)
static

Utility function to parse the endpoint attributes from a rapidjson document structure.

Parameters
documentThe constructed document tree
Returns
The endpoint attribute content if it is available; otherwise, and empty object.

◆ parseHeader()

static std::shared_ptr<AVSMessageHeader> alexaClientSDK::avsCommon::avs::parseHeader ( const Document &  document,
AVSDirective::ParseStatus parseStatus 
)
static

Utility function to parse the header from a rapidjson document structure.

Parameters
documentThe constructed document tree
[out]parseStatusAn out parameter to express if the parse was successful
Returns
A pointer to an AVSMessageHeader object, or nullptr if the parse fails.

◆ parsePayload()

static std::string alexaClientSDK::avsCommon::avs::parsePayload ( const Document &  document,
AVSDirective::ParseStatus parseStatus 
)
static

Utility function to parse the payload from a rapidjson document structure.

Parameters
documentThe constructed document tree
[out]parseStatusAn out parameter to express if the parse was successful
Returns
The payload content if it is available.

◆ PlaybackButtonToString()

std::string alexaClientSDK::avsCommon::avs::PlaybackButtonToString ( PlaybackButton  button)
inline

Convert a PlaybackButton to std::string.

Parameters
buttonThe PlaybackButton to convert.
Returns
The representation of button.

◆ PlaybackToggleToString()

std::string alexaClientSDK::avsCommon::avs::PlaybackToggleToString ( PlaybackToggle  toggle)
inline

Convert a PlaybackToggle to std::string.

Parameters
toggleThe PlaybackToggle to convert.
Returns
The representation of toggle.

◆ playBehaviorToString()

std::string alexaClientSDK::avsCommon::avs::playBehaviorToString ( PlayBehavior  playBehavior)
inline

Convert a PlayBehavior to an AVS-compliant std::string.

Parameters
playBehaviorThe PlayBehavior to convert.
Returns
The AVS-compliant string representation of playBehavior.

◆ playerActivityToString()

std::string alexaClientSDK::avsCommon::avs::playerActivityToString ( PlayerActivity  playerActivity)
inline

◆ requesterToString()

std::string alexaClientSDK::avsCommon::avs::requesterToString ( Requester  requester)
inline

Converts an Requester enum to a string.

Parameters
requesterThe Requester enum.
Returns
The string representation of the enum.

◆ stringToPlayBehavior()

bool alexaClientSDK::avsCommon::avs::stringToPlayBehavior ( const std::string &  text,
PlayBehavior playBehavior 
)
inline

Convert an AVS-compliant string to a PlayBehavior.

Parameters
textThe string to convert.
[out]playBehaviorThe converted PlayBehavior.
Returns
true if the string converted succesfully, else false.

◆ submitMetric()

static void alexaClientSDK::avsCommon::avs::submitMetric ( const std::shared_ptr< MetricRecorderInterface > &  metricRecorder,
const std::string &  eventName 
)
static

Submits a metric of given event name

Parameters
metricRecorderThe MetricRecorderInterface which records Metric events
eventNameThe name of the metric event

◆ TAG() [1/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "MessageRequest"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "AbstractAVSConnectionManager"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "ComponentConfiguration"  )
static

String to identify log entries originating from this file.

◆ TAG() [4/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "WaitableMessageRequest"  )
static

String to identify log entries originating from this file.

◆ TAG() [5/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "CapabilityResources"  )
static

String to identify log entries originating from this file.

◆ TAG() [6/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "DialogUXStateAggregator"  )
static

String to identify log entries originating from this file.

◆ TAG() [7/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "CapabilityAgent"  )
static

String to identify log entries originating from this file.

◆ TAG() [8/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "EventBuilder"  )
static

String to identify log entries originating from this file.

◆ TAG() [9/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "ExceptionEncountered"  )
static

String to identify log entries originating from this file.

◆ TAG() [10/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "BlockingPolicy"  )
static

String to identify log entries originating from this file.

◆ TAG() [11/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "AVSContext"  )
static

String to identify log entries originating from this file.

◆ TAG() [12/12]

static const std::string alexaClientSDK::avsCommon::avs::TAG ( "AvsDirective"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ BEARER_TOKEN_TYPE

const std::string alexaClientSDK::avsCommon::avs::BEARER_TOKEN_TYPE = "BearerToken"
static

The bearer token type.

◆ BEARER_TOKEN_WITH_PARTITION_TYPE

const std::string alexaClientSDK::avsCommon::avs::BEARER_TOKEN_WITH_PARTITION_TYPE = "BearerTokenWithPartition"
static

The bearer token with partition type.

◆ CAPABILITY_INTERFACE_CONFIGURATIONS_KEY

const std::string alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations"
static

Key for interface configurations in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_NAME_KEY

const std::string alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_NAME_KEY = "interface"
static

Key for interface name in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_TYPE_KEY

const std::string alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_TYPE_KEY = "type"
static

Key for interface type in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_VERSION_KEY

const std::string alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_VERSION_KEY = "version"
static

Key for interface version in the CapabilityConfiguration map.

◆ CAPABILITY_QUEUE_WARN_SIZE

const int alexaClientSDK::avsCommon::avs::CAPABILITY_QUEUE_WARN_SIZE = 10
static

Maximum number of directives that Can be Queued before we emit warning logs.

◆ CONNECTION_TIMEOUT

const auto alexaClientSDK::avsCommon::avs::CONNECTION_TIMEOUT = std::chrono::seconds(15)
static

The connection timeout indicating how long to wait for the response to be received.

◆ CONTEXT_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::CONTEXT_KEY_STRING = "context"
static

The context key in the event.

◆ COOKIE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::COOKIE_KEY_STRING = "cookie"
static

The cookie key.

◆ CORRELATION_TOKEN_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::CORRELATION_TOKEN_KEY_STRING = "correlationToken"
static

The correlation token key.

◆ CUSTOM_METRIC_PREFIX

const std::string alexaClientSDK::avsCommon::avs::CUSTOM_METRIC_PREFIX = "CUSTOM-"
static

Custom Metrics prefix used by DialogUXStateAggregator.

◆ DIALOG_REQUEST_ID_KEY_STRING [1/2]

const std::string alexaClientSDK::avsCommon::avs::DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId"
static

The dialog request Id key in the header of the event.

◆ DIALOG_REQUEST_ID_KEY_STRING [2/2]

const std::string alexaClientSDK::avsCommon::avs::DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId"
static

The dialog request Id key in the header of the event.

◆ ENDPOINT_ID_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::ENDPOINT_ID_KEY_STRING = "endpointId"
static

The endpointId key.

◆ ENDPOINT_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::ENDPOINT_KEY_STRING = "endpoint"
static

The endpoint key.

◆ ERROR_KEY

const char alexaClientSDK::avsCommon::avs::ERROR_KEY[] = "error"
static

JSON key for the error field of the ExceptionEncountered event.

◆ ERROR_MESSAGE_KEY

const char alexaClientSDK::avsCommon::avs::ERROR_MESSAGE_KEY[] = "message"
static

JSON key for the ExceptionEncountered event's error message.

◆ ERROR_TYPE_KEY

const char alexaClientSDK::avsCommon::avs::ERROR_TYPE_KEY[] = "type"
static

JSON key for the ExceptionEncountered event's error type.

◆ EVENT_CORRELATION_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::EVENT_CORRELATION_KEY_STRING = "eventCorrelationToken"
static

The event correlation token key.

◆ EVENT_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::EVENT_KEY_STRING = "event"
static

The event key.

◆ EXCEPTION_ENCOUNTERED_EVENT_NAME

const std::string alexaClientSDK::avsCommon::avs::EXCEPTION_ENCOUNTERED_EVENT_NAME = "ExceptionEncountered"
static

JSON value for a ExceptionEncountered event's name.

◆ INSTANCE_KEY_STRING [1/3]

const std::string alexaClientSDK::avsCommon::avs::INSTANCE_KEY_STRING = "instance"
static

Key used to identify an instance.

◆ INSTANCE_KEY_STRING [2/3]

const std::string alexaClientSDK::avsCommon::avs::INSTANCE_KEY_STRING = "instance"
static

The instance key.

◆ INSTANCE_KEY_STRING [3/3]

const std::string alexaClientSDK::avsCommon::avs::INSTANCE_KEY_STRING = "instance"
static

The instance key.

◆ JSON_CORRELATION_TOKEN_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_CORRELATION_TOKEN_KEY = "correlationToken"
static

JSON key to get the correlationToken value of a header.

◆ JSON_ENDPOINT_COOKIE_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_ENDPOINT_COOKIE_KEY = "cookie"
static

JSON key to get the cookie value for the endpoint.

◆ JSON_ENDPOINT_ID_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_ENDPOINT_ID_KEY = "endpointId"
static

JSON key to get the endpointId value of the endpoint.

◆ JSON_ENDPOINT_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_ENDPOINT_KEY = "endpoint"
static

JSON key to get the endpoint object of a message.

◆ JSON_EVENT_CORRELATION_TOKEN_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_EVENT_CORRELATION_TOKEN_KEY = "eventCorrelationToken"
static

JSON key to get the eventCorrelationToken value of the header.

◆ JSON_MESSAGE_DIALOG_REQUEST_ID_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_DIALOG_REQUEST_ID_KEY = "dialogRequestId"
static

JSON key to get the dialogRequestId value of a header.

◆ JSON_MESSAGE_DIRECTIVE_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_DIRECTIVE_KEY = "directive"
static

JSON key to get the directive object of a message.

◆ JSON_MESSAGE_HEADER_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_HEADER_KEY = "header"
static

JSON key to get the header object of a message.

◆ JSON_MESSAGE_ID_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_ID_KEY = "messageId"
static

JSON key to get the messageId value of a header.

◆ JSON_MESSAGE_INSTANCE_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_INSTANCE_KEY = "instance"
static

JSON key to get the optional instance object of a message.

◆ JSON_MESSAGE_NAME_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_NAME_KEY = "name"
static

JSON key to get the name value of a header.

◆ JSON_MESSAGE_NAMESPACE_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_NAMESPACE_KEY = "namespace"
static

JSON key to get the namespace value of a header.

◆ JSON_MESSAGE_PAYLOAD_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_PAYLOAD_KEY = "payload"
static

JSON key to get the payload object of a message.

◆ JSON_MESSAGE_PAYLOAD_VERSION_KEY

const std::string alexaClientSDK::avsCommon::avs::JSON_MESSAGE_PAYLOAD_VERSION_KEY = "payloadVersion"
static

JSON key to get the payload version object of a message.

◆ LISTENING_TIMEOUT_EXPIRES

const std::string alexaClientSDK::avsCommon::avs::LISTENING_TIMEOUT_EXPIRES = "LISTENING_TIMEOUT_EXPIRES"
static

error metric for Listening timeout expires

◆ MAX_FRIENDLY_NAME_LENGTH

constexpr size_t alexaClientSDK::avsCommon::avs::MAX_FRIENDLY_NAME_LENGTH = 16000
static

Maximum length of the friendly name.

◆ MEDIUM_FLAG_AUDIO

const long alexaClientSDK::avsCommon::avs::MEDIUM_FLAG_AUDIO = 1
static

Flag indicating AUDIO medium is used.

◆ MEDIUM_FLAG_VISUAL

const long alexaClientSDK::avsCommon::avs::MEDIUM_FLAG_VISUAL = 2
static

Flag indicating VISUAL medium is used.

◆ MESSAGE_ID_KEY_STRING [1/2]

const std::string alexaClientSDK::avsCommon::avs::MESSAGE_ID_KEY_STRING = "messageId"
static

The message id key in the header of the event.

◆ MESSAGE_ID_KEY_STRING [2/2]

const std::string alexaClientSDK::avsCommon::avs::MESSAGE_ID_KEY_STRING = "messageId"
static

The message id key in the header of the event.

◆ MESSAGE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::MESSAGE_KEY_STRING = "message"
static

The message key in the event.

◆ NAMESPACE

const std::string alexaClientSDK::avsCommon::avs::NAMESPACE = "System"
static

The namespace for this event.

◆ PAYLOAD_VERSION_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::PAYLOAD_VERSION_KEY_STRING = "payloadVersion"
static

The payload version key.

◆ PROPERTIES_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::PROPERTIES_KEY_STRING = "properties"
static

Key used to identify the context properties.

◆ SCOPE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::SCOPE_KEY_STRING = "scope"
static

The scope key.

◆ SCOPE_PARTITION_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::SCOPE_PARTITION_KEY_STRING = "partition"
static

The scope partition.

◆ SCOPE_TOKEN_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::SCOPE_TOKEN_KEY_STRING = "token"
static

The scope token.

◆ SCOPE_TYPE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::SCOPE_TYPE_KEY_STRING = "type"
static

The scope type.

◆ SCOPE_USER_ID_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::SCOPE_USER_ID_KEY_STRING = "userId"
static

The scope user id.

◆ SHORT_TIMEOUT

const std::chrono::milliseconds alexaClientSDK::avsCommon::avs::SHORT_TIMEOUT {200}
static

A short timeout that is used to avoid going to the IDLE state immediately while waiting for other state changes.

◆ THINKING_TIMEOUT_EXPIRES

const std::string alexaClientSDK::avsCommon::avs::THINKING_TIMEOUT_EXPIRES = "THINKING_TIMEOUT_EXPIRES"
static

error metric for Thinking timeout expires

◆ TIME_OF_SAMPLE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::TIME_OF_SAMPLE_KEY_STRING = "timeOfSample"
static

Key used to identify the time of sample.

◆ TYPE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::TYPE_KEY_STRING = "type"
static

The type key in the event.

◆ UNCERTAINTY_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::UNCERTAINTY_KEY_STRING = "uncertaintyInMilliseconds"
static

Key used to identify an the uncertainty in milliseconds related to the time of sample. For more information: https://developer.amazon.com/docs/alexa/alexa-voice-service/reportable-state-properties.html#property-object

◆ UNPARSED_DIRECTIVE_KEY_STRING

const char alexaClientSDK::avsCommon::avs::UNPARSED_DIRECTIVE_KEY_STRING[] = "unparsedDirective"
static

JSON key for the unparsedDirective field of the ExceptionEncountered event.

◆ VALUE_KEY_STRING

const std::string alexaClientSDK::avsCommon::avs::VALUE_KEY_STRING = "value"
static

Key used to identify the state value.

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