AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::registrationManager::RegistrationManager Class Reference

#include <RegistrationManager.h>

Public Member Functions

 RegistrationManager (std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface > directiveSequencer, std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface > connectionManager, std::shared_ptr< CustomerDataManager > dataManager)
 
virtual ~RegistrationManager ()=default
 
void logout ()
 
void addObserver (std::shared_ptr< RegistrationObserverInterface > observer)
 
void removeObserver (std::shared_ptr< RegistrationObserverInterface > observer)
 

Detailed Description

The RegistrationManager is responsible for logout and deregister actions.

When a user is logging out of the device, the registration manager will close down the AVS connection, cancel ongoing directives and delete any customer data saved in the device.

Constructor & Destructor Documentation

◆ RegistrationManager()

alexaClientSDK::registrationManager::RegistrationManager::RegistrationManager ( std::shared_ptr< avsCommon::sdkInterfaces::DirectiveSequencerInterface directiveSequencer,
std::shared_ptr< avsCommon::sdkInterfaces::AVSConnectionManagerInterface connectionManager,
std::shared_ptr< CustomerDataManager dataManager 
)

RegistrationManager constructor.

Parameters
directiveSequencerObject used to clear directives during logout process.
connectionManagerConnection manager must be disabled during customer logout.
dataManagerObject that manages customer data, which must be cleared during logout.

◆ ~RegistrationManager()

virtual alexaClientSDK::registrationManager::RegistrationManager::~RegistrationManager ( )
virtualdefault

RegistrationManager destructor

Member Function Documentation

◆ addObserver()

void alexaClientSDK::registrationManager::RegistrationManager::addObserver ( std::shared_ptr< RegistrationObserverInterface observer)

Add a new registration observer object which will get notified after the registration state has changed.

Parameters
observerObject to be notified of any registration event.

◆ logout()

void alexaClientSDK::registrationManager::RegistrationManager::logout ( )

Log out current customer. This will clear any persistent data.

◆ removeObserver()

void alexaClientSDK::registrationManager::RegistrationManager::removeObserver ( std::shared_ptr< RegistrationObserverInterface observer)

Remove the given observer object which will no longer get any registration notification.

Parameters
observerObject to be removed from observers set.

The documentation for this class was generated from the following files:

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