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

#include <CapabilitiesDelegateInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface:
Collaboration graph
[legend]

Public Member Functions

virtual ~CapabilitiesDelegateInterface ()=default
 
virtual bool addOrUpdateEndpoint (const avsCommon::avs::AVSDiscoveryEndpointAttributes &endpointAttributes, const std::vector< avsCommon::avs::CapabilityConfiguration > &capabilities)=0
 
virtual bool deleteEndpoint (const avsCommon::avs::AVSDiscoveryEndpointAttributes &endpointAttributes, const std::vector< avsCommon::avs::CapabilityConfiguration > &capabilities)=0
 
virtual void addCapabilitiesObserver (std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesObserverInterface > observer)=0
 
virtual void removeCapabilitiesObserver (std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesObserverInterface > observer)=0
 
virtual void invalidateCapabilities ()=0
 
virtual void setMessageSender (const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &messageSender)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AlexaEventProcessedObserverInterface
virtual ~AlexaEventProcessedObserverInterface ()=default
 
virtual void onAlexaEventProcessedReceived (const std::string &eventCorrelationToken)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::AVSGatewayObserverInterface
virtual ~AVSGatewayObserverInterface ()=default
 
virtual void onAVSGatewayChanged (const std::string &avsGateway)=0
 
- Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
virtual ~ConnectionStatusObserverInterface ()=default
 
virtual void onConnectionStatusChanged (const Status status, const ChangedReason reason)=0
 
virtual void onConnectionStatusChanged (const Status status, const std::vector< EngineConnectionStatus > &engineStatuses)
 

Additional Inherited Members

- Public Types inherited from alexaClientSDK::avsCommon::sdkInterfaces::ConnectionStatusObserverInterface
enum  Status { Status::DISCONNECTED, Status::PENDING, Status::CONNECTED }
 
enum  ChangedReason {
  ChangedReason::NONE, ChangedReason::SUCCESS, ChangedReason::UNRECOVERABLE_ERROR, ChangedReason::ACL_CLIENT_REQUEST,
  ChangedReason::ACL_DISABLED, ChangedReason::DNS_TIMEDOUT, ChangedReason::CONNECTION_TIMEDOUT, ChangedReason::CONNECTION_THROTTLED,
  ChangedReason::INVALID_AUTH, ChangedReason::PING_TIMEDOUT, ChangedReason::WRITE_TIMEDOUT, ChangedReason::READ_TIMEDOUT,
  ChangedReason::FAILURE_PROTOCOL_ERROR, ChangedReason::INTERNAL_ERROR, ChangedReason::SERVER_INTERNAL_ERROR, ChangedReason::SERVER_SIDE_DISCONNECT,
  ChangedReason::SERVER_ENDPOINT_CHANGED
}
 

Detailed Description

CapabilitiesDelegateInterface is an interface with methods that provide clients a way to register endpoints and their capabilities and publish them so that Alexa is aware of the device's capabilities.

Constructor & Destructor Documentation

◆ ~CapabilitiesDelegateInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::~CapabilitiesDelegateInterface ( )
virtualdefault

Destructor

Member Function Documentation

◆ addCapabilitiesObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::addCapabilitiesObserver ( std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesObserverInterface observer)
pure virtual

Specify an object to observe changes to the state of this CapabilitiesDelegate. During the call to this setter the observers onCapabilitiesStateChange() method will be called back with the current capabilities state.

Parameters
observerThe object to observe the state of this CapabilitiesDelegate.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.

◆ addOrUpdateEndpoint()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::addOrUpdateEndpoint ( const avsCommon::avs::AVSDiscoveryEndpointAttributes endpointAttributes,
const std::vector< avsCommon::avs::CapabilityConfiguration > &  capabilities 
)
pure virtual

Updates an existing endpoint's capabilities or, if the endpoint does not already exist, registers a new endpoint.

Parameters
endpointAttributesThe EndpointAttributes for the registering endpoint.
capabilitiesThe array of CapabilityConfiguration the endpoint supports.
Returns
true if operation was successful, else false.
Note
This operation can fail at several stages before publishing the endpoint to AVS: if the capabilities are empty; if the attributes or capability configurations are invalid; if the endpoint is already pending deletion or registration. If this function returns true, the endpoint will be published to AVS. Callers can be notified of published endpoints using CapabilitiesObserverInterface.

◆ deleteEndpoint()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::deleteEndpoint ( const avsCommon::avs::AVSDiscoveryEndpointAttributes endpointAttributes,
const std::vector< avsCommon::avs::CapabilityConfiguration > &  capabilities 
)
pure virtual

Deletes an existing endpoint.

Parameters
endpointAttributesThe EndpointAttributes for the deregistering endpoint.
capabilitiesThe array of CapabilityConfiguration the endpoint supports.
Returns
true if operation was successful, else false.
Note
This operation can fail at several stages before publishing the endpoint to AVS: if the endpoint is not registered; if the capabilities are empty; if the attributes or capability configurations are invalid; if the endpoint is already pending deletion or registration. If this function returns true, the endpoint will be deregistered from AVS. Callers can be notified of deregistered endpoints using CapabilitiesObserverInterface.

◆ invalidateCapabilities()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::invalidateCapabilities ( )
pure virtual

Invalidates the capabilities reported to the AVS last. Capabilities information should be rebuilt and reported to the AVS during the next synchronization.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.

◆ removeCapabilitiesObserver()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::removeCapabilitiesObserver ( std::shared_ptr< avsCommon::sdkInterfaces::CapabilitiesObserverInterface observer)
pure virtual

Remove an observer.

Parameters
observerThe observer to remove.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.

◆ setMessageSender()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesDelegateInterface::setMessageSender ( const std::shared_ptr< avsCommon::sdkInterfaces::MessageSenderInterface > &  messageSender)
pure virtual

Set the message sender to use for sending Discovery events to AVS when connected.

Parameters
messageSenderThe message sender.

Implemented in alexaClientSDK::capabilitiesDelegate::CapabilitiesDelegate.


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