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::SDKTestContext Class Reference

#include <SDKTestContext.h>

Public Member Functions

 ~SDKTestContext ()
 

Static Public Member Functions

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

Detailed Description

Class providing lifecycle management of resources needed for testing the Alexa Client SDK.

Constructor & Destructor Documentation

◆ ~SDKTestContext()

alexaClientSDK::integration::test::SDKTestContext::~SDKTestContext ( )

Destructor de-initializes the Alexa Client SDK.

Member Function Documentation

◆ create()

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

Create an SDKTestContext

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 (which includes initialization of @ libcurl and ConfigurationNode.

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

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

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