AlexaClientSDK  1.26.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::integration::test::ACLTestContext Class Reference

#include <ACLTestContext.h>

Public Member Functions

 ~ACLTestContext ()
 
std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterfacegetAuthDelegate () const
 
std::shared_ptr< registrationManager::CustomerDataManagerInterfacegetCustomerDataManager () const
 
std::shared_ptr< avsCommon::avs::attachment::AttachmentManagergetAttachmentManager () const
 
std::shared_ptr< acl::MessageRoutergetMessageRouter () const
 
std::shared_ptr< ConnectionStatusObservergetConnectionStatusObserver () const
 
std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterfacegetContextManager () const
 
void waitForConnected ()
 
void waitForDisconnected ()
 

Static Public Member Functions

static std::unique_ptr< ACLTestContextcreate (const std::string &filePath, const std::string &overlay="")
 

Detailed Description

Class providing lifecycle management of resources needed for testing ACL or functionality that requires ACL for testing.

Constructor & Destructor Documentation

◆ ~ACLTestContext()

alexaClientSDK::integration::test::ACLTestContext::~ACLTestContext ( )

Destructor. de-initializes all resources acquired during construction.

Member Function Documentation

◆ create()

std::unique_ptr< ACLTestContext > alexaClientSDK::integration::test::ACLTestContext::create ( const std::string &  filePath,
const std::string &  overlay = "" 
)
static

Create an ACLTestContext.

Note
Only one instance of this class should exist at a time - but it is okay (and expected) that multiple instances of this class will be created (and destroyed) during one execution of the application using this class.

Creating an instance of this class provides: Initialization of the Alexa Client SDK (includes @ libcurl and ConfigurationNode. A CustomerDataManager instance. An AuthDelegateInterface instance. An AttachmentManager instance. A ConnectionStatusObserver instance. A ContextManager instance. Initialization of PostConnect.

Parameters
filePathThe path to a config file.
overlayA JSON string containing values to overlay on the contents of the configuration file.
Returns
An ACLTestContext instance or nullptr if the operation failed.

◆ getAttachmentManager()

std::shared_ptr< AttachmentManager > alexaClientSDK::integration::test::ACLTestContext::getAttachmentManager ( ) const

Get the instance of AttachmentManager to use for the test.

Returns
The instance of AttachmentManager to use for the test.

◆ getAuthDelegate()

std::shared_ptr< AuthDelegateInterface > alexaClientSDK::integration::test::ACLTestContext::getAuthDelegate ( ) const

Get the instance of AuthDelegateInterface to use for the test.

Returns
The instance of AuthDelegateInterface to use for the test.

◆ getConnectionStatusObserver()

std::shared_ptr< ConnectionStatusObserver > alexaClientSDK::integration::test::ACLTestContext::getConnectionStatusObserver ( ) const

Get the ConnectionStatusObserver instance to use for the test.

Returns
The ConnectionStatusObserver instance to use for the test.

◆ getContextManager()

std::shared_ptr< ContextManagerInterface > alexaClientSDK::integration::test::ACLTestContext::getContextManager ( ) const

Get the ContextManager instance to use for the test.

Returns
The ContextManager instance to use for the test.

◆ getCustomerDataManager()

std::shared_ptr< CustomerDataManagerInterface > alexaClientSDK::integration::test::ACLTestContext::getCustomerDataManager ( ) const

Get the instance of CustomerDataManager to use for the test.

Returns
The instance of CustomerDataManager to use for the test.

◆ getMessageRouter()

std::shared_ptr< MessageRouter > alexaClientSDK::integration::test::ACLTestContext::getMessageRouter ( ) const

Get the MessageRouter instance to use for the test.

Returns
The MessageRouter instance to use for the test.

◆ waitForConnected()

void alexaClientSDK::integration::test::ACLTestContext::waitForConnected ( )

Wait for the ConnectionStatusObserver to be notified that the client has successfully connected to AVS.

◆ waitForDisconnected()

void alexaClientSDK::integration::test::ACLTestContext::waitForDisconnected ( )

Wait for the ConnectionStatusObserver to be notified that the client has successfully disconnected from AVS.


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

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