AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::afml::test::AudioActivityTrackerTest Class Reference
Inheritance diagram for alexaClientSDK::afml::test::AudioActivityTrackerTest:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::afml::test::AudioActivityTrackerTest:
Collaboration graph
[legend]

Public Member Functions

 AudioActivityTrackerTest ()
 
void SetUp () override
 
void TearDown () override
 
void verifyState (const std::string &providedState, const std::vector< Channel::State > &channels)
 
void provideUpdate (const std::vector< Channel::State > &channels)
 
SetStateResult wakeOnSetState ()
 
- Public Member Functions inherited from testing::Test
virtual ~Test ()
 

Public Attributes

std::shared_ptr< AudioActivityTrackerm_audioActivityTracker
 AudioActivityTracker to test More...
 
std::shared_ptr< MockContextManagerm_mockContextManager
 ContextManager to provide state and update state. More...
 
std::shared_ptr< Channelm_dialogChannel
 A dialogChannel used for testing. More...
 
std::shared_ptr< Channelm_contentChannel
 A contentChannel used for testing. More...
 
std::promise< void > m_wakeSetStatePromise
 Promise to be fulfilled when setState is called. More...
 
std::future< void > m_wakeSetStateFuture
 Future to notify when setState is called. More...
 

Additional Inherited Members

- Public Types inherited from testing::Test
typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc
 
typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc
 
- Static Public Member Functions inherited from testing::Test
static void SetUpTestCase ()
 
static void TearDownTestCase ()
 
static bool HasFatalFailure ()
 
static bool HasNonfatalFailure ()
 
static bool HasFailure ()
 
static void RecordProperty (const std::string &key, const std::string &value)
 
static void RecordProperty (const std::string &key, int value)
 
- Protected Member Functions inherited from testing::Test
 Test ()
 

Constructor & Destructor Documentation

◆ AudioActivityTrackerTest()

alexaClientSDK::afml::test::AudioActivityTrackerTest::AudioActivityTrackerTest ( )

Member Function Documentation

◆ provideUpdate()

void alexaClientSDK::afml::test::AudioActivityTrackerTest::provideUpdate ( const std::vector< Channel::State > &  channels)

A helper function to verify the context provided by the AudioActivityTracker matches the set the channels notified via notifyOfActivityUpdates().

Parameters
channelsThe set of channels that's passed into the AudioActivityTracker

◆ SetUp()

void alexaClientSDK::afml::test::AudioActivityTrackerTest::SetUp ( )
overridevirtual

Reimplemented from testing::Test.

◆ TearDown()

void alexaClientSDK::afml::test::AudioActivityTrackerTest::TearDown ( )
overridevirtual

Reimplemented from testing::Test.

◆ verifyState()

void alexaClientSDK::afml::test::AudioActivityTrackerTest::verifyState ( const std::string &  providedState,
const std::vector< Channel::State > &  channels 
)

Verify that the provided state matches the expected state

Parameters
jsonStateThe state to verify
channelsThe set of channels that's passed into the AudioActivityTracker

◆ wakeOnSetState()

SetStateResult alexaClientSDK::afml::test::AudioActivityTrackerTest::wakeOnSetState ( )

This is invoked in response to a setState call.

Returns
SUCCESS.

Member Data Documentation

◆ m_audioActivityTracker

std::shared_ptr<AudioActivityTracker> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_audioActivityTracker

◆ m_contentChannel

std::shared_ptr<Channel> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_contentChannel

A contentChannel used for testing.

◆ m_dialogChannel

std::shared_ptr<Channel> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_dialogChannel

A dialogChannel used for testing.

◆ m_mockContextManager

std::shared_ptr<MockContextManager> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_mockContextManager

ContextManager to provide state and update state.

◆ m_wakeSetStateFuture

std::future<void> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_wakeSetStateFuture

Future to notify when setState is called.

◆ m_wakeSetStatePromise

std::promise<void> alexaClientSDK::afml::test::AudioActivityTrackerTest::m_wakeSetStatePromise

Promise to be fulfilled when setState is called.


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

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