AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::afml::test::MockActivityTrackerInterface Class Reference

A test observer that mocks out the ActivityTrackerInterface#notifyOfActivityUpdates() call. More...

Inheritance diagram for alexaClientSDK::afml::test::MockActivityTrackerInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::afml::test::MockActivityTrackerInterface:
Collaboration graph
[legend]

Classes

struct  ExpectedChannelStateResult
 Structure of expected Channel::State result from tests. More...
 

Public Member Functions

 MockActivityTrackerInterface ()
 
void notifyOfActivityUpdates (const std::vector< Channel::State > &channelStates) override
 
void waitForActivityUpdates (std::chrono::milliseconds timeout, const std::vector< ExpectedChannelStateResult > &expected)
 
bool waitForNoActivityUpdates (std::chrono::milliseconds timeout)
 
- Public Member Functions inherited from alexaClientSDK::afml::ActivityTrackerInterface
virtual ~ActivityTrackerInterface ()=default
 Destructor. More...
 

Detailed Description

A test observer that mocks out the ActivityTrackerInterface#notifyOfActivityUpdates() call.

Constructor & Destructor Documentation

◆ MockActivityTrackerInterface()

alexaClientSDK::afml::test::MockActivityTrackerInterface::MockActivityTrackerInterface ( )
inline

Constructor.

Member Function Documentation

◆ notifyOfActivityUpdates()

void alexaClientSDK::afml::test::MockActivityTrackerInterface::notifyOfActivityUpdates ( const std::vector< Channel::State > &  channelStates)
inlineoverridevirtual

Implementation of the ActivityTrackerInterface#notifyOfActivityUpdates() callback.

Parameters
channelStatesA vector of Channel::State that has been updated.

Implements alexaClientSDK::afml::ActivityTrackerInterface.

◆ waitForActivityUpdates()

void alexaClientSDK::afml::test::MockActivityTrackerInterface::waitForActivityUpdates ( std::chrono::milliseconds  timeout,
const std::vector< ExpectedChannelStateResult > &  expected 
)
inline

Waits for the ActivityTrackerInterface#notifyOfActivityUpdates() callback.

Parameters
timeoutThe amount of time to wait for the callback.
expectedThe expected channel state results

◆ waitForNoActivityUpdates()

bool alexaClientSDK::afml::test::MockActivityTrackerInterface::waitForNoActivityUpdates ( std::chrono::milliseconds  timeout)
inline

Waits for the if there's a ActivityTrackerInterface#notifyOfActivityUpdates() callback.

Parameters
timeoutThe amount of time to wait for the callback.

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

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