#include <EndpointModificationData.h>

Collaboration diagram for alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData:

Public Member Functions
	EndpointModificationData (const EndpointIdentifier &endpointIdentifier, utils::Optional< avs::AVSDiscoveryEndpointAttributes > updatedEndpointAttributes, const std::vector< avs::CapabilityConfiguration > &updatedConfigurations, const std::vector< std::pair< avs::CapabilityConfiguration, std::shared_ptr< DirectiveHandlerInterface >>> &capabilitiesToAdd, const std::vector< avs::CapabilityConfiguration > &capabilitiesToRemove, const std::list< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &capabilitiesToShutDown)

Public Attributes
EndpointIdentifier	endpointIdentifier
	The `EndpointIdentifier` of the given endpoint. More...

utils::Optional< avs::AVSDiscoveryEndpointAttributes >	updatedEndpointAttributes

std::vector< avs::CapabilityConfiguration >	updatedConfigurations
	The list of modified existing `CapabilityConfiguration`. More...

std::vector< std::pair< avs::CapabilityConfiguration, std::shared_ptr< DirectiveHandlerInterface > > >	capabilitiesToAdd
	The list of capabilities needed to add. More...

std::vector< avs::CapabilityConfiguration >	capabilitiesToRemove
	The list of capabilities needed to remove. More...

std::list< std::shared_ptr< avsCommon::utils::RequiresShutdown > >	capabilitiesToShutDown

Detailed Description

A struct to contain all changes to be made to a given endpoint.

Constructor & Destructor Documentation

◆ EndpointModificationData()

alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::EndpointModificationData	(	const EndpointIdentifier &	endpointIdentifier,
		utils::Optional< avs::AVSDiscoveryEndpointAttributes >	updatedEndpointAttributes,
		const std::vector< avs::CapabilityConfiguration > &	updatedConfigurations,
		const std::vector< std::pair< avs::CapabilityConfiguration, std::shared_ptr< DirectiveHandlerInterface >>> &	capabilitiesToAdd,
		const std::vector< avs::CapabilityConfiguration > &	capabilitiesToRemove,
		const std::list< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &	capabilitiesToShutDown
	)

inline

Member Data Documentation

◆ capabilitiesToAdd

std::vector<std::pair<avs::CapabilityConfiguration, std::shared_ptr<DirectiveHandlerInterface> > > alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::capabilitiesToAdd

The list of capabilities needed to add.

◆ capabilitiesToRemove

std::vector<avs::CapabilityConfiguration> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::capabilitiesToRemove

The list of capabilities needed to remove.

◆ capabilitiesToShutDown

std::list<std::shared_ptr<avsCommon::utils::RequiresShutdown> > alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::capabilitiesToShutDown

The list of newly added capabilities which implement the RequireShutdown needed to shut down.

Note: This list should be a sub list of capabilitiesToAdd.

◆ endpointIdentifier

EndpointIdentifier alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::endpointIdentifier

The EndpointIdentifier of the given endpoint.

◆ updatedConfigurations

std::vector<avs::CapabilityConfiguration> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::updatedConfigurations

The list of modified existing CapabilityConfiguration.

◆ updatedEndpointAttributes

utils::Optional<avs::AVSDiscoveryEndpointAttributes> alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointModificationData::updatedEndpointAttributes

The new AVSDiscoveryEndpointAttribute.

Note: This updatedEndpointAttributes will completely replace the current existing AVSDiscoveryEndpointAttributes of the given endpoint.

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

/workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/Endpoints/EndpointModificationData.h

Public Member Functions

Public Attributes