AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::aplCapabilityAgent::AlexaPresentationAPLFactory Class Reference

#include <AlexaPresentationAPLFactory.h>

Public Member Functions

 ~AlexaPresentationAPLFactory ()=default
 

Static Public Member Functions

static avsCommon::utils::Optional< AlexaPresentationAPLAgentData > create (std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface > exceptionSender, std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface > metricRecorder, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface > messageSender, std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface > contextManager, std::string APLVersion, std::shared_ptr< alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface > visualStateProvider=nullptr)
 

Detailed Description

The AlexaPresentationAPLFactory is responsible to create the objects that interacts with AlexaPresentationAPL CA

Constructor & Destructor Documentation

◆ ~AlexaPresentationAPLFactory()

alexaClientSDK::aplCapabilityAgent::AlexaPresentationAPLFactory::~AlexaPresentationAPLFactory ( )
default

Destructor.

Member Function Documentation

◆ create()

static avsCommon::utils::Optional<AlexaPresentationAPLAgentData> alexaClientSDK::aplCapabilityAgent::AlexaPresentationAPLFactory::create ( std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ExceptionEncounteredSenderInterface exceptionSender,
std::shared_ptr< alexaClientSDK::avsCommon::utils::metrics::MetricRecorderInterface metricRecorder,
std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::MessageSenderInterface messageSender,
std::shared_ptr< alexaClientSDK::avsCommon::sdkInterfaces::ContextManagerInterface contextManager,
std::string  APLVersion,
std::shared_ptr< alexaClientSDK::aplCapabilityCommonInterfaces::VisualStateProviderInterface visualStateProvider = nullptr 
)
static

Create an instance of AlexaPresentationAPL.

Parameters
exceptionSenderThe ExceptionEncounteredSenderInterface that sends Exception messages to AVS.
metricRecorderThe object MetricRecorderInterface that records metrics.
messageSenderThe MessageSenderInterface that sends events to AVS.
contextManagerThe ContextManagerInterface used to generate system context for events.
APLVersionThe APLVersion supported by the runtime component.
visualStateProviderThe VisualStateProviderInterface used to request visual context.

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