#include <APLCapabilityAgentObserverInterface.h>
|
virtual | ~APLCapabilityAgentObserverInterface ()=default |
|
virtual void | onRenderDocument (const std::string &document, const std::string &datasource, const PresentationToken &token, const std::string &windowId, const APLTimeoutType timeoutType, const std::string &interfaceName, const std::string &supportedViewports, const PresentationSession &presentationSession, const std::chrono::steady_clock::time_point &receiveTime, std::shared_ptr< APLCapabilityAgentInterface > agent)=0 |
|
virtual void | onExecuteCommands (const std::string &jsonPayload, const PresentationToken &token)=0 |
|
virtual void | onDataSourceUpdate (const std::string &sourceType, const std::string &jsonPayload, const PresentationToken &token)=0 |
|
virtual void | onShowDocument (const PresentationToken &token)=0 |
|
This APLCapabilityAgentObserverInterface
class is used to notify observers when APL directive is received.
◆ ~APLCapabilityAgentObserverInterface()
virtual alexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface::~APLCapabilityAgentObserverInterface |
( |
| ) |
|
|
virtualdefault |
◆ onDataSourceUpdate()
virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface::onDataSourceUpdate |
( |
const std::string & |
sourceType, |
|
|
const std::string & |
jsonPayload, |
|
|
const PresentationToken & |
token |
|
) |
| |
|
pure virtual |
◆ onExecuteCommands()
virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface::onExecuteCommands |
( |
const std::string & |
jsonPayload, |
|
|
const PresentationToken & |
token |
|
) |
| |
|
pure virtual |
◆ onRenderDocument()
virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface::onRenderDocument |
( |
const std::string & |
document, |
|
|
const std::string & |
datasource, |
|
|
const PresentationToken & |
token, |
|
|
const std::string & |
windowId, |
|
|
const APLTimeoutType |
timeoutType, |
|
|
const std::string & |
interfaceName, |
|
|
const std::string & |
supportedViewports, |
|
|
const PresentationSession & |
presentationSession, |
|
|
const std::chrono::steady_clock::time_point & |
receiveTime, |
|
|
std::shared_ptr< APLCapabilityAgentInterface > |
agent |
|
) |
| |
|
pure virtual |
Used to notify the observer when an APL document is ready to be rendered, typically in response to a Alexa.Presentation.APL.RenderDocument directive being received. Once called, the client should render the document based on the APL specification in the payload in structured JSON format.
- Note
- The payload may contain customer sensitive information and should be used with utmost care. Failure to do so may result in exposing or mishandling of customer data.
- Parameters
-
document | JSON string containing APL document |
datasource | JSON string containing data payload associated with APL document |
token | The APL presentation token associated with this payload. |
windowId | The target windowId. |
timeoutType | The APLTimeoutType associated with this payload. |
interfaceName | The interface (namespace) which is associated with this directive. |
supportedViewports | string containing the json value of supported viewports. |
presentationSession | Configuration for presentation session displaying document |
receiveTime | The time at which the directive was received, for more accurate telemetry. |
agent | Pointer to the APLCapabilityAgentInterface notifying the observer. |
◆ onShowDocument()
virtual void alexaClientSDK::aplCapabilityCommonInterfaces::APLCapabilityAgentObserverInterface::onShowDocument |
( |
const PresentationToken & |
token | ) |
|
|
pure virtual |
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