alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message Class Reference

#include <Message.h>

Inheritance diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message:

Collaboration diagram for alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message:

Public Member Functions
	Message (const std::string &nameSpace, const int version, const std::string &name)
Message &	addMember (const std::string &name, const std::string &value)
Message &	addMember (const std::string &name, unsigned value)
Message &	addMemberInPayload (const std::string &name, const std::string &value)
Message &	addIntegerInPayload (const std::string &name, const int value)
Message &	addMemberInPayload (const std::string &name, unsigned value)
Message &	setEnabledInPayload (bool enabled)
Message &	setStateInPayload (const std::string &state)
Message &	setTokenInPayload (const std::string &token)
Message &	setTokenInPayload (unsigned token)
Message &	setParsedPayload (const std::string &payload)
Message &	setParsedPayloadInPayload (const std::string &payload)
Message &	setWindowIdInPayload (const std::string &windowId)
Message &	addPayload ()
Message &	setPayload (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

Helper class to construct a MessageInterface message.

Constructor & Destructor Documentation

Message()

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

inline

Constructor

Parameters

namespace	The namespace from this message
version	The version from this message
name	The handler name from this message

Member Function Documentation

addIntegerInPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addIntegerInPayload ( const std::string &  name, const int  value  )

inline

Add an integer to existing payload

Parameters

name	The name of the new member
value	The value of the new member

Returns

this

addMember() [1/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addMember ( const std::string &  name, const std::string &  value  )

inline

Add a new member to the json

Parameters

name	The name of the new member
value	The value of the new member

Returns

this

addMember() [2/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addMember ( const std::string &  name, unsigned  value  )

inline

Add a new member to the json

Parameters

name	The name of the new member
value	The value of the new member

Returns

this

addMemberInPayload() [1/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addMemberInPayload ( const std::string &  name, const std::string &  value  )

inline

Add a new member to existing payload

Parameters

name	The name of the new member
value	The value of the new member

Returns

this

addMemberInPayload() [2/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addMemberInPayload ( const std::string &  name, unsigned  value  )

inline

Add a new member to the existing payload

Parameters

name	The name of the new member
value	The value of the new member

Returns

this

addPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::addPayload ( )

inline

Add the payload to this message

Returns

this

alloc()

auto alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::alloc ( ) -> decltype(mDocument.GetAllocator())

inline

Retrieves the rapidjson allocator

Returns

The allocator

get()

std::string alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::get ( )

inlinevirtual

Retrieves the json string representing this message

Returns

json string representation of message

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface.

getValue()

rapidjson::Value&& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::getValue ( )

inlinevirtual

Retrieves the rapidjson::Value object representation of this message

Returns

rapidjson::Value object representation of message

Implements alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::MessageInterface.

setEnabledInPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setEnabledInPayload ( bool  enabled )

inline

Sets the json enabled for this message

Parameters

enabled

The enabled bool to send

Returns

this

setParsedPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setParsedPayload ( const std::string &  payload )

inline

Sets the json payload for this message

Parameters

payload

The payload to parse and send

Returns

this

setParsedPayloadInPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setParsedPayloadInPayload ( const std::string &  payload )

inline

Sets the json payload for this message

Parameters

payload

The payload to parse and send

Returns

this

setPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setPayload ( rapidjson::Value &&  payload )

inline

Sets the json payload for this message

Parameters

payload

The payload to send

Returns

this

setStateInPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setStateInPayload ( const std::string &  state )

inline

Sets the json state for this message

Parameters

state

The state to send

Returns

this

setTokenInPayload() [1/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setTokenInPayload ( const std::string &  token )

inline

Sets the token for this message

Parameters

token

Returns

this

setTokenInPayload() [2/2]

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setTokenInPayload ( unsigned  token )

inline

Sets the token for this message

Parameters

token

Returns

this

setWindowIdInPayload()

Message& alexaClientSDK::sampleApplications::ipcServerSampleApp::messages::Message::setWindowIdInPayload ( const std::string &  windowId )

inline

Sets the windowId for this message

Parameters

windowId

The target windowId of

Returns

this

---

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

• /workplace/avs-device-sdk/SampleApplications/IPCServerSampleApplication/LibIPCServerSampleApp/include/IPCServerSampleApp/Messages/Message.h