#include <EndpointBuilder.h>

Inheritance diagram for alexaClientSDK::endpoints::EndpointBuilder:

Collaboration diagram for alexaClientSDK::endpoints::EndpointBuilder:

Public Types

using	EndpointAttributes = avsCommon::avs::AVSDiscoveryEndpointAttributes

using	EndpointIdentifier = avsCommon::sdkInterfaces::endpoints::EndpointIdentifier

using	EndpointInterface = avsCommon::sdkInterfaces::endpoints::EndpointInterface

using	CapabilityConfiguration = avsCommon::avs::CapabilityConfiguration

using	DirectiveHandlerInterface = avsCommon::sdkInterfaces::DirectiveHandlerInterface

Public Member Functions
virtual	~EndpointBuilder ()

void	finalizeAttributes ()

@c EndpointBuilderInterface methods.
EndpointBuilder &	withDerivedEndpointId (const std::string &suffix) override

EndpointBuilder &	withDeviceRegistration () override

EndpointBuilder &	withEndpointId (const EndpointIdentifier &endpointId) override

EndpointBuilder &	withFriendlyName (const std::string &friendlyName) override

EndpointBuilder &	withDescription (const std::string &description) override

EndpointBuilder &	withManufacturerName (const std::string &manufacturerName) override

EndpointBuilder &	withDisplayCategory (const std::vector< std::string > &displayCategories) override

EndpointBuilder &	withAdditionalAttributes (const std::string &manufacturer, const std::string &model, const std::string &serialNumber, const std::string &firmwareVersion, const std::string &softwareVersion, const std::string &customIdentifier) override

EndpointBuilder &	withConnections (const std::vector< std::map< std::string, std::string >> &connections) override

EndpointBuilder &	withCookies (const std::map< std::string, std::string > &cookies) override

EndpointBuilder &	withPowerController (std::shared_ptr< avsCommon::sdkInterfaces::powerController::PowerControllerInterface > powerController, bool isProactivelyReported, bool isRetrievable) override

EndpointBuilder &	withToggleController (std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface > toggleController, const std::string &instance, const avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes &toggleControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false) override

EndpointBuilder &	withEndpointCapabilitiesBuilder (const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface > &endpointCapabilitiesBuilder) override

EndpointBuilder &	withModeController (std::shared_ptr< avsCommon::sdkInterfaces::modeController::ModeControllerInterface > modeController, const std::string &instance, const avsCommon::sdkInterfaces::modeController::ModeControllerAttributes &modeControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false) override

EndpointBuilder &	withRangeController (std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerInterface > rangeController, const std::string &instance, const avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes &rangeControllerAttributes, bool isProactivelyReported, bool isRetrievable, bool isNonControllable=false) override

EndpointBuilder &	withCapability (const CapabilityConfiguration &configuration, std::shared_ptr< DirectiveHandlerInterface > directiveHandler) override

EndpointBuilder &	withCapability (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface, std::shared_ptr< DirectiveHandlerInterface > directiveHandler) override

EndpointBuilder &	withCapabilityConfiguration (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface) override

std::unique_ptr< EndpointInterface >	build () override

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface
virtual	~EndpointBuilderInterface ()=default

virtual EndpointBuilderInterface &	withEndpointCapabilitiesBuilder (const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface > &endpointCapabilitiesBuilder)=0

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface
virtual	~EndpointCapabilitiesRegistrarInterface ()=default

virtual EndpointCapabilitiesRegistrarInterface &	withCapability (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface, std::shared_ptr< DirectiveHandlerInterface > directiveHandler)=0

virtual EndpointCapabilitiesRegistrarInterface &	withCapabilityConfiguration (const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &configurationInterface)=0

Static Public Member Functions
static std::unique_ptr< EndpointBuilder >	create (const std::shared_ptr< avsCommon::utils::DeviceInfo > &deviceInfo, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, const std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface > &alexaMessageSender)

static std::unique_ptr< EndpointBuilder >	create (const avsCommon::utils::DeviceInfo &deviceInfo, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface > alexaMessageSender)

Detailed Description

Interface for an endpoint builder.

For the default endpoint, use DefaultEndpointBuilder.

The builder is responsible for configuring and building an endpoint object. Once built, EndpointRegistrationManagerInterface should be used to register the endpoint with AVS for it to be ready to use.

Member Typedef Documentation

◆ CapabilityConfiguration

using alexaClientSDK::endpoints::EndpointBuilder::CapabilityConfiguration = avsCommon::avs::CapabilityConfiguration

Alias to improve readability.

◆ DirectiveHandlerInterface

