AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Protected Attributes | List of all members
alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface Class Referenceabstract

#include <MessageInterface.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface:
Inheritance graph

Public Member Functions

 MessageInterface (const int version, const std::string &nameSpace, const std::string &name)
virtual std::string get ()=0
virtual rapidjson::Value && getValue ()=0

Protected Attributes

rapidjson::Document mDocument
rapidjson::Value mPayload

Detailed Description

An interface for rapidjson::Document based messages.

All messages have the format: { header : { version, namespace, name } payload : {} }

Constructor & Destructor Documentation

◆ MessageInterface()

alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface::MessageInterface ( const int  version,
const std::string &  nameSpace,
const std::string &  name 


versionThe version for this message
nameSpaceThe namespace for this message
nameThe type from this message

Member Function Documentation

◆ get()

virtual std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface::get ( )
pure virtual

Retrieves the json string representing this message

json string representation of message

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message.

◆ getValue()

virtual rapidjson::Value&& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface::getValue ( )
pure virtual

Retrieves the rapidjson::Value object representation of this message

rapidjson::Value object representation of message

Implemented in alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message.

Member Data Documentation

◆ mDocument

rapidjson::Document alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface::mDocument

◆ mPayload

rapidjson::Value alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface::mPayload

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

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