notifyContacts Method

This article contains the following topics:
casm1401
This article contains the following topics:
The following parameters apply to the notifyContacts method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
creator
String
Identifies the handle of the contact responsible for the activity.
contextObject
String
Identifies the handle for a request, issue, or change order. The following applies:
It is the context for the notification. Any other object type is rejected.
An activity log is added to the object to record the notification.
messageTitle
String
Identifies the title of the notification message.
messageBody
String
Identifies the body of the notification message.
notifyLevel
Integer
Indicates the notification level. Specify an integer from 1 (Low) to 4 (Emergency).
notifyees
String[]
Identifies the array of contact handles to notify.
Internal
Boolean
Indicates internal-only notification. Set to True to flag for an internal-only notification, which guarantees that the message is sent only to those who can view internal logs, and the resulting activity log is flagged as internal.
Description
Sends a notification to one or more contacts. This is equivalent to the Manual Notify activity on requests, issues, and change orders.
Returns
The following is returned:
XML Element
Type
Description
<LogHandle>
String
Identifies the handle for new activity log.
 
clearNotification
The following parameters apply to the clearNotification method:
Parameter
Type
Description
SID
Integer
Identifies the session retrieved from logging in.
lrObject
String
Identifies the handle to a Notify Log Header (lr) object.
clearBy
String
Identifies the name of the contact responsible for the clear operation.
Description
Clears a notification message.
Returns
The new status of the notification message.