Class NoticeAPI

Index Home MAE > MAE Architecture > MAE Data Types > Class Index > Class NoticeAPI

Summary
Public Methods
static bool postNotice(notice)
static bool postComment(comment)
static bool send(request, params)

#include <NoticeAPI.h >

Summary

This class is used by other apps to send messages to the notice channel.

Use this interface instead of sending messages directly to ensure message keywords are spelled correctly, all parameters are specified, and error checked.

The receiving app defined this interface to ensure it receives the messages correctly.

Public Methods

static bool postNotice(notice)

const UserNotice& notice

a UserNotice structure


Post a notice.

static bool postComment(comment)

const UserComment& comment

a UserComment structure


Post a comment.

static bool send(request, params)

const string& request

the request keyword

const XMLData& params

the data (parameter payload)

Default value: XMLData("")


Send an API message to channel notice.