using alexaClientSDK::endpoints::EndpointBuilder::DirectiveHandlerInterface = avsCommon::sdkInterfaces::DirectiveHandlerInterface

Alias to improve readability.

◆ EndpointAttributes

using alexaClientSDK::endpoints::EndpointBuilder::EndpointAttributes = avsCommon::avs::AVSDiscoveryEndpointAttributes

Alias to improve readability.

◆ EndpointIdentifier

using alexaClientSDK::endpoints::EndpointBuilder::EndpointIdentifier = avsCommon::sdkInterfaces::endpoints::EndpointIdentifier

Alias to improve readability.

◆ EndpointInterface

using alexaClientSDK::endpoints::EndpointBuilder::EndpointInterface = avsCommon::sdkInterfaces::endpoints::EndpointInterface

Alias to improve readability.

Constructor & Destructor Documentation

◆ ~EndpointBuilder()

virtual alexaClientSDK::endpoints::EndpointBuilder::~EndpointBuilder ( )

virtual

Destructor.

Member Function Documentation

◆ build()

std::unique_ptr<EndpointInterface> alexaClientSDK::endpoints::EndpointBuilder::build ( )

overridevirtual

Builds an endpoint with the configured properties / components.

Build will fail iff the format of any attribute is invalid or if a mandatory attribute is missing.

Returns: A unique endpoint if the build succeeds; otherwise, nullptr.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ create() [1/2]

static std::unique_ptr<EndpointBuilder> alexaClientSDK::endpoints::EndpointBuilder::create	(	const std::shared_ptr< avsCommon::utils::DeviceInfo > &	deviceInfo,
		const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &	contextManager,
		const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &	exceptionSender,
		const std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface > &	alexaMessageSender
	)

static

Creates an EndpointBuilder.

Parameters

deviceInfo	Structure with information about the Alexa client device.
contextManager	Object used to retrieve the current state of an endpoint.
exceptionSender	Object used to send exceptions.
alexaInterfaceMessageSender	Object used to send AlexaInterface events.

Returns: A pointer to the new builder if it succeeds; otherwise, return nullptr.

◆ create() [2/2]

static std::unique_ptr<EndpointBuilder> alexaClientSDK::endpoints::EndpointBuilder::create	(	const avsCommon::utils::DeviceInfo &	deviceInfo,
		std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >	contextManager,
		std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface >	exceptionSender,
		std::shared_ptr< capabilityAgents::alexa::AlexaInterfaceMessageSenderInternalInterface >	alexaMessageSender
	)

static

Creates an EndpointBuilder.

Deprecated:

Parameters

deviceInfo	Structure with information about the Alexa client device.
contextManager	Object used to retrieve the current state of an endpoint.
exceptionSender	Object used to send exceptions.
alexaInterfaceMessageSender	Object used to send AlexaInterface events.

Returns: A pointer to the new builder if it succeeds; otherwise, return nullptr.

◆ finalizeAttributes()

void alexaClientSDK::endpoints::EndpointBuilder::finalizeAttributes ( )

Finalize attributes.

Once called, this builder will no longer allow endpoint attribute related configurations to be set. This allows applications to add more capabilities to the endpoint without changing its attributes.

◆ withAdditionalAttributes()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withAdditionalAttributes	(	const std::string &	manufacturer,
		const std::string &	model,
		const std::string &	serialNumber,
		const std::string &	firmwareVersion,
		const std::string &	softwareVersion,
		const std::string &	customIdentifier
	)

overridevirtual

Configures builder to set additional attributes that can be used to identify an endpoint.

Note: This will override any previous additional attributes configuration.; The builder will fail if any of the additional attributes params are invalid.

Parameters

manufacturer	The name of the manufacturer of the device.
model	The name of the model of the device.
serialNumber	The serial number of the device.
firmwareVersion	The firmware version of the device.
softwareVersion	The software version of the device.
customIdentifier	Your custom identifier for the device.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withCapability() [1/2]

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withCapability	(	const CapabilityConfiguration &	configuration,
		std::shared_ptr< DirectiveHandlerInterface >	directiveHandler
	)

overridevirtual

Adds a capability.

Parameters

configuration	The capability configuration.
directiveHandler	The handler for the directives in the given namespace.

Returns: This registrar which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface.

◆ withCapability() [2/2]

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withCapability	(	const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > &	configurationInterface,
		std::shared_ptr< DirectiveHandlerInterface >	directiveHandler
	)

override

◆ withCapabilityConfiguration()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withCapabilityConfiguration ( const std::shared_ptr< avsCommon::sdkInterfaces::CapabilityConfigurationInterface > & configurationInterface )

