alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface Class Reference

#include <APLDocumentObserverInterface.h>

Public Member Functions
virtual	~APLDocumentObserverInterface ()=default
virtual void	onAPLDocumentSessionAvailable (const std::string &token, std::unique_ptr< APLDocumentSessionInterface > &&session)=0
virtual void	onDocumentFinished (const std::string &token)=0
virtual void	onRenderDocumentComplete (const std::string &token, bool result, const std::string &error)
virtual void	onRenderDocumentComplete (const std::string &token, bool result, const std::string &error, const std::chrono::steady_clock::time_point &timestamp)
virtual void	onCommandExecutionComplete (const std::string &token, bool result, const std::string &error)=0
virtual void	onDataSourceUpdateComplete (const std::string &token, bool result, const std::string &error)=0
virtual void	onSendEvent (const std::string &token, const std::string &arguments, const std::string &components, const std::string &source)=0
virtual void	onVisualContextAvailable (const std::string &token, const unsigned int requestToken, const std::string &visualContext)=0
virtual void	onDataSourceFetch (const std::string &token, const std::string &dataSourceType, const std::string &payload)=0
virtual void	onRuntimeError (const std::string &token, const std::string &payload)=0

Detailed Description

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

Constructor & Destructor Documentation

~APLDocumentObserverInterface()

virtual alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::~APLDocumentObserverInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onAPLDocumentSessionAvailable()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onAPLDocumentSessionAvailable ( const std::string &  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

token	presentationToken of document session available
session	DocumentSession object

onCommandExecutionComplete()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onCommandExecutionComplete ( const std::string &  token, bool  result, const std::string &  error  )

pure virtual

Callback when execute command is complete

Parameters

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

onDataSourceFetch()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onDataSourceFetch ( const std::string &  token, const std::string &  dataSourceType, const std::string &  payload  )

pure virtual

Callback for data source fetch request

Parameters

token	presentationToken of document
dataSourceType	apl defined list data source type
payload	json payload of data source fetch request

onDataSourceUpdateComplete()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onDataSourceUpdateComplete ( const std::string &  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 available

onDocumentFinished()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onDocumentFinished ( const std::string &  token )

pure virtual

Callback when document has finished displaying

Parameters

token

presentationToken of document

onRenderDocumentComplete() [1/2]

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onRenderDocumentComplete ( const std::string &  token, bool  result, const std::string &  error  )

inlinevirtual

Callback when document rendering is complete

Parameters

token	presentationToken of document
result	true if rendering was successful, false otherwise
error	error string if available

onRenderDocumentComplete() [2/2]

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

inlinevirtual

onRuntimeError()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onRuntimeError ( const std::string &  token, const std::string &  payload  )

pure virtual

Callback when runtime error occurs in document

Parameters

token	presentationToken of document
payload	json payload of runtime error

onSendEvent()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onSendEvent ( const std::string &  token, const std::string &  arguments, const std::string &  components, const std::string &  source  )

pure virtual

Callback for send event request

Parameters

token	presentationToken of document
arguments	Arguments array of SendEvent command
components	Object containing the component of the SendEvent command
source	Object detailing component which generated the command

onVisualContextAvailable()

virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentObserverInterface::onVisualContextAvailable ( const std::string &  token, const unsigned int  requestToken, const std::string &  visualContext  )

pure virtual

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

Parameters

token	presentationToken of document
requestToken	token correlating context to provideState request
visualContext	json payload of document visual context

---

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

• /workplace/avs-device-sdk/capabilities/AlexaPresentation/AlexaPresentationInterfaces/include/acsdkAlexaPresentationInterfaces/APLDocumentObserverInterface.h