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

#include <EndpointInterface.h>

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

Public Member Functions

virtual ~EndpointInterface ()=default
 
virtual EndpointIdentifier getEndpointId () const =0
 
virtual avs::AVSDiscoveryEndpointAttributes getAttributes () const =0
 
virtual std::vector< avsCommon::avs::CapabilityConfigurationgetCapabilityConfigurations () const =0
 
virtual std::unordered_map< avsCommon::avs::CapabilityConfiguration, std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerInterface > > getCapabilities () const =0
 
virtual bool update (const std::shared_ptr< EndpointModificationData > &endpointModificationData)=0
 

Detailed Description

The interface class for the Endpoint Object.

Constructor & Destructor Documentation

◆ ~EndpointInterface()

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

Destructor.

Member Function Documentation

◆ getAttributes()

virtual avs::AVSDiscoveryEndpointAttributes alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointInterface::getAttributes ( ) const
pure virtual

The getter for the endpoint attributes.

Returns
The EndpointAttributes structure.

Implemented in alexaClientSDK::endpoints::Endpoint.

◆ getCapabilities()

virtual std::unordered_map< avsCommon::avs::CapabilityConfiguration, std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerInterface> > alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointInterface::getCapabilities ( ) const
pure virtual

The getter for the capabilities that are supported by this endpoint.

Returns
The capabilities supported by the endpoint represented by a map of capability configurations and their respective directive handlers.

Implemented in alexaClientSDK::endpoints::Endpoint.

◆ getCapabilityConfigurations()

virtual std::vector<avsCommon::avs::CapabilityConfiguration> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointInterface::getCapabilityConfigurations ( ) const
pure virtual

The getter for the set of CapabilityConfigurations supported by this endpoint.

Returns
The set of CapabilityConfiguration supported by the endpoint.

Implemented in alexaClientSDK::endpoints::Endpoint.

◆ getEndpointId()

virtual EndpointIdentifier alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointInterface::getEndpointId ( ) const
pure virtual

The getter for the endpoint identifier.

Returns
The endpoint identifier.

Implemented in alexaClientSDK::endpoints::Endpoint.

◆ update()

virtual bool alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointInterface::update ( const std::shared_ptr< EndpointModificationData > &  endpointModificationData)
pure virtual

Update the Endpoint Object.

Parameters
endpointModificationDataA pointer to EndpointModificationData used to update the endpoint.
Returns
True if successful, else false.
Note
The implementation of this method should keep thread safe.

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

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