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

#include <AlexaPresentationFeatureClientBuilder.h>

Inheritance diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder:
Collaboration graph
[legend]

Public Member Functions

std::shared_ptr< AlexaPresentationFeatureClientconstruct (const std::shared_ptr< sdkClient::SDKClientRegistry > &sdkClientRegistry)
 
std::string name () override
 
- Public Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
virtual ~FeatureClientBuilderInterface ()=default
 

Static Public Member Functions

static std::unique_ptr< AlexaPresentationFeatureClientBuildercreate (std::string aplVersion, std::shared_ptr< aplCapabilityCommonInterfaces::VisualStateProviderInterface > stateProviderInterface)
 

Additional Inherited Members

- Protected Member Functions inherited from alexaClientSDK::sdkClient::FeatureClientBuilderInterface
template<typename ComponentType >
ACSDK_INLINE_VISIBILITY void addRequiredType ()
 

Detailed Description

The AlexaPresentationFeatureClientBuilder builder class is responsible for creating an instance of the AlexaPresentationFeatureClient and is intended to be used with the SDKClientBuilder and SDKClientRegistry. It constructs the AlexaPresentation and AlexaPresentationAPL capabilities.

It requires the ExceptionEncounteredSenderInterface, AVSConnectionManagerInterface, EndpointBuilderInterface, MetricRecorderInterface and ContextManagerInterface components from the SDKClientRegistry which can be provided by DefaultClient

Member Function Documentation

◆ construct()

std::shared_ptr<AlexaPresentationFeatureClient> alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder::construct ( const std::shared_ptr< sdkClient::SDKClientRegistry > &  sdkClientRegistry)

Construct an instance of the AlexaPresentationFeatureClient

Parameters
sdkClientRegistryThe SDKClientRegistry object
Returns
An instance of the AlexaPresentationFeatureClient, or nullptr if construction failed

◆ create()

static std::unique_ptr<AlexaPresentationFeatureClientBuilder> alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder::create ( std::string  aplVersion,
std::shared_ptr< aplCapabilityCommonInterfaces::VisualStateProviderInterface stateProviderInterface 
)
static

Create an instance of the AlexaPresentationFeatureClientBuilder

Parameters
aplVersionThe APL Version supported by the device
stateProviderInterfacePointer to the visual state provider
Returns
Pointer to the feature client builder, or nullptr if creation failed

◆ name()

std::string alexaClientSDK::featureClient::AlexaPresentationFeatureClientBuilder::name ( )
overridevirtual

FeatureClientBuilderInterface functions

Implements alexaClientSDK::sdkClient::FeatureClientBuilderInterface.


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