FormIt.Messaging API

Description

Functions
json	FormIt.Messaging.GetMessages ()
	Get the list of available FormIt messages.
json	FormIt.Messaging.Broadcast (messageName, payload)
	Broadcast a message A custom message can be broadcast like- FormIt.Messaging.Broadcast("FormIt.Message.kFormItJSONMsg", {msg: "MyPlugin", payload: 3}); Parameters: In: messageName (string) In: payload (json)

Function Documentation

Broadcast()

json FormIt.Messaging.Broadcast	(	messageName	,
		payload
	)

Broadcast a message A custom message can be broadcast like- FormIt.Messaging.Broadcast("FormIt.Message.kFormItJSONMsg", {msg: "MyPlugin", payload: 3}); Parameters: In: messageName (string) In: payload (json)

Parameters

[in]	messageName	String
[in]	payload	(OPTIONAL) json

Returns

JSON_UNDEFINED

GetMessages()

json FormIt.Messaging.GetMessages

(

)

Get the list of available FormIt messages.

These messages can be subscribed to.

MessagesPluginListener = {};
// The message handling function that will be called for the given message.
MessagesPluginListener.MsgHandler = function(msg, payload) { console.log("(FormIt Side) msg: " + msg + " payload: " + payload); };
 
// Create a Message Listener that handles calling the subscribed message handlers.
if (!(MessagesPluginListener.hasOwnProperty("listener")))
{
    MessagesPluginListener.listener = FormIt.Messaging.NewMessageListener();
    console.log("Creating MessagesPluginListener.listener.");
}
 
// Assign the msg handler
MessagesPluginListener.listener[msg] = MessagesPluginListener.MsgHandler;
MessagesPluginListener.listener.SubscribeMessage(msg);

Returns

An array of strings.