#include <APLDocumentSessionInterface.h>
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.
◆ ~APLDocumentSessionInterface()
virtual alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::~APLDocumentSessionInterface |
( |
| ) |
|
|
virtualdefault |
◆ clearDocument()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::clearDocument |
( |
| ) |
|
|
pure virtual |
Dismiss APL document. No other functions can be called after this
◆ dataSourceUpdate()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::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 |
◆ executeCommands()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::executeCommands |
( |
const std::string & |
commands | ) |
|
|
pure virtual |
Execute commands referenced in APL document
- Parameters
-
commands | JSON string containing APL command to execute |
◆ getToken()
virtual std::string alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::getToken |
( |
| ) |
const |
|
pure virtual |
◆ interruptCommandSequence()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::interruptCommandSequence |
( |
| ) |
|
|
pure virtual |
Interrupt any active command sequence currently executing on the document
◆ provideDocumentContext()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::provideDocumentContext |
( |
const unsigned int |
stateRequestToken | ) |
|
|
pure virtual |
Provide visual context to onVisualContextAvailable observer callback
- Parameters
-
stateRequestToken | provided by StateProviderInterface call |
◆ requestForeground()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::requestForeground |
( |
| ) |
|
|
pure virtual |
Request active document session to move to the foreground if not already there.
◆ updateLifespan()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::APLDocumentSessionInterface::updateLifespan |
( |
PresentationLifespan |
lifespan | ) |
|
|
inlinevirtual |
Update the lifespan for document session.
- Parameters
-
◆ updateTimeout()
virtual void alexaClientSDK::acsdkAlexaPresentationInterfaces::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 |
The documentation for this class was generated from the following file:
- /workplace/avs-device-sdk/capabilities/AlexaPresentation/AlexaPresentationInterfaces/include/acsdkAlexaPresentationInterfaces/APLDocumentSessionInterface.h
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0