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

#include <APLClientNamespace.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCNamespaces::AplCreateRendererMessage:
Inheritance graph
[legend]
Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCNamespaces::AplCreateRendererMessage:
Collaboration graph
[legend]

Public Member Functions

 AplCreateRendererMessage (const std::string &windowId, const std::string &token)
 
- Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message
 Message (const std::string &nameSpace, const int version, const std::string &name)
 
MessageaddMember (const std::string &name, const std::string &value)
 
MessageaddMember (const std::string &name, unsigned value)
 
MessageaddMemberInPayload (const std::string &name, const std::string &value)
 
MessageaddIntegerInPayload (const std::string &name, const int value)
 
MessageaddMemberInPayload (const std::string &name, unsigned value)
 
MessagesetEnabledInPayload (bool enabled)
 
MessagesetStateInPayload (const std::string &state)
 
MessagesetTokenInPayload (const std::string &token)
 
MessagesetTokenInPayload (unsigned token)
 
MessagesetParsedPayload (const std::string &payload)
 
MessagesetParsedPayloadInPayload (const std::string &payload)
 
MessagesetWindowIdInPayload (const std::string &windowId)
 
MessageaddPayload ()
 
MessagesetPayload (rapidjson::Value &&payload)
 
auto alloc () -> decltype(mDocument.GetAllocator())
 
std::string get ()
 
rapidjson::Value && getValue ()
 
- Public Member Functions inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface
 MessageInterface (const int version, const std::string &nameSpace, const std::string &name)
 

Additional Inherited Members

- Protected Attributes inherited from alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface
rapidjson::Document mDocument
 
rapidjson::Value mPayload
 

Detailed Description

The AplCreateRendererMessage provides the GUI Client with information to trigger an APL document render in the targeted window.

Constructor & Destructor Documentation

◆ AplCreateRendererMessage()

alexaClientSDK::sampleApplications::ipcServerSampleApp::ipc::IPCNamespaces::AplCreateRendererMessage::AplCreateRendererMessage ( const std::string &  windowId,
const std::string &  token 
)
inline

Constructor.

Parameters
windowIdThe id of the window to target with the APL document render.
tokenThe presentation token of the APL document to render

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