AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::integration::test::AuthDelegateTestContext Class Reference

#include <AuthDelegateTestContext.h>

Public Member Functions

 ~AuthDelegateTestContext ()
bool isValid () const
std::shared_ptr< avsCommon::sdkInterfaces::AuthDelegateInterfacegetAuthDelegate () const
std::shared_ptr< registrationManager::CustomerDataManagerInterfacegetCustomerDataManager () const

Static Public Member Functions

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

Detailed Description

Class providing lifecycle management of resources needed for testing instances of AuthDelegateInterface or functionality that requires such instances for testing.

Constructor & Destructor Documentation

◆ ~AuthDelegateTestContext()

alexaClientSDK::integration::test::AuthDelegateTestContext::~AuthDelegateTestContext ( )

Destructor. de-initializes all resources acquired during construction.

Member Function Documentation

◆ create()

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

Create an AuthDelegateTestContext

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: A CustomerDataManager instance. An AuthDelegateInterface instance.

filePathThe path to a config file.
overlayA JSON string containing values to overlay on the contents of the configuration file.

◆ getAuthDelegate()

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

Get the instance of AuthDelegateInterface to use for the test.

The instance of AuthDelegateInterface to use for the test.

◆ getCustomerDataManager()

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

Get the instance of CustomerDataManager to use for the test.

The instance of CustomerDataManager to use for the test.

◆ isValid()

bool alexaClientSDK::integration::test::AuthDelegateTestContext::isValid ( ) const

Determine whether or not this instance was properly initialized.

Whether or not this instance was properly initialized.

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

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