AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager Class Reference

#include <APLDocumentSessionManager.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::APLDocumentSessionManager:
Collaboration graph
[legend]

Public Member Functions

void addDocumentSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSession, const std::string &token, std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterface > session) override
 
std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterfacegetDocumentSessionByPresentationSession (const aplCapabilityCommonInterfaces::PresentationSession &presentationSessionId) override
 
std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentSessionInterfacegetDocumentSessionByToken (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< APLDocumentSessionManagercreate ()
 

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

◆ 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
presentationSessionThe presentation session, must have already been added with addDocumentSession
tokenThe 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
presentationSessionpresentation 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
presentationSessionThe 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
tokentoken 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
funcfunction to be executed with the document session

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


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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0