alexaClientSDK::adsl::test::MockDirectiveSequencer Class Reference

#include <MockDirectiveSequencer.h>

Inheritance diagram for alexaClientSDK::adsl::test::MockDirectiveSequencer:

Collaboration diagram for alexaClientSDK::adsl::test::MockDirectiveSequencer:

Public Member Functions
	MockDirectiveSequencer ()
	MOCK_METHOD0 (doShutdown, void())
	MOCK_METHOD1 (addDirectiveHandler, bool(std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerInterface > handler))
	MOCK_METHOD1 (removeDirectiveHandler, bool(std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerInterface > handler))
void	setDialogRequestId (const std::string &dialogRequestId)
std::string	getDialogRequestId ()
	MOCK_METHOD1 (onDirective, bool(std::shared_ptr< avsCommon::avs::AVSDirective > directive))
	MOCK_METHOD0 (disable, void())
	MOCK_METHOD0 (enable, void())
Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::DirectiveSequencerInterface
	DirectiveSequencerInterface (const std::string &name)
virtual	~DirectiveSequencerInterface ()=default
virtual bool	addDirectiveHandler (std::shared_ptr< DirectiveHandlerInterface > handler)=0
virtual bool	removeDirectiveHandler (std::shared_ptr< DirectiveHandlerInterface > handler)=0
virtual bool	onDirective (std::shared_ptr< avsCommon::avs::AVSDirective > directive)=0
virtual void	disable ()=0
virtual void	enable ()=0
Public Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
	RequiresShutdown (const std::string &name)
virtual	~RequiresShutdown ()
	Destructor. More...
const std::string &	name () const
void	shutdown ()
bool	isShutdown () const

Public Attributes
std::string	m_dialogRequestId

Additional Inherited Members
Protected Member Functions inherited from alexaClientSDK::avsCommon::utils::RequiresShutdown
virtual void	doShutdown ()=0

Detailed Description

The mock class that implements the DirectiveSequencerInterface.

Constructor & Destructor Documentation

MockDirectiveSequencer()

alexaClientSDK::adsl::test::MockDirectiveSequencer::MockDirectiveSequencer ( )

inline

Member Function Documentation

getDialogRequestId()

std::string alexaClientSDK::adsl::test::MockDirectiveSequencer::getDialogRequestId ( )

inlinevirtual

Returns the dialogRequestId currently in use for Directive handling. This may be the empty string if Directives have either experienced errors, or have been cancelled.

Returns

dialogRequestId The current dialog request id.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveSequencerInterface.

MOCK_METHOD0() [1/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD0	(	doShutdown	,
		void()
	)

MOCK_METHOD0() [2/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD0	(	disable	,
		void()
	)

MOCK_METHOD0() [3/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD0	(	enable	,
		void()
	)

MOCK_METHOD1() [1/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD1	(	addDirectiveHandler	,
		bool(std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerInterface > handler)
	)

MOCK_METHOD1() [2/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD1	(	removeDirectiveHandler	,
		bool(std::shared_ptr< avsCommon::sdkInterfaces::DirectiveHandlerInterface > handler)
	)

MOCK_METHOD1() [3/3]

alexaClientSDK::adsl::test::MockDirectiveSequencer::MOCK_METHOD1	(	onDirective	,
		bool(std::shared_ptr< avsCommon::avs::AVSDirective > directive)
	)

setDialogRequestId()

void alexaClientSDK::adsl::test::MockDirectiveSequencer::setDialogRequestId ( const std::string &  dialogRequestId )

inlinevirtual

Set the current DialogRequestId. This value can be set at any time. Setting this value causes a DirectiveSequencer to drop unhandled AVSDirectives with different (and non-empty) DialogRequestId values. AVSDirectives with a differing dialogRequestId value and whose pre-handling or handling is already in progress will be cancelled.

Parameters

dialogRequestId

The new value for the current DialogRequestId.

Implements alexaClientSDK::avsCommon::sdkInterfaces::DirectiveSequencerInterface.

Member Data Documentation

m_dialogRequestId

std::string alexaClientSDK::adsl::test::MockDirectiveSequencer::m_dialogRequestId

---

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

• /workplace/avs-device-sdk/ADSL/test/ADSL/MockDirectiveSequencer.h