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

Namespaces

 test
 

Classes

class  CustomerDataHandler
 
class  CustomerDataHandlerInterface
 
class  CustomerDataManagerFactory
 
class  CustomerDataManagerInterface
 
class  MockCustomerDataManager
 
class  RegistrationManagerInterface
 
class  RegistrationObserverInterface
 

Typedefs

using RegistrationNotifierInterface = notifierInterfaces::NotifierInterface< RegistrationObserverInterface >
 

Functions

acsdkManufactory::Component< std::shared_ptr< registrationManager::CustomerDataManagerInterface >, std::shared_ptr< registrationManager::RegistrationManagerInterface >, std::shared_ptr< registrationManager::RegistrationNotifierInterface >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > > > getComponent ()
 
acsdkManufactory::Component< std::shared_ptr< registrationManager::RegistrationManagerInterface >, std::shared_ptr< registrationManager::RegistrationNotifierInterface >, acsdkManufactory::Import< std::shared_ptr< registrationManager::CustomerDataManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > > > getBackwardsCompatibleComponent ()
 
std::shared_ptr< registrationManager::RegistrationManagerInterfacecreateRegistrationManager (const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &customerDataManager, const std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &connectionManager, const std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > &directiveSequencer, const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &metricRecorder, const std::shared_ptr< registrationManager::RegistrationNotifierInterface > &notifier)
 
std::shared_ptr< registrationManager::RegistrationNotifierInterfacecreateRegistrationNotifier ()
 

Typedef Documentation

◆ RegistrationNotifierInterface

Interface for registering to observe changes to RegistrationManager.

Function Documentation

◆ createRegistrationManager()

std::shared_ptr<registrationManager::RegistrationManagerInterface> alexaClientSDK::registrationManager::createRegistrationManager ( const std::shared_ptr< registrationManager::CustomerDataManagerInterface > &  customerDataManager,
const std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > &  connectionManager,
const std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > &  directiveSequencer,
const std::shared_ptr< avsCommon::utils::metrics::MetricRecorderInterface > &  metricRecorder,
const std::shared_ptr< registrationManager::RegistrationNotifierInterface > &  notifier 
)

Creates a new instance of RegistrationManagerInterface.

Parameters
customerDataManagerThe CustomerDataManagerInterface to handle customer data handlers.
connectionManagerThe AVSConnectionManagerInterface to handle connection with AVS.
directiveSequencerThe DirectiveSequencerInterface to handle AVSDirective instances.
metricRecorderThe MetricRecorderInterface to record metrics to send to sinks.
notifierThe RegistrationNotifierInterface to observe changes to the RegistrationManager.
Returns
A pointer to the RegistrationManagerInterface.

◆ createRegistrationNotifier()

std::shared_ptr<registrationManager::RegistrationNotifierInterface> alexaClientSDK::registrationManager::createRegistrationNotifier ( )

Creates a new instance of RegistrationNotifierInterface.

Returns
A pointer to the RegistrationNotifierInterface.

◆ getBackwardsCompatibleComponent()

Creates a manufactory component that exports RegistrationManager related implementation.

Deprecated:
This is for backwards compatibility only to allow the application to inject an CustomerDataManagerInterface. Prefer getComponent instead.
Returns
A component.

◆ getComponent()

Creates a manufactory component that exports RegistrationManager related implementation.

Returns
A component.

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