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::rangeController::RangeControllerObserverInterface Class Referenceabstract

#include <RangeControllerObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface:
Inheritance graph
[legend]

Classes

struct  RangeState
 

Public Member Functions

virtual ~RangeControllerObserverInterface ()=default
 
virtual void onRangeChanged (const RangeState &rangeState, AlexaStateChangeCauseType cause)=0
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ~RangeControllerObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::~RangeControllerObserverInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ onRangeChanged()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::rangeController::RangeControllerObserverInterface::onRangeChanged ( const RangeState rangeState,
AlexaStateChangeCauseType  cause 
)
pure virtual

Notifies the change in the range value of the endpoint.

Parameters
rangeStateThe toggle state specified using RangeState.
causeThe cause for this change specified using AlexaStateChangeCauseType.

Implemented in alexaClientSDK::capabilityAgents::rangeController::RangeControllerCapabilityAgent, and alexaClientSDK::diagnostics::DevicePropertyAggregator.


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