alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager Class Reference

#include <APLDocumentSessionManager.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager:

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager:

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

Static Public Member Functions
static std::unique_ptr< APLDocumentSessionManager >	create ()

Member Function Documentation

addDocumentSession()

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

overridevirtual

APLDocumentSessionManagerInterface Functions {

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

associateTokenWithPresentationSession()

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

overridevirtual

Associates a token with an existing presentation session

Parameters

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

clearDocumentSession()

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

overridevirtual

Clear an active document session

Parameters

presentationSession

presentation session of document session to clear

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

create()

static std::unique_ptr<APLDocumentSessionManager> alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager::create ( )

static

Create an instance of APLDocumentSessionManager

Returns

pointer to APLDocumentSessionManager

getDocumentSessionByPresentationSession()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

getDocumentSessionByToken()

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

overridevirtual

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

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

invokeFunctionPerDocumentSession()

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

overridevirtual

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

Parameters

func	function to be executed with the document session

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManagerInterface.

---

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

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