![]() |
AlexaClientSDK
1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
using alexaClientSDK::acsdkSampleApplication::SampleApplicationComponent = typedef acsdkManufactory::Component< std::shared_ptr<authorization::cblAuthDelegate::CBLAuthRequesterInterface>, std::shared_ptr<avsCommon::avs::initialization::AlexaClientSDKInit>, std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>, 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<sampleApp::UIManager>, std::shared_ptr<acsdkCryptoInterfaces::CryptoFactoryInterface>, std::shared_ptr<acsdkCryptoInterfaces::KeyStoreInterface> > |
Definition of the Manufactory component for the Sample App.
using alexaClientSDK::acsdkSampleApplication::SampleApplicationOptionsComponent = typedef acsdkManufactory::Component< std::shared_ptr<avsCommon::sdkInterfaces::AuthDelegateInterface>, std::shared_ptr<avsCommon::utils::logger::Logger>, std::shared_ptr<avsCommon::utils::metrics::MetricRecorderInterface>, acsdkManufactory::Import<std::shared_ptr<authorization::cblAuthDelegate::CBLAuthRequesterInterface> >, acsdkManufactory::Import<std::unique_ptr<avsCommon::utils::libcurlUtils::HttpPostInterface> >, acsdkManufactory::Import<std::shared_ptr<avsCommon::utils::DeviceInfo> >, acsdkManufactory::Import<std::shared_ptr<registrationManager::CustomerDataManagerInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkCryptoInterfaces::CryptoFactoryInterface> >, acsdkManufactory::Import<std::shared_ptr<acsdkCryptoInterfaces::KeyStoreInterface> >> |
Definition of a Manufactory Component with default SampleApplication options.
|
static |
UIManagerInterface
factory that just forwards the instance of UIManager.
uiManager | The UIManager instance that will provide the implementation. |
CBLAuthRequesterInterface
to use.
|
static |
Returns a component for AuthDelegateInterface
, using a pre-built implementation if available but otherwise using the Sample App's default.
authDelegate | Optional AuthDelegateInterface implementation to inject to the manufactory. |
AuthDelegateInterface
. If a custom authDelegate is provided, add that implementation. Otherwise, use defaults.
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::sdkInterfaces::AuthDelegateInterface > & | authDelegate = nullptr , |
||
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
.
initParams | The InitializationParameters to use when initializing the SDK Sample App. |
requiresShutdownList | The RequiresShutdown vector to which newly instantiated objects can be added. |
authDelegate | Optional pre-built implementation of AuthDelegateInterface to add to the manufactory. Default is nullptr. |
MetricRecorderInterface | Optional pre-built implementation of MetricRecorderInterface to add to the manufactory. Default is nullptr. |
logger | Optional pre-built implementation of Logger to add to the manufactory. Default is nullptr. |
Component
for acsdkSampleApp. This initializes the SDK with the InitializationParameters
. The factory method is primary, meaning it will be called before other factory methods in the manufactory.
The below components specify commonly-changed application options, such as AuthDelegateInterface. Applications may want to replace these components with their own to specify custom implementations. Applications may also directly pass pre-built custom implementations of AuthDelegateInterface, Logger, or MetricRecorderInterface to the SampleApplicationOptionsComponent.
These interfaces are implemented for the Sample App, but applications may want to customize these (e.g. the CBLAuthRequesterInterface).
These objects are shared by many components in the SDK. Applications are not expected to change these.
This initializes the SDK with the InitializationParameters
. The factory method is primary, meaning it will be called before other factory methods in the manufactory.
The below components specify commonly-changed application options, such as AuthDelegateInterface. Applications may want to replace these components with their own to specify custom implementations. Applications may also directly pass pre-built custom implementations of AuthDelegateInterface, Logger, or MetricRecorderInterface to the SampleApplicationOptionsComponent.
These interfaces are implemented for the Sample App, but applications may want to customize these (e.g. the CBLAuthRequesterInterface).
These objects are shared by many components in the SDK. Applications are not expected to change these.
|
static |
Function that returns a factory to instantiate LocaleAssetsManagerInterface
.
requiresShutdownList | - The vector of RequiresShutdown pointers to which the LocaleAssetsManager will be added. |
LocaleAssetsManagerInterface
.
|
static |
Returns a component for Logger
, using a pre-built implementation if available but otherwise using the Sample App's default.
logger | Optional Logger implementation to inject to the manufactory. |
Logger
.
|
static |
Returns a component for MetricRecorderInterface
, using a pre-built implementation if available but otherwise using the Sample App's default.
metricRecorder | Optional MetricRecorderInterface implementation to inject to the manufactory. |
MetricRecorderInterface
. If a custom metricRecorder is provided, add that implementation. Otherwise, use defaults.
SampleApplicationOptionsComponent alexaClientSDK::acsdkSampleApplication::getSampleApplicationOptionsComponent | ( | const std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterface > & | authDelegate = nullptr , |
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
.
authDelegate | Optional pre-built implementation of AuthDelegateInterface to add to the manufactory. Default is nullptr. |
metricRecorder | Optional pre-built implementation of MetricRecorderInterface to add to the manufactory. Default is nullptr. |
logger | Optional pre-built implementation of Logger to add to the manufactory. Default is nullptr. |
Manufactory
Component
for the default SampleApplication
options AlexaClientSDK 1.26.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0