alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface Class Reference

#include <AVSGatewayManagerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface:

Public Member Functions
virtual	~AVSGatewayManagerInterface ()=default
virtual bool	setAVSGatewayAssigner (std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayAssignerInterface > avsGatewayAssigner)=0
virtual std::string	getGatewayURL () const =0
virtual bool	setGatewayURL (const std::string &avsGatewayURL)=0
virtual void	addObserver (std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayObserverInterface > observer)=0
virtual void	removeObserver (std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayObserverInterface > observer)=0

Detailed Description

The interface class for the AVS Gateway Manager. The AVS Gateway manages the AVS Gateway the device should connect to.

Constructor & Destructor Documentation

~AVSGatewayManagerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::~AVSGatewayManagerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

addObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::addObserver ( std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayObserverInterface >  observer )

pure virtual

Adds an observer.

Parameters

observer

The AVSGatewayObserver

getGatewayURL()

virtual std::string alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::getGatewayURL ( ) const

pure virtual

Gets the AVS Gateway URL.

Returns

The string representing the AVS Gateway URL

Implemented in alexaClientSDK::avsGatewayManager::AVSGatewayManager.

removeObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::removeObserver ( std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayObserverInterface >  observer )

pure virtual

Removes an observer.

Parameters

observer

The AVSGatewayObserver.

setAVSGatewayAssigner()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::setAVSGatewayAssigner ( std::shared_ptr< avsCommon::sdkInterfaces::AVSGatewayAssignerInterface >  avsGatewayAssigner )

pure virtual

Sets the AVS Gateway Assigner used to change the Gateway the client is connected to.

Parameters

avsGatewayAssigner

The AVSGatewayAssigner used to change the AVS Gateway the client is connected to.

Returns

True if successful, else false.

setGatewayURL()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayManagerInterface::setGatewayURL ( const std::string &  avsGatewayURL )

pure virtual

Sets the AVS Gateway URL.

Parameters

avsGatewayURL

The string representing the AVS Gateway URL.

Returns

True if successful, else false.

Implemented in alexaClientSDK::avsGatewayManager::AVSGatewayManager.

---

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

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/AVSGatewayManagerInterface.h