override

◆ withConnections()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withConnections ( const std::vector< std::map< std::string, std::string >> & connections )

overridevirtual

Configures builder to represent the methods that the endpoint uses to connect to the internet of smart home hub.

Note: This will override any previous connections configuration.; If the connections supplied is invalid, the builder will fail.

Parameters

connections The available connection methods and their attributes.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withCookies()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withCookies ( const std::map< std::string, std::string > & cookies )

overridevirtual

Configures builder to store custom key value pair about the device.

Note: This will override any previous cookies configuration.; If the cookies supplied is invalid, the builder will fail.

Parameters

cookies Key value pairs for additional of the endpoint.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withDerivedEndpointId()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withDerivedEndpointId ( const std::string & suffix )

overridevirtual

Configures builder to use an endpointId that is generated using the default endpoint id and the given suffix.

Note: This will override any previous endpoint identifier configuration.; This function will use the suffix to generate a unique identifier for endpoints that represent a component of the same device the client is running on. For example, if your device has a screen, you can create an endpoint to control this screen and use "screen" as a suffix. The suffix must be unique for this client and it must be consistent for every client execution.; The suffix can contain letters or numbers, spaces, and the following special characters: _ - = # ; : ? @ & and it should not exceed 10 characters.

Warning: Do not use this function if endpoint being created can be controlled by different AVS clients. The endpoint identifier must be consistent for every endpoint independently from the client that is controlling it.

Parameters

suffix A suffix that should be unique for the given client. The build() function fails if it exceeds 10 characters. If the suffix is not unique, the newly-built endpoint will replace the previous endpoint which had the same suffix when registered.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withDescription()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withDescription ( const std::string & description )

overridevirtual

Configures builder to use the given description.

Note: This will override any previous description configuration.; This value can contain up to 128 characters.; The builder will fail if the description param is invalid.

Parameters

description The description of the endpoint.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withDeviceRegistration()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withDeviceRegistration ( )

overridevirtual

Includes default Registration information to the endpoint.

Note: This will include default endpoint's registration information into the endpoint. When this payload is included into the endpoint's discovery, cloud will be able to tell this endpoint represents the same device that the client is running on.

Warning: Do not use this function unless you want the new endpoint to be treated as same as the AVS endpoint that maintains HTTP2 connection. This function is added to support a legacy case and might be deprecated later. Please be aware of the risk while using this function.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withDisplayCategory()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withDisplayCategory ( const std::vector< std::string > & displayCategories )

overridevirtual

Configures builder to use the following display categories.

Note: This will override any previous display categories configuration.; The builder will fail if the displayCategories param is invalid.

Parameters

description The display category the device belongs to.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withEndpointCapabilitiesBuilder()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withEndpointCapabilitiesBuilder ( const std::shared_ptr< avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesBuilderInterface > & endpointCapabilitiesBuilder )

override

◆ withEndpointId()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withEndpointId ( const EndpointIdentifier & endpointId )

overridevirtual

Configures builder to use the given identifier for the new endpoint.

Note: This will override any previous endpoint identifier configuration.; The identifier must be unique across all devices for the user. Registering an endpoint with the same identifier as an existing endpoint will replace the original endpoint. In addition, the identifier must be consistent for all discovery requests for the same device. An identifier can contain letters or numbers, spaces, and the following special characters: _ - = # ; : ? @ &. The identifier cannot exceed 256 characters.; The builder will fail if the endpointId param is invalid.

Parameters

endpointId An endpointId that identifies this endpoint.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withFriendlyName()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withFriendlyName ( const std::string & friendlyName )

overridevirtual

Configures builder to use the given friendly name.

Note: This will override any previous friendly name configuration.; This value can contain up to 128 characters.

Parameters

friendlyName The friendly name used to identify the endpoint.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withManufacturerName()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withManufacturerName ( const std::string & manufacturerName )

overridevirtual

Configures builder to use name of the device manufacturer representing the endpoint.

Note: This will override any previous manufacturer configuration.; This value can contain up to 128 characters.; The builder will fail if the manufacturer name param is invalid.

Parameters

description The manufacturer name of the device representing the endpoint.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withModeController()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withModeController	(	std::shared_ptr< avsCommon::sdkInterfaces::modeController::ModeControllerInterface >	modeController,
		const std::string &	instance,
		const avsCommon::sdkInterfaces::modeController::ModeControllerAttributes &	modeControllerAttributes,
		bool	isProactivelyReported,
		bool	isRetrievable,
		bool	isNonControllable = `false`
	)

