AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface Class Referenceabstract

#include <PowerControllerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface:
Inheritance graph
[legend]

Classes

struct  PowerState
 

Public Member Functions

virtual ~PowerControllerObserverInterface ()=default
 
virtual void onPowerStateChanged (const PowerState &powerState, AlexaStateChangeCauseType cause)=0
 

Detailed Description

This interface is used to observe changes to the power state property of an endpoint that are caused by the PowerControllerInteface.

Constructor & Destructor Documentation

◆ ~PowerControllerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface::~PowerControllerObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onPowerStateChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::powerController::PowerControllerObserverInterface::onPowerStateChanged ( const PowerState powerState,
AlexaStateChangeCauseType  cause 
)
pure virtual

Notifies the change in the power state property of the endpoint.

Parameters
powerStateThe power state specified using PowerState.
causeThe cause for this change specified using AlexaStateChangeCauseType.

Implemented in alexaClientSDK::diagnostics::DevicePropertyAggregator, and alexaClientSDK::capabilityAgents::powerController::PowerControllerCapabilityAgent.


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

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