Inheritance diagram for alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest:

Collaboration diagram for alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest:

Public Member Functions
void	SetUp () override

void	TearDown () override

void	initializeCapabilityAgent ()

void	sendSetIndicatorDirective (const std::string &payload, const std::string &messageId)

void	sendClearIndicatorDirective (const std::string &messageId)

const std::string	generatePayload (bool persistVisualIndicator, bool playAudioIndicator, const std::string &assetId=ASSET_ID1, const std::string &assetUrl=ASSET_URL1)

Public Attributes
std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >	m_metricRecorder
	The metric recorder. More...

std::shared_ptr< TestNotificationsObserver >	m_testNotificationsObserver
	`A` test observer to wait for `AudioPlayer` state changes More...

std::shared_ptr< NotificationsCapabilityAgent >	m_notificationsCapabilityAgent
	`NotificationsCapabilityAgent` to test More...

std::shared_ptr< TestNotificationsStorage >	m_notificationsStorage
	`Storage` for notifications More...

std::shared_ptr< MockNotificationRenderer >	m_renderer
	Player to play notification audio assets. More...

std::shared_ptr< MockContextManager >	m_mockContextManager
	`ContextManager` to provide state and update state. More...

std::unique_ptr< MockDirectiveHandlerResult >	m_mockDirectiveHandlerResult
	A directive handler result to send the result to. More...

std::shared_ptr< MockExceptionEncounteredSender >	m_mockExceptionSender
	An exception sender used to send exception encountered events to AVS. More...

std::shared_ptr< TestNotificationsAudioFactory >	m_testNotificationsAudioFactory
	An audio factory for testing. More...

std::mutex	m_mutex
	Serializes access to m_setIndicatorTrigger. More...

std::condition_variable	m_setIndicatorTrigger
	Triggers threads waiting on a SetIndicator directive to be processed. More...

std::shared_ptr< registrationManager::CustomerDataManager >	m_dataManager
	Shared pointer to `CustomerDataManager`. More...

unsigned int	m_numSetIndicatorsProcessed
	A count of how many SetIndicator directives have been processed. More...

Member Function Documentation

◆ generatePayload()

const std::string alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::generatePayload	(	bool	persistVisualIndicator,
		bool	playAudioIndicator,
		const std::string &	assetId = `ASSET_ID1`,
		const std::string &	assetUrl = `ASSET_URL1`
	)

Utility function to generate direcive payloads

◆ initializeCapabilityAgent()

void alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::initializeCapabilityAgent ( )

Utility function to create the capability agent. This allows modifying of subcomponents before the CA is created.

◆ sendClearIndicatorDirective()

void alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::sendClearIndicatorDirective ( const std::string & messageId )

Utility function to send ClearIndicatorDirective

◆ sendSetIndicatorDirective()

void alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::sendSetIndicatorDirective	(	const std::string &	payload,
		const std::string &	messageId
	)

Utility function to send SetIndicatorDirective

◆ SetUp()

void alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::SetUp ( )

override

◆ TearDown()

void alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::TearDown ( )

override

Member Data Documentation

◆ m_dataManager

std::shared_ptr<registrationManager::CustomerDataManager> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_dataManager

Shared pointer to CustomerDataManager.

◆ m_metricRecorder

std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_metricRecorder

The metric recorder.

◆ m_mockContextManager

std::shared_ptr<MockContextManager> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_mockContextManager

ContextManager to provide state and update state.

◆ m_mockDirectiveHandlerResult

std::unique_ptr<MockDirectiveHandlerResult> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_mockDirectiveHandlerResult

A directive handler result to send the result to.

◆ m_mockExceptionSender

std::shared_ptr<MockExceptionEncounteredSender> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_mockExceptionSender

An exception sender used to send exception encountered events to AVS.

◆ m_mutex

std::mutex alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_mutex

Serializes access to m_setIndicatorTrigger.

◆ m_notificationsCapabilityAgent

std::shared_ptr<NotificationsCapabilityAgent> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_notificationsCapabilityAgent

NotificationsCapabilityAgent to test

◆ m_notificationsStorage

std::shared_ptr<TestNotificationsStorage> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_notificationsStorage

Storage for notifications

◆ m_numSetIndicatorsProcessed

unsigned int alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_numSetIndicatorsProcessed

A count of how many SetIndicator directives have been processed.

◆ m_renderer

std::shared_ptr<MockNotificationRenderer> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_renderer

Player to play notification audio assets.

◆ m_setIndicatorTrigger

std::condition_variable alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_setIndicatorTrigger

Triggers threads waiting on a SetIndicator directive to be processed.

◆ m_testNotificationsAudioFactory

std::shared_ptr<TestNotificationsAudioFactory> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_testNotificationsAudioFactory

An audio factory for testing.

◆ m_testNotificationsObserver

std::shared_ptr<TestNotificationsObserver> alexaClientSDK::capabilityAgents::notifications::test::NotificationsCapabilityAgentTest::m_testNotificationsObserver

A test observer to wait for AudioPlayer state changes

The documentation for this class was generated from the following file:

/home/ANT.AMAZON.COM/womw/workplace/1.19_release/doxy/avs-device-sdk/CapabilityAgents/Notifications/test/NotificationsCapabilityAgentTest.cpp

Public Member Functions

Public Attributes