alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams Class Reference

#include <TestDirectiveHandler.h>

Public Types
enum	Type {   Type::UNSET, Type::HANDLE_IMMEDIATELY, Type::PREHANDLE, Type::HANDLE,   Type::CANCEL, Type::TIMEOUT }

Public Member Functions
	DirectiveParams ()
bool	isUnset () const
bool	isHandleImmediately () const
bool	isPreHandle () const
bool	isHandle () const
bool	isCancel () const
bool	isTimeout () const

Public Attributes
Type	type
std::shared_ptr< avsCommon::avs::AVSDirective >	directive
std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerResultInterface >	result

Detailed Description

Class defining the parameters to calls to the mocked interfaces.

Member Enumeration Documentation

Type

enum alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::Type

strong

Enumerator
UNSET
HANDLE_IMMEDIATELY
PREHANDLE
HANDLE
CANCEL
TIMEOUT

Constructor & Destructor Documentation

DirectiveParams()

alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::DirectiveParams

(

)

Constructor.

Member Function Documentation

isCancel()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isCancel ( ) const

inline

Return whether this DirectiveParams is of type 'CANCEL'.

Returns

Whether this DirectiveParams is of type 'CANCEL'.

isHandle()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isHandle ( ) const

inline

Return whether this DirectiveParams is of type 'HANDLE'.

Returns

Whether this DirectiveParams is of type 'HANDLE'.

isHandleImmediately()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isHandleImmediately ( ) const

inline

Return whether this DirectiveParams is of type 'HANDLE_IMMEDIATELY'.

Returns

Whether this DirectiveParams is of type 'HANDLE_IMMEDIATELY'.

isPreHandle()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isPreHandle ( ) const

inline

Return whether this DirectiveParams is of type 'PREHANDLE'.

Returns

Whether this DirectiveParams is of type 'PREHANDLE'.

isTimeout()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isTimeout ( ) const

inline

Return whether this DirectiveParams is of type 'TIMEOUT'.

Returns

Whether this DirectiveParams is of type 'TIMEOUT'.

isUnset()

bool alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::isUnset ( ) const

inline

Return whether this DirectiveParams is of type 'UNSET'.

Returns

Whether this DirectiveParams is of type 'UNSET'.

Member Data Documentation

directive

std::shared_ptr<avsCommon::avs::AVSDirective> alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::directive

result

std::shared_ptr<avsCommon::sdkInterfaces::DirectiveHandlerResultInterface> alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::result

type

Type alexaClientSDK::integration::test::TestDirectiveHandler::DirectiveParams::type

---

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

• /workplace/avs-device-sdk/Integration/include/Integration/TestDirectiveHandler.h
• /workplace/avs-device-sdk/Integration/src/TestDirectiveHandler.cpp