CLASS UserMessage
This class requires no license. It includes the provision of a component referenece to a list of resources in the User component (class). UserMessage uses standard functions and an action.
This class does not allow log transforms.
Class Field Properties
| Name | Codename | Description | Ability | Length |
|---|---|---|---|---|
| msgtime | MsgTimeSent | Time sent | RO | 255 |
Class Functions
| Name | Description |
|---|---|
| static cancel | cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with UserMessage.get(name). |
| static close | UserMessage.close() takes no arguments. |
| static connect | UserMessage.connect() takes no arguments. |
| static create | UserMessage.create() takes no arguments. |
| static delete | UserMessage.delete() takes no arguments. |
| static deleteAll | deleteAll() takes no arguments. This action removes all messages from the UserMessage object. |
| static ExclusiveConnect | UserMessage.ExclusiveConnect() takes no arguments. |
| static exists | UserMessage.exists() takes no arguments. |
| static get | UserMessage.get(name) takes an argument, name. This standard function gets and returns the named UserMessage object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception. |
| static getCount | UserMessage.getCount() takes no arguments. This standard function gets the number of defined UserMessage resources. |
| static getFetchLevel | UserMessage.getFetchLevel() takes no arguments. |
| static getList | UserMessage.getList() takes no arguments. This standard function gets and returns an arrary (list) of UserMessage resources. |
| static getLog | UserMessage.getLog() takes no arguments. |
| static getLogCalendar | UserMessage.getLogCalendar() takes no arguments. |
| static getNames | UserMessage.getNames() takes no arguments. This standard function gets and returns an array of strings object with the UserMessage names. |
| static getRange | UserMessage.getRange() takes no arguments. |
| static getUsage | UserMessage.getUsage() takes no arguments. |
| static isConnected | UserMessage.isConnected() takes no arguments. |
| static isNew | isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called. |
| static log | UserMessage.log() takes no arguments. |
| static logScannable | UserMessage.logScannable() takes no arguments. |
| static monitor | UserMessage.monitor() takes no arguments. |
| static read | UserMessage.read() takes no arguments. |
| static refresh | UserMessage.refresh() takes no arguments. |
| static save | save() takes no arguments. User must have save privileges. This standard function saves to the server a UserMessage object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails. |
| static setFetchLevel | UserMessage.setFetchLevel() takes no arguments. |
| static update | UserMessage.update() takes no arguments. |
| static write | UserMessage.write() takes no arguments. |
Class Privilege Properties
| Type | Name |
|---|---|
| AWARE | Aware |
| DELETE | Delete |
| VIEW | View |
| MODIFY | Edit |