AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Typedefs | Functions
alexaClientSDK::acsdkSampleApplication Namespace Reference

Typedefs

using SampleApplicationOptionsComponent = acsdkManufactory::Component< std::shared_ptr< avsCommon::utils::logger::Logger >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > >
 
using SampleApplicationComponent = acsdkManufactory::Component< std::shared_ptr< acsdkAuthorizationInterfaces::lwa::CBLAuthorizationObserverInterface >, std::shared_ptr< avsCommon::avs::initialization::AlexaClientSDKInit >, std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface >, std::shared_ptr< avsCommon::sdkInterfaces::LocaleAssetsManagerInterface >, std::shared_ptr< avsCommon::utils::DeviceInfo >, std::shared_ptr< avsCommon::utils::configuration::ConfigurationNode >, std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface >, std::shared_ptr< registrationManager::CustomerDataManagerInterface >, std::shared_ptr< sampleApplications::common::UIManager >, std::shared_ptr< cryptoInterfaces::CryptoFactoryInterface >, std::shared_ptr< cryptoInterfaces::KeyStoreInterface > >
 

Functions

SampleApplicationOptionsComponent getSampleApplicationOptionsComponent (const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder=nullptr, const std::shared_ptr< avsCommon::utils::logger::Logger > &logger=nullptr)
 
SampleApplicationComponent getComponent (std::unique_ptr< avsCommon::avs::initialization::InitializationParameters > initParams, std::vector< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &requiresShutdownList, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder=nullptr, const std::shared_ptr< avsCommon::utils::logger::Logger > &logger=nullptr)
 

Typedef Documentation

◆ SampleApplicationComponent

Definition of the Manufactory component for the Sample App.

◆ SampleApplicationOptionsComponent

Definition of a Manufactory Component with default SampleApplication options.

Function Documentation

◆ getComponent()

SampleApplicationComponent alexaClientSDK::acsdkSampleApplication::getComponent ( std::unique_ptr< avsCommon::avs::initialization::InitializationParameters initParams,
std::vector< std::shared_ptr< avsCommon::utils::RequiresShutdown >> &  requiresShutdownList,
const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder = nullptr,
const std::shared_ptr< avsCommon::utils::logger::Logger > &  logger = nullptr 
)

Get the manufactory Component for acsdkSampleApp.

For applications that have not transitioned to using the manufactory to instantiate SDK components, they can provide pre-built custom implementations of the AuthDelegateInterface and MetricRecorderInterface.

Parameters
initParamsThe InitializationParameters to use when initializing the SDK Sample App.
requiresShutdownListThe RequiresShutdown vector to which newly instantiated objects can be added.
MetricRecorderInterfaceOptional pre-built implementation of MetricRecorderInterface to add to the manufactory. Default is nullptr.
loggerOptional pre-built implementation of Logger to add to the manufactory. Default is nullptr.
Returns
The manufactory Component for acsdkSampleApp.

◆ getSampleApplicationOptionsComponent()

SampleApplicationOptionsComponent alexaClientSDK::acsdkSampleApplication::getSampleApplicationOptionsComponent ( const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder = nullptr,
const std::shared_ptr< avsCommon::utils::logger::Logger > &  logger = nullptr 
)

Get the Manufactory Component for the default SampleApplication options.

For applications that have not transitioned to using the manufactory to instantiate SDK components, they can provide pre-built custom implementations of the AuthDelegateInterface and MetricRecorderInterface.

Parameters
metricRecorderOptional pre-built implementation of MetricRecorderInterface to add to the manufactory. Default is nullptr.
loggerOptional pre-built implementation of Logger to add to the manufactory. Default is nullptr.
Returns
The Manufactory Component for the default SampleApplication options

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0