Note | ||
---|---|---|
| ||
As of July 25th, 2023, there is a content freeze on this page. |
This is a user defined function that overrides the default break-message text formatting. When defined, this function is called whenever a break message is received by a session running Genie or Rich Display.
...
- message - (input). This is an object passed by Profound UI to your function containing the following fields:
- date - The date the message was sent.
- time - The time the message was sent.
- msg - The message content.
- jobName - The jobName of the user who sent the message.
- jobUserName - The user name of the user who sent the message.
- jobNum - The job number of the user who sent the message.
- jobCurProfName - The Current Profile Name of the user who sent the message.
- stringwrap - (output). This is an object that holds your formatted text. Profound UI looks for text in the following fields:
- title - The message box's title text becomes the value of message.title.
- body - The content of the message box becomes the value of message.body.
Default text formatting:
Message title format: date time, Sender's Job Number / Sender's Job User Name / Sender's Job Name.
Body format: receiving username : message content.
Break Messaging is available with Profound UI Version 5, Fix Pack 4.0.
...