AlexaClientSDK  1.22.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::EndpointRegistrationObserverInterface Class Referenceabstract

#include <EndpointRegistrationObserverInterface.h>

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

Public Types

enum  RegistrationResult {
  RegistrationResult::SUCCEEDED, RegistrationResult::CONFIGURATION_ERROR, RegistrationResult::INTERNAL_ERROR, RegistrationResult::REGISTRATION_IN_PROGRESS,
  RegistrationResult::PENDING_DEREGISTRATION
}
 
enum  DeregistrationResult {
  DeregistrationResult::SUCCEEDED, DeregistrationResult::NOT_REGISTERED, DeregistrationResult::INTERNAL_ERROR, DeregistrationResult::CONFIGURATION_ERROR,
  DeregistrationResult::REGISTRATION_IN_PROGRESS, 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 onEndpointDeregistration (const EndpointIdentifier &endpointId, const DeregistrationResult result)=0
 

Detailed Description

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

Member Enumeration Documentation

◆ DeregistrationResult

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.

REGISTRATION_IN_PROGRESS 

Deregistration failed because the endpoint is currently being updated.

PENDING_DEREGISTRATION 

Deregistration is pending.

◆ RegistrationResult

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.

REGISTRATION_IN_PROGRESS 

Registration failed because the endpoint is currently being updated.

PENDING_DEREGISTRATION 

Registration 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
endpointIdThe endpoint identifier.
resultThe 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
endpointIdThe endpoint identifier.
attributesThe endpoint attributes.
resultThe final registration result.

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

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