alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface Class Reference

#include <EndpointRegistrationObserverInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface:

Public Types
enum	RegistrationResult {   RegistrationResult::SUCCEEDED, RegistrationResult::CONFIGURATION_ERROR, RegistrationResult::INTERNAL_ERROR, RegistrationResult::PENDING_REGISTRATION,   RegistrationResult::PENDING_DEREGISTRATION, RegistrationResult::PENDING_UPDATE, RegistrationResult::ALREADY_REGISTERED }
enum	UpdateResult {   UpdateResult::SUCCEEDED, UpdateResult::CONFIGURATION_ERROR, UpdateResult::INTERNAL_ERROR, UpdateResult::NOT_REGISTERED,   UpdateResult::PENDING_UPDATE, UpdateResult::PENDING_REGISTRATION, UpdateResult::PENDING_DEREGISTRATION }
enum	DeregistrationResult {   DeregistrationResult::SUCCEEDED, DeregistrationResult::NOT_REGISTERED, DeregistrationResult::INTERNAL_ERROR, DeregistrationResult::CONFIGURATION_ERROR,   DeregistrationResult::PENDING_UPDATE, DeregistrationResult::PENDING_REGISTRATION, DeregistrationResult::PENDING_DEREGISTRATION }

Public Member Functions
virtual	~EndpointRegistrationObserverInterface ()=default
virtual void	onEndpointRegistration (const EndpointIdentifier &endpointId, const avs::AVSDiscoveryEndpointAttributes &attributes, const RegistrationResult result)=0
virtual void	onEndpointUpdate (const EndpointIdentifier &endpointId, const avs::AVSDiscoveryEndpointAttributes &attributes, const UpdateResult result)=0
virtual void	onEndpointDeregistration (const EndpointIdentifier &endpointId, const DeregistrationResult result)=0
virtual void	onPendingEndpointRegistrationOrUpdate (const EndpointIdentifier &endpointId, const avs::AVSDiscoveryEndpointAttributes &attributes, const std::vector< avs::CapabilityConfiguration > &capabilities)

Detailed Description

Interface that can be implemented in order to receive notifications about changes in endpoints registration.

Member Enumeration Documentation

DeregistrationResult

enum alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::DeregistrationResult

strong

Enumeration of possible deregistration results.

Enumerator
SUCCEEDED	Deregistration succeeded.
NOT_REGISTERED	Deregistration failed due to the endpoint not being registered yet.
INTERNAL_ERROR	Deregistration failed due to internal error.
CONFIGURATION_ERROR	Deregistration failed due to some configuration error.
PENDING_UPDATE	Deregistration failed because the endpoint is being updated.
PENDING_REGISTRATION	Deregistration failed because the endpoint is being registered.
PENDING_DEREGISTRATION	Deregistration failed because the endpoint is being deregistered.

RegistrationResult

enum alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::RegistrationResult

strong

Enumeration of possible registration results.

Enumerator
SUCCEEDED	Registration succeeded.
CONFIGURATION_ERROR	Registration failed due to some configuration error.
INTERNAL_ERROR	Registration failed due to internal error.
PENDING_REGISTRATION	Registration failed because the endpoint is being registered.
PENDING_DEREGISTRATION	Registration failed because the endpoint is being deregistered.
PENDING_UPDATE	Registration failed because the endpoint is being updated.
ALREADY_REGISTERED	Registration failed because the endpoint has already been registered.

UpdateResult

enum alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::UpdateResult

strong

Enumeration of possible update results.

Enumerator
SUCCEEDED	Update Succeeded.
CONFIGURATION_ERROR	Update failed due to some configuration error.
INTERNAL_ERROR	Update failed due to internal error.
NOT_REGISTERED	Update failed due to the endpoint not being registered yet.
PENDING_UPDATE	Update failed because the endpoint is being updated.
PENDING_REGISTRATION	Update failed because the endpoint is being registered.
PENDING_DEREGISTRATION	Update failed because the endpoint is being deregistered.

Constructor & Destructor Documentation

~EndpointRegistrationObserverInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::~EndpointRegistrationObserverInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onEndpointDeregistration()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::onEndpointDeregistration ( const EndpointIdentifier &  endpointId, const DeregistrationResult  result  )

pure virtual

Notifies observer that an endpoint deregistration has been processed.

Parameters

endpointId	The endpoint identifier.
result	The final deregistration result.

onEndpointRegistration()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::onEndpointRegistration ( const EndpointIdentifier &  endpointId, const avs::AVSDiscoveryEndpointAttributes &  attributes, const RegistrationResult  result  )

pure virtual

Notifies observer that a new endpoint registration has been processed.

Parameters

endpointId	The endpoint identifier.
attributes	The endpoint attributes.
result	The final registration result.

onEndpointUpdate()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::onEndpointUpdate ( const EndpointIdentifier &  endpointId, const avs::AVSDiscoveryEndpointAttributes &  attributes, const UpdateResult  result  )

pure virtual

Notifies observer that an existing endpoint update has been processed.

Parameters

endpointId	The endpoint identifier.
attributes	The endpoint attributes.
result	The final registration result.

onPendingEndpointRegistrationOrUpdate()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointRegistrationObserverInterface::onPendingEndpointRegistrationOrUpdate ( const EndpointIdentifier &  endpointId, const avs::AVSDiscoveryEndpointAttributes &  attributes, const std::vector< avs::CapabilityConfiguration > &  capabilities  )

inlinevirtual

Notifies observer that an endpoint registration or update has been started.

Parameters

endpointId	The endpoint identifier.
attributes	The endpoint attributes.
capabilities	The endpoint capabilities.

---

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

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