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

Public Member Functions

bool waitFor (AlertScheduler::State newState)
 
void onAlertStateChange (const std::string &alertToken, const std::string &alertType, AlertScheduler::State newState, const std::string &reason)
 
- Public Member Functions inherited from alexaClientSDK::capabilityAgents::alerts::AlertObserverInterface
virtual ~AlertObserverInterface ()=default
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::capabilityAgents::alerts::AlertObserverInterface
enum  State {
  State::READY, State::STARTED, State::STOPPED, State::SNOOZED,
  State::COMPLETED, State::PAST_DUE, State::FOCUS_ENTERED_FOREGROUND, State::FOCUS_ENTERED_BACKGROUND,
  State::ERROR, State::DELETED, State::SCHEDULED_FOR_LATER
}
 
- Static Public Member Functions inherited from alexaClientSDK::capabilityAgents::alerts::AlertObserverInterface
static std::string stateToString (State state)
 

Member Function Documentation

◆ onAlertStateChange()

void alexaClientSDK::capabilityAgents::alerts::test::TestAlertObserver::onAlertStateChange ( const std::string &  alertToken,
const std::string &  alertType,
AlertScheduler::State  state,
const std::string &  reason 
)
inlinevirtual

A callback function to notify an object that an alert has updated its state.

Parameters
alertTokenThe AVS token of the alert.
alertTypeThe type of the alert.
stateThe state of the alert.
reasonThe reason for the state change.

Implements alexaClientSDK::capabilityAgents::alerts::AlertObserverInterface.

◆ waitFor()

bool alexaClientSDK::capabilityAgents::alerts::test::TestAlertObserver::waitFor ( AlertScheduler::State  newState)
inline

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

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