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

Public Member Functions

 TestNotificationsObserver ()
 
bool waitFor (IndicatorState state, std::chrono::milliseconds timeout)
 
bool waitFor (int count, std::chrono::milliseconds timeout)
 
void onSetIndicator (IndicatorState state) override
 
void onNotificationReceived () override
 
- Public Member Functions inherited from alexaClientSDK::acsdkNotificationsInterfaces::NotificationsObserverInterface
virtual ~NotificationsObserverInterface ()=default
 

Detailed Description

A test class that acts as a NotificationsObserver.

Constructor & Destructor Documentation

◆ TestNotificationsObserver()

alexaClientSDK::acsdkNotifications::test::TestNotificationsObserver::TestNotificationsObserver ( )

Member Function Documentation

◆ onNotificationReceived()

void alexaClientSDK::acsdkNotifications::test::TestNotificationsObserver::onNotificationReceived ( )
overridevirtual

Notifies the observer that a new notification has been received. This is called repeatedly for duplicate notifications.

Implements alexaClientSDK::acsdkNotificationsInterfaces::NotificationsObserverInterface.

◆ onSetIndicator()

void alexaClientSDK::acsdkNotifications::test::TestNotificationsObserver::onSetIndicator ( IndicatorState  state)
overridevirtual

Notifies the observer that a SetIndicator directive has been processed

Parameters
stateThe value of the persistVisualIndicator field of the directive.

Implements alexaClientSDK::acsdkNotificationsInterfaces::NotificationsObserverInterface.

◆ waitFor() [1/2]

bool alexaClientSDK::acsdkNotifications::test::TestNotificationsObserver::waitFor ( IndicatorState  state,
std::chrono::milliseconds  timeout 
)

Waits for an IndicatorState change.

Parameters
stateThe IndicatorState to wait for.
timeoutThe amount of time to wait for the state change.

◆ waitFor() [2/2]

bool alexaClientSDK::acsdkNotifications::test::TestNotificationsObserver::waitFor ( int  count,
std::chrono::milliseconds  timeout 
)

Waits for IndicationCount to increase.

Parameters
countThe number of indicator events to wait for.
timeoutThe amount of time to wait for the state change.

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

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