pjs.sendMessage()

Owned by Alex Roytman
Last updated: Aug 16, 2023 by Jessica Tomkins
1 min read



Sends a message to a session-based Subfile Program Message Queue. This API is utilized in conjunction with setting the sflMsgQueueType configuration option to "pjs session" and the msgFileType configuration option to "json".

The messages are then typically displayed within a Rich Display File that defines a messages grid with Message Subfile Settings.

Parameters

  1. Message File - the name of the JSON-based message file; if not qualified, the pathlist is used to find the .json message file

  2. Message ID - the ID of the message to retrieve from the message file

  3. Message Replacement Data (optional) - data field or a data structure that contains all the replacement values required by the message; the length and format of the field depend on the  substitution variables described in the message; for example, for a message with 2 substitution variables defined as *CHAR 10 and *CHAR 5, the replacement data should be a 15 byte field

  4. Program Message Queue (optional) - the name of a message queue; if not specified, the current program name is used

Example
pjs.sendMessage('MYMSGF.json', 'ERR9999', msgdata);