#include <DirectiveHandlerResultInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerResultInterface:

Public Member Functions
virtual	~DirectiveHandlerResultInterface ()=default

virtual void	setCompleted ()=0

virtual void	setFailed (const std::string &description)=0

Detailed Description

Interface for indicating the result of a request to preHandle() or handle() an AVSDirective.

Once one of the 'setter' methods have been called the handling of the AVSDirective is finished and further calls to 'setter' methods should not be made.

Constructor & Destructor Documentation

◆ ~DirectiveHandlerResultInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerResultInterface::~DirectiveHandlerResultInterface ( )

virtualdefault

Virtual destructor to ensure proper cleanup by derived types.

Member Function Documentation

◆ setCompleted()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerResultInterface::setCompleted ( )

pure virtual

Indicate that the handling of the AVSDirective successfully ran to successful completion.

Note: Once this has been called, no other methods of this object should be called.

Implemented in alexaClientSDK::avsCommon::test::MockResult.

◆ setFailed()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::DirectiveHandlerResultInterface::setFailed ( const std::string & description )

pure virtual

Indicate that handling an AVSDirective failed such that subsequent AVSDirectives with the same DialogRequestId should be cancelled.

Note: Once this has been called, no other methods of this object should be called.

Parameters

description A description, suitable for logging, that indicates the nature of the failure.