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

Public Member Functions

 ExceptionEncounteredEvent (const std::string &unparsedDirective, avs::ExceptionErrorType error, const std::string &errorDescription)
 
void send (std::shared_ptr< avs::ExceptionEncounteredSender > exceptionencounteredsender)
 
void verifyMessage (std::shared_ptr< avsCommon::avs::MessageRequest > request)
 

Detailed Description

Utility class which captures parameters to a ExceptionEncountered event, and provides functions to send and verify the event using those parameters.

Constructor & Destructor Documentation

◆ ExceptionEncounteredEvent()

alexaClientSDK::avsCommon::test::ExceptionEncounteredEvent::ExceptionEncounteredEvent ( const std::string &  unparsedDirective,
avs::ExceptionErrorType  error,
const std::string &  errorDescription 
)

Constructs an object which captures the parameters to send in a ExceptionEncountered Event. Parameters are passed through directly to ExceptionEncounteredSender::sendExceptionEncountered().

Member Function Documentation

◆ send()

void alexaClientSDK::avsCommon::test::ExceptionEncounteredEvent::send ( std::shared_ptr< avs::ExceptionEncounteredSender exceptionencounteredsender)

This function sends a ExceptionEncountered event using the provided exceptionencounteredsender.

Parameters
exceptionencounteredsenderThe ExceptionEncounteredSender to call on ExceptionEncounteredSender::sendExceptionEncountered().

◆ verifyMessage()

void alexaClientSDK::avsCommon::test::ExceptionEncounteredEvent::verifyMessage ( std::shared_ptr< avsCommon::avs::MessageRequest request)

This function verifies that JSON content of a ExceptionEncountered event MessageRequest is correct. This function signature matches that of MessageSenderInterface::sendMessage() so that an EXPECT_CALL() can Invoke() this function directly.

Parameters
requestThe MessageRequest to verify.

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

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