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 setfield(device, table, field, value)

static bool settext(device, text, style)

static bool write(device, text, style)

static bool writeln(device, text, style)

Append to the display reagion with the provided text for the user specified, followed by a line break.

static bool writewiki(device, text)

Convert the text from wiki text (see wiki2doc) and display to the display region.

static bool addhotspot(device, text, action, cbdata, style)

Append the tagged area with the provided text for the user specified and make it a hot spot that triggers an action.

static bool addhinttext(device, text)

Provide hint text to the end-user for the display region. Exact implementation up to the end interface, but it may be to display text when the user hovers over the display region.

static bool button(device, text, action, cbdata)

Append the tagged area with the provided text on a button for the user on the device specified. When clicked, it triggers a a message with the action and callback data.

static bool format(device, control, on)

static bool newregion(device, newtag, styleName, size)

static bool style(device, styleName)

Set the named display style for device's current display region. See the configured properties of the style in the appropriate end-user display type (e.g. usergw uses HTML CSS).

static bool attention(device, text)

static bool selection(device, value)

When a display region contains a selector, set the active selection to the value provided. If the value is not a valid selection, behavior is undefined.

static bool chat(device, from, text)

static bool clear(device)

Clear all displayed objects and text from the current display region of the device.

static bool show(device)

static bool hide(device)

Hide the objects and text inside the current display region of the device. Make them non-visible.

static bool newtable(device, tableName, tableType, rows, columns)

Create a table display region on the user'd device. It will be setup with the rows and columns specified. Note that referencing one column more to the right will create that column; and referencing one more row below will create that row.

static bool newlist(device, name, items)

Create a bulleted list that can contains items. Note that adding a list item immediately beyond the end will expand the list.

static bool record(device, recordName, idmap, values, overwrite)

Output a record of information using a templte to map old UI ids to new ones. For idmap, the key is the old id and the value is the new id

static bool report(device, reportName, table, table_id)

static bool prompt(device, query, value, promptType, xid, style)

Present the user with a question and response (text entry) box. The xid parameter ties back to the appropriate response action and callback data to use when replying (see GuiAPI).

static bool select(device, option0, options, xid, selected)

Present the user with a selection of choices. The xid parameter ties back to the appropriate response action and callback data to use when replying (see GuiAPI).

static bool checkbox(device, query, value, xid, style)

Present the user with a selection of choices as checkboxes. The xid parameter ties back to the appropriate response action and callback data to use when replying (see GuiAPI).

static bool textarea(device, text, xid, style, saveLabel)

Present the user with an area to type a lot of text. The xid parameter ties back to the appropriate response action and callback data to use when replying (see GuiAPI).

static bool form(device, formName, vars, xid)

Present the user with input form template. The xid parameter ties back to the appropriate response action and callback data to use when replying (see GuiAPI).

static bool screen(device, name, rows, columns)

static bool scrattr(device, attributes)

Set the current terminal screen attributes for the next character(s) to be written.

static bool scrchar(device, row, column, letter, amount)

Write a character to the terminal screen previously defined at device's display region.

static bool setmenu(device, menu, option, command)

Configure the end-user's device with the menu option under the specified menu. When the end-user selects it, the specified command will be sent as a message request of the app.

static bool unsetmenu(device, menu, option)

static bool setwindow(device, windowName)

static bool unsetwindow(device, windowName)

static bool setindex(device, indexName)

static bool unsetindex(device, indexName)

static bool newsection(device, title, sectionType, newtag)

Add a section the the UI. Sections can be manipulated, for example expanded/collapsed.

static bool collapseSection(device)

static bool expandSection(device)

static bool displayImage(device, imageName, image_type, action, cbdata, append)

Display the referenced buffered image that has already been transferred to display channel. If an action is provided, the image can be clicked on to trigger the action with its callback data.

static bool displayImage(device, image_id, action, cbdata, append)

Display the referenced buffered image that has already been transferred to display channel. If an action is provided, the image can be clicked on to trigger the action with its callback data.

static bool playAudio(device, audioName)

static bool download(device, query, fileclass, xid)

static bool upload(device, imageName, image_type)

Send a file to the end-user's device that has already been transferred to display channel.

static bool imagelibpre(device, id)

static bool bufimage(device, imageName, image_type, width, height, size, binary, chunk, totalChunks, chunksize, data)

static bool setvar(device, variable, value)

static bool getvar(device, variable, value)

static bool run(device, appname, startParams)

Switch the user from running one app to a different app using the provided parameters.

static bool stop(device)

static bool userAccountChange(userId, action, value)

static bool registerApp(appmode, apptype, action, contentInputType, contentOutputType, operations, msgchannel, privatePages)

static bool startraw(device, statusCode, contentType)

static bool writeraw(device, text, isBinary)

Output text to the connection without modifying the text at all. If the text is binary, it is converted from hex codes to binary before transmission.

const UserDevice& device	the end-user's device
const string& table	the area with a collection of fields in it
const string& field	the specific field within that area
const string& value	the string to display

const UserDevice& device	the end-user's device
const string& text	the text to put there
const string& style	display style for the text

const UserDevice& device	the end-user's device
const string& text	the text to append
const string& style	display style for the text

const UserDevice& device	the end-user's device
const string& text	the text to append
const string& style	display style for the text

const UserDevice& device	the end-user's device
const string& text	the text to append

const UserDevice& device	the end-user's device
const string& control	the UI state keyword to update, e.g. strong, emphasis, bold, italic, underline, color:color
bool on	flag to say turn the control on or off

