alexaClientSDK::capabilityAgents::notifications::NotificationIndicator Struct Reference

#include <NotificationIndicator.h>

Collaboration diagram for alexaClientSDK::capabilityAgents::notifications::NotificationIndicator:

Classes
struct	Asset

Public Member Functions
	NotificationIndicator ()
	NotificationIndicator (bool persistVisualIndicator, bool playAudioIndicator, const std::string &assetId, const std::string &url)

Public Attributes
bool	persistVisualIndicator
bool	playAudioIndicator
	Flag specifying if the device must play audio when processing this NotificationIndicator. More...
struct alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::Asset	asset

Detailed Description

A struct representation of a NotificationIndicator.

There is one instance of this class created per SetIndicator directive.

Constructor & Destructor Documentation

NotificationIndicator() [1/2]

alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::NotificationIndicator

(

)

Default constructor

NotificationIndicator() [2/2]

alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::NotificationIndicator	(	bool	persistVisualIndicator,
		bool	playAudioIndicator,
		const std::string &	assetId,
		const std::string &	url
	)

Constructor

Parameters

persistVisualIndicator	A flag indicating whether the visual indicator on the device should stay lit.
playAudioIndicator	A flag indicating whether audio should be played.
assetId	The id of the audio asset to be played.
url	The url of the audio asset to be played.

Member Data Documentation

asset

struct alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::Asset alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::asset

persistVisualIndicator

bool alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::persistVisualIndicator

Flag specifying if the device must display a persistent visual indicator when processing this NotificationIndicator.

playAudioIndicator

bool alexaClientSDK::capabilityAgents::notifications::NotificationIndicator::playAudioIndicator

Flag specifying if the device must play audio when processing this NotificationIndicator.

---

The documentation for this struct was generated from the following files:

• /home/ANT.AMAZON.COM/womw/workplace/1.19_release/doxy/avs-device-sdk/CapabilityAgents/Notifications/include/Notifications/NotificationIndicator.h
• /home/ANT.AMAZON.COM/womw/workplace/1.19_release/doxy/avs-device-sdk/CapabilityAgents/Notifications/src/NotificationIndicator.cpp