AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::sdkClient::FeatureClientInterface Class Referenceabstract

#include <FeatureClientInterface.h>

Inheritance diagram for alexaClientSDK::sdkClient::FeatureClientInterface:
Inheritance graph
Collaboration diagram for alexaClientSDK::sdkClient::FeatureClientInterface:
Collaboration graph

Public Member Functions

 FeatureClientInterface (const std::string &name)
virtual bool configure (const std::shared_ptr< SDKClientRegistry > &sdkClientRegistry)=0
virtual ~FeatureClientInterface ()=default
 Destructor. More...
- Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
 RequiresShutdown (const std::string &name)
virtual ~RequiresShutdown ()
 Destructor. More...
const std::string & name () const
void shutdown ()
bool isShutdown () const

Additional Inherited Members

- Protected Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
virtual void doShutdown ()=0

Detailed Description

The FeatureClientInterface must be implemented by feature clients which expose additional capabilities to applications utilizing the AVS SDK. To allow feature clients to be added to the SDKClientRegistry (directly or through the SDKClientBuilder) a matching feature client builder which implements the FeatureClientBuilderInterface and which constructs the feature client should be implemented.

Constructor & Destructor Documentation

◆ FeatureClientInterface()

alexaClientSDK::sdkClient::FeatureClientInterface::FeatureClientInterface ( const std::string &  name)


nameThe name of the class

◆ ~FeatureClientInterface()

virtual alexaClientSDK::sdkClient::FeatureClientInterface::~FeatureClientInterface ( )


Member Function Documentation

◆ configure()

virtual bool alexaClientSDK::sdkClient::FeatureClientInterface::configure ( const std::shared_ptr< SDKClientRegistry > &  sdkClientRegistry)
pure virtual

Perform any addition configuration on the client, called after all clients have been built successfully.

sdkClientRegistryReference to the SDKClientRegistry
true if successful

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0