AlexaClientSDK  1.21.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Types | Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface Class Referenceabstract

#include <EndpointRegistrationManagerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface:
Inheritance graph
[legend]

Public Types

using RegistrationResult = EndpointRegistrationObserverInterface::RegistrationResult
 Aliases. More...
 
using DeregistrationResult = EndpointRegistrationObserverInterface::DeregistrationResult
 

Public Member Functions

virtual ~EndpointRegistrationManagerInterface ()=default
 
virtual std::future< RegistrationResultregisterEndpoint (std::shared_ptr< EndpointInterface > endpoint)=0
 
virtual std::future< DeregistrationResultderegisterEndpoint (const EndpointIdentifier &endpointId)=0
 
virtual void addObserver (std::shared_ptr< EndpointRegistrationObserverInterface > observer)=0
 
virtual void removeObserver (const std::shared_ptr< EndpointRegistrationObserverInterface > &observer)=0
 

Detailed Description

Class responsible for managing endpoints handled by this client. This includes:

Member Typedef Documentation

◆ DeregistrationResult

◆ RegistrationResult

Aliases.

Constructor & Destructor Documentation

◆ ~EndpointRegistrationManagerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::~EndpointRegistrationManagerInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ addObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::addObserver ( std::shared_ptr< EndpointRegistrationObserverInterface observer)
pure virtual

Adds a registration manager observer to be notified when a registration has succeeded.

Parameters
observerThe observer to add.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

◆ deregisterEndpoint()

virtual std::future<DeregistrationResult> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::deregisterEndpoint ( const EndpointIdentifier endpointId)
pure virtual

Deregisters an endpoint.

Parameters
endpointThe EndpointIdentifier of the endpoint to be deregistered.
Returns
A future that is set to true when the endpoint has been deregistered, or that is set to false if the operation failed.
Note
This operation is asynchronous. You can also use EndpointRegistrationObserverInterface to get notified whenever the operation succeeds or fails.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

◆ registerEndpoint()

virtual std::future<RegistrationResult> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::registerEndpoint ( std::shared_ptr< EndpointInterface endpoint)
pure virtual

Registers an endpoint.

Note
endpointIds are unique. If an endpoint is registered with the same endpointId as a pre-existing endpoint, the pre-existing endpoint will be replaced with the new one.
Parameters
endpointA pointer to the EndpointInterface to be registered.
Returns
A future that is set to true when the endpoint has been registered and enabled, or that is set to false if the operation failed.
Note
This operation is asynchronous. You can also use EndpointRegistrationObserverInterface to get notified whenever the operation succeeds or fails.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.

◆ removeObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationManagerInterface::removeObserver ( const std::shared_ptr< EndpointRegistrationObserverInterface > &  observer)
pure virtual

Remove a previously registered observer.

Parameters
observerThe observer to be removed.

Implemented in alexaClientSDK::endpoints::EndpointRegistrationManager.


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

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