overridevirtual

Configures builder to use a ModeControllerInterface with instance identifier.

Note: The builder will fail if the instance name is already used in that endpoint.

Deprecated:: use the new withEndpointCapabilitiesBuilder() method instead.

Parameters

modeController	An interface that provides the mode operations.
instance	A non-empty string identifying an instance of a mode controller uniquely in a endpoint.
modeControllerAttributes	The attributes used in capability discovery message.
isProactivelyReported	Whether the property state change is proactively reported.
isRetrievable	Whether the property state is retrievable.
isNonControllable	Whether the property state can be controlled or not. This must be `false` for the property state to be controllable. Default is `false`.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withPowerController()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withPowerController	(	std::shared_ptr< avsCommon::sdkInterfaces::powerController::PowerControllerInterface >	powerController,
		bool	isProactivelyReported,
		bool	isRetrievable
	)

overridevirtual

Configures builder to use a PowerControllerInterface

Deprecated:: use the new withEndpointCapabilitiesBuilder() method instead.

Parameters

powerController	An interface that provides the power operations.
isProactivelyReported	Whether the property state change is proactively reported.
isRetrievable	Whether the property state is retrievable.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withRangeController()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withRangeController	(	std::shared_ptr< avsCommon::sdkInterfaces::rangeController::RangeControllerInterface >	rangeController,
		const std::string &	instance,
		const avsCommon::sdkInterfaces::rangeController::RangeControllerAttributes &	rangeControllerAttributes,
		bool	isProactivelyReported,
		bool	isRetrievable,
		bool	isNonControllable = `false`
	)

overridevirtual

Configures builder to use a RangeControllerInteface with instance identifier.

Note: The builder will fail if the instance name is already used in that endpoint.

Deprecated:: use the new withEndpointCapabilitiesBuilder() method instead.

Parameters

rangeController	An interface that provides the range operations.
instance	A non-empty string identifying an instance of a range controller uniquely in a endpoint.
rangeControllerAttributes	The attributes used in capability discovery message.
isProactivelyReported	Whether the property state change is proactively reported.
isRetrievable	Whether the property state is retrievable.
isNonControllable	Whether the property state can be controlled or not. This must be `false` for the property state to be controllable. Default is `false`.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

◆ withToggleController()

EndpointBuilder& alexaClientSDK::endpoints::EndpointBuilder::withToggleController	(	std::shared_ptr< avsCommon::sdkInterfaces::toggleController::ToggleControllerInterface >	toggleController,
		const std::string &	instance,
		const avsCommon::sdkInterfaces::toggleController::ToggleControllerAttributes &	toggleControllerAttributes,
		bool	isProactivelyReported,
		bool	isRetrievable,
		bool	isNonControllable = `false`
	)

overridevirtual

Configures builder to use a ToggleControllerInterface with instance identifier.

Note: The builder will fail if the instance name is already used in that endpoint.

Deprecated:: use the new withEndpointCapabilitiesBuilder() method instead.

Parameters

toggleController	An interface that performs the toggle operations.
instance	A non-empty string identifying an instance of a toggle controller uniquely in a endpoint.
toggleControllerAttributes	The attributes used in capability discovery message.
isProactivelyReported	Whether the property state change is proactively reported.
isRetrievable	Whether the property state is retrievable.
isNonControllable	Whether the property state can be controlled or not. This must be `false` for the property state to be controllable. Default is `false`.

Returns: This builder which can be used to nest configuration function calls.

Implements alexaClientSDK::avsCommon::sdkInterfaces::endpoints::EndpointBuilderInterface.

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

/workplace/avs-device-sdk/Endpoints/include/Endpoints/EndpointBuilder.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CapabilityConfiguration

◆ DirectiveHandlerInterface

◆ EndpointAttributes

◆ EndpointIdentifier

◆ EndpointInterface

Constructor & Destructor Documentation

◆ ~EndpointBuilder()

Member Function Documentation

◆ build()

◆ create() [1/2]

◆ create() [2/2]

◆ finalizeAttributes()

◆ withAdditionalAttributes()

◆ withCapability() [1/2]

◆ withCapability() [2/2]

◆ withCapabilityConfiguration()

◆ withConnections()

◆ withCookies()

◆ withDerivedEndpointId()

◆ withDescription()

◆ withDeviceRegistration()

◆ withDisplayCategory()

◆ withEndpointCapabilitiesBuilder()

◆ withEndpointId()

◆ withFriendlyName()

◆ withManufacturerName()

◆ withModeController()

◆ withPowerController()

◆ withRangeController()

◆ withToggleController()