alexaClientSDK::acsdkAlexaLauncher::AlexaLauncherFactory Class Reference

#include <AlexaLauncherFactory.h>

Classes
struct	AlexaLauncherCapabilityAgentData

Static Public Member Functions
static avsCommon::utils::Optional< AlexaLauncherCapabilityAgentData >	create (const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &endpointId, std::shared_ptr< acsdkAlexaLauncherInterfaces::AlexaLauncherInterface > launcher, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &exceptionSender, bool isProactivelyReported, bool isRetrievable)

Detailed Description

This factory can be used to create a new AlexaLauncherCapabilityAgent and return a generic object that contains certain interfaces which can be used for registering this capability agent to an endpoint.

Member Function Documentation

create()

static avsCommon::utils::Optional<AlexaLauncherCapabilityAgentData> alexaClientSDK::acsdkAlexaLauncher::AlexaLauncherFactory::create ( const avsCommon::sdkInterfaces::endpoints::EndpointIdentifier &  endpointId, std::shared_ptr< acsdkAlexaLauncherInterfaces::AlexaLauncherInterface >  launcher, const std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > &  contextManager, const std::shared_ptr< avsCommon::sdkInterfaces::AlexaInterfaceMessageSenderInterface > &  responseSender, const std::shared_ptr< avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > &  exceptionSender, bool  isProactivelyReported, bool  isRetrievable  )

static

Creates a new AlexaLauncher capability agent configuration.

Parameters

endpointId	A endpoint to which this capability is associated.
launcher	An interface that this object will use to perform the launcher operations.
contextManager	An interface to which this object will send property state updates.
responseSender	An interface that this object will use to send the response to AVS.
exceptionSender	An interface to report exceptions to AVS.
isProactivelyReported	Whether property changes are proactively reported to Alexa in a change report.
isRetrievable	Whether properties can be retrieved when Alexa sends a state report request to the endpoint.

Returns

An Optional object with no valid value if the inputs are invalid, else a new AlexaLauncherCapabilityAgentData object.

---

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

• /workplace/avs-device-sdk/capabilities/AlexaLauncher/acsdkAlexaLauncher/include/acsdkAlexaLauncher/AlexaLauncherFactory.h