#include <APLDocumentObserverInterface.h>

Inheritance diagram for alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface:

Public Member Functions
virtual	~APLDocumentObserverInterface ()=default

virtual void	onAPLDocumentSessionAvailable (const PresentationSession &presentationSession, const PresentationToken &token, std::unique_ptr< APLDocumentSessionInterface > &&session)=0

virtual void	onDocumentFinished (const PresentationToken &token)=0

virtual void	onActiveDocumentChanged (const PresentationToken &token, const PresentationSession &session)=0

virtual void	onRenderDocumentComplete (const PresentationToken &token, bool result, const std::string &error, const std::chrono::steady_clock::time_point &timestamp)=0

virtual void	onCommandExecutionComplete (const PresentationToken &token, APLCommandExecutionEvent result, const std::string &error)=0

virtual void	onDataSourceUpdateComplete (const PresentationToken &token, bool result, const std::string &error)=0

virtual void	onSendEvent (const aplEventPayload::UserEvent &payload)=0

virtual void	onVisualContextAvailable (const avsCommon::sdkInterfaces::ContextRequestToken requestToken, const aplEventPayload::VisualContext &context)=0

virtual void	onDataSourceFetch (const aplEventPayload::DataSourceFetch &payload)=0

virtual void	onRuntimeError (const aplEventPayload::RuntimeError &payload)=0

virtual void	onSessionEnded (const PresentationSession &presentationSession)=0

virtual void	onActivityEvent (const PresentationToken &token, const avsCommon::sdkInterfaces::GUIActivityEvent &event)=0

Detailed Description

A APLDocumentObserverInterface allows for observing the lifecycle of rendered APL documents.

Constructor & Destructor Documentation

◆ ~APLDocumentObserverInterface()

virtual alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::~APLDocumentObserverInterface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ onActiveDocumentChanged()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onActiveDocumentChanged	(	const PresentationToken &	token,
		const PresentationSession &	session
	)

pure virtual

Callback when the active document has changed

Parameters

token	APL Token for the new active document
session	The `PresentationSession` for the new active document

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onActivityEvent()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onActivityEvent	(	const PresentationToken &	token,
		const avsCommon::sdkInterfaces::GUIActivityEvent &	event
	)

pure virtual

Callback when a document receives a GUI activity

Parameters

token	presentationToken of document
event	The `GUIActivityEvent` event

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onAPLDocumentSessionAvailable()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onAPLDocumentSessionAvailable	(	const PresentationSession &	presentationSession,
		const PresentationToken &	token,
		std::unique_ptr< APLDocumentSessionInterface > &&	session
	)

pure virtual

Callback when document session is available. Session may be stored to further influence the document being rendered.

Parameters

presentationSession	The presentation session associated with this document session
token	presentationToken of document session available
session	DocumentSession object

Implemented in alexaClientSDK::aplCapabilityCommonInterfaces::test::MockAPLDocumentObserver.

◆ onCommandExecutionComplete()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onCommandExecutionComplete	(	const PresentationToken &	token,
		APLCommandExecutionEvent	result,
		const std::string &	error
	)

pure virtual

Callback when execute command is complete

Parameters

token	presentationToken of document
result	the command result as defined in `APLCommandExecutionEvent`
error	error string if available

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onDataSourceFetch()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onDataSourceFetch ( const aplEventPayload::DataSourceFetch & payload )

pure virtual

Callback for data source fetch request

Parameters

payload The DataSourceFetchRequest event payload. The caller of this function is responsible to pass the payload as it defined in aplEventPayload::DataSourceFetch.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onDataSourceUpdateComplete()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onDataSourceUpdateComplete	(	const PresentationToken &	token,
		bool	result,
		const std::string &	error
	)

pure virtual

Callback when data source update is complete

Parameters

token	presentationToken of document
result	true if successful, false otherwise
error	error string if availabled

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onDocumentFinished()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onDocumentFinished ( const PresentationToken & token )

pure virtual

Callback when document has finished displaying

Parameters

token presentationToken of document

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onRenderDocumentComplete()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onRenderDocumentComplete	(	const PresentationToken &	token,
		bool	result,
		const std::string &	error,
		const std::chrono::steady_clock::time_point &	timestamp
	)

pure virtual

Callback when document rendering is complete

Parameters

token	presentationToken of document
result	true if rendering was successful, false otherwise
error	error string if available
timestamp	The timestamp at which the document was rendered

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onRuntimeError()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onRuntimeError ( const aplEventPayload::RuntimeError & payload )

pure virtual

Callback when runtime error occurs in document

Parameters

payload The RuntimeError event payload. The caller of this function is responsible to pass the payload as it defined in aplEventPayload::RuntimeError.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onSendEvent()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onSendEvent ( const aplEventPayload::UserEvent & payload )

pure virtual

Callback for send event request

Parameters

payload The UserEvent event payload. The caller of this function is responsible to pass the payload as it defined in aplEventPayload::UserEvent.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onSessionEnded()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onSessionEnded ( const PresentationSession & presentationSession )

pure virtual

Callback when a document session has ended

Parameters

presentationSession The session that was associated with this document session

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

◆ onVisualContextAvailable()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentObserverInterface::onVisualContextAvailable	(	const avsCommon::sdkInterfaces::ContextRequestToken	requestToken,
		const aplEventPayload::VisualContext &	context
	)

pure virtual

Callback to provide information about what is currently displayed on screen. Should be provided to ContextManagerInterface in response to provideState calls.

Parameters

requestToken	token correlating context to provideState request
context	The visual state to be passed to AVS. The caller of this function is responsible to pass the payload as it defined in `aplEventPayload::VisualContext`

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimePresentationAdapter.

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

/workplace/avs-device-sdk/capabilities/APLCapabilityCommon/APLCapabilityCommonInterfaces/include/acsdk/APLCapabilityCommonInterfaces/APLDocumentObserverInterface.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~APLDocumentObserverInterface()

Member Function Documentation

◆ onActiveDocumentChanged()

◆ onActivityEvent()

◆ onAPLDocumentSessionAvailable()

◆ onCommandExecutionComplete()

◆ onDataSourceFetch()

◆ onDataSourceUpdateComplete()

◆ onDocumentFinished()

◆ onRenderDocumentComplete()

◆ onRuntimeError()

◆ onSendEvent()

◆ onSessionEnded()

◆ onVisualContextAvailable()