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::avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface Class Referenceabstract

#include <ToggleControllerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface:
Inheritance graph
[legend]

Classes

struct  ToggleState
 

Public Member Functions

virtual ~ToggleControllerObserverInterface ()=default
 
virtual void onToggleStateChanged (const ToggleState &toggleState, AlexaStateChangeCauseType cause)=0
 

Detailed Description

This interface is used to observe changes to the toggle property of an endpoint that are caused by the ToggleControllerInteface.

Constructor & Destructor Documentation

◆ ~ToggleControllerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface::~ToggleControllerObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onToggleStateChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::toggleController::ToggleControllerObserverInterface::onToggleStateChanged ( const ToggleState toggleState,
AlexaStateChangeCauseType  cause 
)
pure virtual

Notifies the change in the toggle state of the endpoint.

Parameters
toggleStateThe toggle state specified using ToggleState.
causeThe cause for this change specified using AlexaStateChangeCauseType.

Implemented in alexaClientSDK::capabilityAgents::toggleController::ToggleControllerCapabilityAgent.


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