A test observer that mocks out the ChannelObserverInterface#onFocusChanged() call. More...

Inheritance diagram for alexaClientSDK::afml::test::TestClient:

Collaboration diagram for alexaClientSDK::afml::test::TestClient:

Public Member Functions
	TestClient (const std::string &channelName, const std::string &interfaceName)

std::shared_ptr< FocusManagerInterface::Activity >	createActivity (ContentType contentType=ContentType::NONMIXABLE, std::chrono::milliseconds patience=std::chrono::milliseconds(0))

const std::string &	getChannelName () const

const std::string &	getInterfaceName () const

void	onFocusChanged (FocusState focusState, MixingBehavior behavior) override

testClientInfo	waitForFocusOrMixingBehaviorChange (std::chrono::milliseconds timeout)

Public Member Functions inherited from alexaClientSDK::avsCommon::sdkInterfaces::ChannelObserverInterface
virtual	~ChannelObserverInterface ()=default

Detailed Description

A test observer that mocks out the ChannelObserverInterface#onFocusChanged() call.

Constructor & Destructor Documentation

alexaClientSDK::afml::test::TestClient::TestClient	(	const std::string &	channelName,
		const std::string &	interfaceName
	)

inline

Constructor.

std::shared_ptr<FocusManagerInterface::Activity> alexaClientSDK::afml::test::TestClient::createActivity	(	ContentType	contentType = `ContentType::NONMIXABLE`,
		std::chrono::milliseconds	patience = `std::chrono::milliseconds(0)`
	)

inline

const std::string& alexaClientSDK::afml::test::TestClient::getChannelName ( ) const

inline

const std::string& alexaClientSDK::afml::test::TestClient::getInterfaceName ( ) const

inline

void alexaClientSDK::afml::test::TestClient::onFocusChanged	(	FocusState	focusState,
		MixingBehavior	behavior
	)

inlineoverridevirtual

Implementation of the ChannelObserverInterface#onFocusChanged() callback.

Parameters

focusState	The new focus state of the Channel observer.
behavior	The new MixingBehavior of the Channel observer.

testClientInfo alexaClientSDK::afml::test::TestClient::waitForFocusOrMixingBehaviorChange ( std::chrono::milliseconds timeout )

inline

Waits for the ChannelObserverInterface#onFocusChanged() callback.

Parameters

timeout	The amount of time to wait for the callback.
focusChanged	An output parameter that notifies the caller whether a callback occurred.

Returns: Returns true if the callback occured within the timeout period and false otherwise.

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