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::APLRuntimeInterfaceImpl Class Reference

#include <APLRuntimeInterfaceImpl.h>

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

Public Member Functions

 ~APLRuntimeInterfaceImpl ()
 
void setDefaultWindowId (const std::string &windowId)
 
void setPresentationOrchestrator (std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface > poClient)
 
std::shared_ptr< APLDocumentSessioncreateDocumentSession (const std::string &document, const std::string &data, const aplCapabilityCommonInterfaces::PresentationSession &presentationSession, const aplCapabilityCommonInterfaces::PresentationOptions &presentationOptions, std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentObserverInterface > observer, bool hasPresentationAssociation)
 
APLRuntimeInterface functions
void renderDocument (const std::string &document, const std::string &data, const aplCapabilityCommonInterfaces::PresentationSession &presentationSession, const aplCapabilityCommonInterfaces::PresentationOptions &presentationOptions, std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentObserverInterface > observer) override
 
std::string getMaxAPLVersion () const override
 
- Public Member Functions inherited from alexaClientSDK::aplCapabilityCommonInterfaces::APLRuntimeInterface
virtual ~APLRuntimeInterface ()=default
 
virtual void renderDocument (const std::string &document, const std::string &data, const PresentationSession &presentationSession, const PresentationOptions &presentationOptions, std::shared_ptr< APLDocumentObserverInterface > observer)=0
 

Static Public Member Functions

static std::shared_ptr< APLRuntimeInterfaceImplcreate (const APLViewhostInterfacePtr &runtime)
 

Constructor & Destructor Documentation

◆ ~APLRuntimeInterfaceImpl()

alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::~APLRuntimeInterfaceImpl ( )

Destructor

Member Function Documentation

◆ create()

static std::shared_ptr<APLRuntimeInterfaceImpl> alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::create ( const APLViewhostInterfacePtr runtime)
static

Create a new APLRuntimeInterfaceImpl object

Parameters
runtimeIAPLRuntime instance
Returns
shared_ptr to APLRuntimeInterfaceImpl

◆ createDocumentSession()

std::shared_ptr<APLDocumentSession> alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::createDocumentSession ( const std::string &  document,
const std::string &  data,
const aplCapabilityCommonInterfaces::PresentationSession presentationSession,
const aplCapabilityCommonInterfaces::PresentationOptions presentationOptions,
std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentObserverInterface observer,
bool  hasPresentationAssociation 
)

◆ getMaxAPLVersion()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::getMaxAPLVersion ( ) const
overridevirtual

Get the maximum APL Version currently supported on this device. See the following for descriptions of the various APL Version Specifications: https://developer.amazon.com/en-US/docs/alexa/alexa-presentation-language/apl-latest-version.html

Returns
string representation of APL Specification Version

Implements alexaClientSDK::aplCapabilityCommonInterfaces::APLRuntimeInterface.

◆ renderDocument()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::renderDocument ( const std::string &  document,
const std::string &  data,
const aplCapabilityCommonInterfaces::PresentationSession presentationSession,
const aplCapabilityCommonInterfaces::PresentationOptions presentationOptions,
std::shared_ptr< aplCapabilityCommonInterfaces::APLDocumentObserverInterface observer 
)
override

◆ setDefaultWindowId()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::setDefaultWindowId ( const std::string &  windowId)

◆ setPresentationOrchestrator()

void alexaClientSDK::sampleApplications::ipcServerSampleApp::APLRuntimeInterfaceImpl::setPresentationOrchestrator ( std::shared_ptr< presentationOrchestratorInterfaces::PresentationOrchestratorClientInterface poClient)

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