const UserDevice& device	the end-user's device
const string& newtag	the new region's name
const string& styleName	the preset way to display the text (color, font, etc)
int size	the number of characters wide for the new region (suggestion)

const UserDevice& device	the end-user's device
const string& from	name of user whom the message is from
const string& text	the message to display

const UserDevice& device	the end-user's device
string tableName	the name of the table
const string& tableType	the type of table, e.g. left, center, right
int rows	the number of rows in the table
int columns	the number of columns in the table

const UserDevice& device	the end-user's device
string name	the name of the list
int items	a count of the expected number of list items (suggestion)

const UserDevice& device	the end-user's device
const string& recordName	the record template's name (this corresponds to a file under .../html/record)
const HashArray& idmap	(optional) mapping of template field names to actual ids to use
const HashArray& values	key/value paris of id/values to fill in values in the record
bool overwrite	flag: true to replace existing display region, false to append Default value: true

const UserDevice& device	the end-user's device
const string& reportName	the name of the report to output
const string& table	the name of the table to ...?
DbRecNum table_id	the id for the table ...?

const UserDevice& device	the end-user's device
const string& query	(optional) the question text for the user
const string& value	the default value
const string& promptType	the type of prompt, e.g. text, yn, int, etc.
DbRecNum xid	a transaction id maintained by the calling app (guibroker)
const string& style	the style to use for the query

const UserDevice& device	the end-user's device
const string& option0	The visible question that is the first option on the list - and the default if no value is given. If the user actually selects this option, the app will be given the value $NA
const HashArray& options	the list of options to show the user. They key is show; the value is returned as the reply.
DbRecNum xid	a transaction id maintained by the calling app (guibroker)
const string& selected	the selected option

const UserDevice& device	the end-user's device
const string& formName	the name of the form (relates to .../html/form files)
const HashArray& vars	key/value paris of id/values to fill in default values
DbRecNum xid	a transaction id maintained by the calling app (guibroker)

const UserDevice& device	the end-user's device
const string& name	the name of the screen for reference
int rows	number of rows in the screen Default value: 25
int columns	the number of columns in the screen Default value: 80

const UserDevice& device	the end-user's device
const string& attributes	a comma separated list of styles, e.g. cursor, bold, underline, reverse, red, blue, etc

const UserDevice& device	the end-user's device
int row	the terminal row
int column	the terminal column
int letter	a numerical value for the letter to write, e.g. ASCII. Note that letters 0-31 are non-printable.
int amount	the number of letters to write out (repeating letters) Default value: 1

const UserDevice& device	the end-user's device
const string& menu	the menu heading that contains menu options
const string& option	the menu option text
const string& command	the request keyword to send to the app

const UserDevice& device	the end-user's device
const string& windowName	the name of the window; it appears as the window's title

const UserDevice& device	the end-user's device
const string& indexName	the name of the index; it appears as the index's title

const UserDevice& device	the end-user's device
const string& title	the section title
const string& sectionType	a comma separated list of section qualities, e.g. collabsable, h2, h3
const string& newtag	the tag for the section (must begin with Section_)

const UserDevice& device	the end-user's device
const string& imageName	the Image's name (see Image class)
const string& image_type	the image type, e.g. svg, gif
const string& action	(optional) if specified, then image is a hot spot; when the user clicks on it, a message will be send with this action/request keyword
const XMLData& cbdata	(optional) if an action was specified, then image is a hot spot; when the user clicks on it, a message will be send with this callback data
bool append	Add the image or replace the contents of the device's current region. Default: false/replace. Default value: false

const UserDevice& device	the end-user's device
ImageLibId image_id	the image id from the ImageLib library
const string& action	(optional) if specified, then image is a hot spot; when the user clicks on it, a message will be send with this action/request keyword
const XMLData& cbdata	(optional) if an action was specified, then image is a hot spot; when the user clicks on it, a message will be send with this callback data
bool append	Add the image or replace the contents of the device's current region. Default: false/replace. Default value: false

const UserDevice& device	the end-user's device
const string& audioName	the audio sound's name (or HTML tag, e.g. audio_audioName)

const UserDevice& device	the end-user's device
DbRecNum id	the image's id in ImageLib

const UserDevice& device	the end-user's device
const string& variable	the end-user device variable to set, e.g. wid (tenant id), pc
const string& value	the new value of the variable

const UserDevice& device	the end-user's device
const string& appname	the app to run
const XMLData& startParams	the initial parameters for running that app (app-specific); note that any XML sub-objects will not pass through to new process - only key/value property pairs

int userId	User datastore's id for user
const string& action	Action to take on user's account, e.g disable
string value	Parameter for action, e.g. T, F

const string& appmode	Name of appmode, likely the app's name. All URL's for //site/appmode/ will trigger a message using action below
const string& apptype	type of behavior to remote client: Ux (asynchronous user experience in browser), Direct (synchronous query gets synchronous response), Pipe (streamed data from remote connection is fed to app by line or binary block) Default value: "Ux"
const string& action	name of action to send to app when URL connection established Default value: ""
const string& contentInputType	the expected input content payload. A HTTP simple form POSTing sends form-data; a REST call may send json or xml. Default value: "form-data"
const string& contentOutputType	the default response content payload, e.g. json, xml Default value: "json"
const StringList& operations	a list of HTTP operations allowed. "GET,POST" is typical, but a REST interface may also include PUT, DELETE, or PATCH. The value is a comma separted list. Default value: StringList("GET,POST")
const string& msgchannel	specify if other than the default channel for the calling app. Default value: ""
bool privatePages	true if only authenticated users may access, false if public Default value: true