alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface Class Reference

#include <APLDocumentSessionManagerInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface:

Public Member Functions
virtual	~APLDocumentSessionManagerInterface ()=default
virtual void	addDocumentSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSessionId, const std::string &token, std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface > session)=0
virtual std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface >	getDocumentSessionByPresentationSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSession)=0
virtual std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface >	getDocumentSessionByToken (const std::string &token)=0
virtual void	clearDocumentSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSession)=0
virtual void	invokeFunctionPerDocumentSession (std::function< void(const std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface > &)> func)=0
virtual void	associateTokenWithPresentationSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSession, const std::string &token)=0

Detailed Description

A APLDocumentSessionManagerInterface allows for tracking the active APL Document Sessions

Constructor & Destructor Documentation

~APLDocumentSessionManagerInterface()

virtual alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::~APLDocumentSessionManagerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

addDocumentSession()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::addDocumentSession ( const aplCapabilityCommonInterfaces::PresentationSession &  presentationSessionId, const std::string &  token, std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface >  session  )

pure virtual

Add an active session

Parameters

presentationSession	presentation session for this document session
token	token of document session
session	the document session object

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

associateTokenWithPresentationSession()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::associateTokenWithPresentationSession ( const aplCapabilityCommonInterfaces::PresentationSession &  presentationSession, const std::string &  token  )

pure virtual

Associates a token with an existing presentation session

Parameters

presentationSession	The presentation session, must have already been added with addDocumentSession
token	The document token

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

clearDocumentSession()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::clearDocumentSession ( const aplCapabilityCommonInterfaces::PresentationSession &  presentationSession )

pure virtual

Clear an active document session

Parameters

presentationSession

presentation session of document session to clear

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

getDocumentSessionByPresentationSession()

virtual std::shared_ptr<aplCapabilityCommonInterfaces::APLDocumentSessionInterface> alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::getDocumentSessionByPresentationSession ( const aplCapabilityCommonInterfaces::PresentationSession &  presentationSession )

pure virtual

Get the Session using the Presentation Session

Parameters

presentationSession

The presentation session

Returns

shared_ptr to the APLDocumentSessionInterface associated with this presentationSession, or nullptr if none exists

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

getDocumentSessionByToken()

virtual std::shared_ptr<aplCapabilityCommonInterfaces::APLDocumentSessionInterface> alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::getDocumentSessionByToken ( const std::string &  token )

pure virtual

Get the Session using the APL token

Parameters

token

token of document session

Returns

shared_ptr to the APLDocumentSessionInterface associated with this token, or nullptr if none exists

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

invokeFunctionPerDocumentSession()

virtual void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface::invokeFunctionPerDocumentSession ( std::function< void(const std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface > &)>  func )

pure virtual

Invoke a function on each document session tracked by the session manager

Parameters

func	function to be executed with the document session

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager.

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/AlexaPresentation/APLDocumentSessionManagerInterface.h