alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar Class Reference

#include <PostConnectOperationProviderRegistrar.h>

Inheritance diagram for alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar:

Collaboration diagram for alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar:

Public Member Functions
PostConnectOperationProviderRegistrarInterface methods.
bool	registerProvider (const std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > &provider) override
avsCommon::utils::Optional< std::vector< std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > > >	getProviders () override
RequiresStartupInterface methods
bool	startup () override
Public Member Functions inherited from alexaClientSDK::acsdkStartupManagerInterfaces::RequiresStartupInterface
virtual	~RequiresStartupInterface ()=default
Public Member Functions inherited from alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface
virtual	~PostConnectOperationProviderRegistrarInterface ()=default

Static Public Member Functions
static std::shared_ptr< acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface >	createPostConnectOperationProviderRegistrarInterface (const std::shared_ptr< acsdkStartupManagerInterfaces::StartupNotifierInterface > &startupNotifier)

Detailed Description

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

Member Function Documentation

createPostConnectOperationProviderRegistrarInterface()

static std::shared_ptr< acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface> alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar::createPostConnectOperationProviderRegistrarInterface ( const std::shared_ptr< acsdkStartupManagerInterfaces::StartupNotifierInterface > &  startupNotifier )

static

Create a new instance of PostConnectOperationProviderRegistrar.

Parameters

startupNotifier

The object to register with the receive startup notifications.

Returns

A new instance of PostConnectOperationProviderRegistrar.

getProviders()

avsCommon::utils::Optional< std::vector<std::shared_ptr<avsCommon::sdkInterfaces::PostConnectOperationProviderInterface> > > alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar::getProviders ( )

overridevirtual

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.

Implements alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface.

registerProvider()

bool alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar::registerProvider ( const std::shared_ptr< avsCommon::sdkInterfaces::PostConnectOperationProviderInterface > &  provider )

overridevirtual

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

Parameters

provider

The PostConnectOperationProviderInterface instance to add.

Returns

Whether the operation was successful. This operation will fail if this is called after startup.

Implements alexaClientSDK::acsdkPostConnectOperationProviderRegistrarInterfaces::PostConnectOperationProviderRegistrarInterface.

startup()

bool alexaClientSDK::acsdkPostConnectOperationProviderRegistrar::PostConnectOperationProviderRegistrar::startup ( )

overridevirtual

Perform a startup operation.

Returns

Whether startup should continue.

Implements alexaClientSDK::acsdkStartupManagerInterfaces::RequiresStartupInterface.

---

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

• /workplace/avs-device-sdk/core/acsdkPostConnectOperationProviderRegistrar/include/acsdkPostConnectOperationProviderRegistrar/PostConnectOperationProviderRegistrar.h