alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface Class Reference

#include <APLDocumentSessionInterface.h>

Inheritance diagram for alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface:

Public Member Functions
virtual	~APLDocumentSessionInterface ()=default
virtual void	clearDocument ()=0
virtual void	executeCommands (const std::string &commands)=0
virtual void	dataSourceUpdate (const std::string &sourceType, const std::string &payload)=0
virtual void	interruptCommandSequence ()=0
virtual void	provideDocumentContext (const avsCommon::sdkInterfaces::ContextRequestToken stateRequestToken)=0
virtual void	requestForeground ()=0
virtual void	updateTimeout (std::chrono::milliseconds timeout)=0
virtual void	stopTimeout ()=0
virtual void	resetTimeout ()=0
virtual void	updateLifespan (presentationOrchestratorInterfaces::PresentationLifespan lifespan)=0
virtual PresentationToken	getToken () const =0
virtual bool	isForegroundFocused ()=0

Detailed Description

A APLDocumentSessionInterface allows for controlling a previously rendered APL document. All methods except getToken() result in asynchronous operations so APLDocumentObserverInterface implementations should be used for monitoring the success of method calls.

Constructor & Destructor Documentation

~APLDocumentSessionInterface()

virtual alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::~APLDocumentSessionInterface ( )

virtualdefault

Destructor.

Member Function Documentation

clearDocument()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::clearDocument ( )

pure virtual

Dismiss APL document. No other functions can be called after this

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

dataSourceUpdate()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::dataSourceUpdate ( const std::string &  sourceType, const std::string &  payload  )

pure virtual

Update the data source payload for a given APL document

Parameters

sourceType	APL spec source type for data update
payload	JSON string containing update payload

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

executeCommands()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::executeCommands ( const std::string &  commands )

pure virtual

Execute commands referenced in APL document

Parameters

commands

JSON string containing APL command to execute

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

getToken()

virtual PresentationToken alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::getToken ( ) const

pure virtual

Get presentation token of this document session. Can be used for sharing APLDocumentObserverInterface instances across multiple documents.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

interruptCommandSequence()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::interruptCommandSequence ( )

pure virtual

Interrupt any active command sequence currently executing on the document

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

isForegroundFocused()

virtual bool alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::isForegroundFocused ( )

pure virtual

Check if document session is foreground focused

Returns

true if session is foreground focused, false otherwise

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

provideDocumentContext()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::provideDocumentContext ( const avsCommon::sdkInterfaces::ContextRequestToken  stateRequestToken )

pure virtual

Provide visual context to onVisualContextAvailable observer callback

Parameters

stateRequestToken

provided by StateProviderInterface call

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

requestForeground()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::requestForeground ( )

pure virtual

Request active document session to move to the foreground if not already there.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

resetTimeout()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::resetTimeout ( )

pure virtual

Reset a timeout timer based on configured timeout policy.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

stopTimeout()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::stopTimeout ( )

pure virtual

Stop any active timeout timer.

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

updateLifespan()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::updateLifespan ( presentationOrchestratorInterfaces::PresentationLifespan  lifespan )

pure virtual

Update the PresentationLifespan for document session.

Parameters

lifespan

PresentationLifespan

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

updateTimeout()

virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLDocumentSessionInterface::updateTimeout ( std::chrono::milliseconds  timeout )

pure virtual

Update the timeout policy for document session. Will reset any active timeout timer.

Parameters

timeout

updated timeout duration, use a value of -1 to disable the timeout

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSession.

---

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

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