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

#include <PostConnectOperationProviderRegistrarInterface.h>

Inheritance diagram for alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~PostConnectOperationProviderRegistrarInterface ()=default
 
virtual bool registerProvider (const std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > &provider)=0
 
virtual avsCommon::utils::Optional< std::vector< std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > > > getProviders ()=0
 

Detailed Description

Class to accumulate the set of PostConnectOperationProviderInterface instances to be invoked when creating a connection to AVS.

Constructor & Destructor Documentation

◆ ~PostConnectOperationProviderRegistrarInterface()

virtual alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface::~PostConnectOperationProviderRegistrarInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getProviders()

virtual avsCommon::utils::Optional< std::vector<std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationProviderInterface> > > alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface::getProviders ( )
pure virtual

Get the set of PostConnectOperationProviderInterface instances to be invoked when creating a connection to AVS.

Returns
An Optional vector of PostConnectOperationProviderInterface instances. If this method is invoked before startup the Optional object returned will have not value.

Implemented in alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar.

◆ registerProvider()

virtual bool alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface::registerProvider ( const std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > &  provider)
pure virtual

Add a new PostConnectOperationProviderInterface instances to be invoked when creating a connection to AVS.

Parameters
providerThe PostConnectOperationProviderInterface instance to add.
Returns
Whether the operation was successful. This operation will fail if this is called after startup.

Implemented in alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar.


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

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