Class Notify
Handles notification of different types.
Syntax
Constructors
Notify()
Initializes a new instance of the Notify class.
Declaration
NotifyMethods
sendCustomMessage(Integer,String)
Sends a custom notification to a user.
Declaration
Void sendCustomMessage(Integer recipientId, String message)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | recipientId | The ID of the user to notify |
| String | message | The notify message. |
Returns
| Type | Description |
|---|---|
| Void |
sendCustomMessage(Integer,String,String)
Sends a custom notification message to user with specified URL.
Declaration
Void sendCustomMessage(Integer recipientId, String message, String url)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | recipientId | The ID of the user to notify. |
| String | message | The notification message. |
| String | url | The URL to navigate to by clicking the notification. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
URLs with HTTP or HTTPS protocol will open in a new tab. URLs without will be treated as relative and open in the same window.
Examples
Notify notify;
// Send custom notification to user with ID 2, clicking notification should open URL.
notify.sendCustomMessage(2,"Custom notification", "http://www.google.com");
sendNewTicket(Integer)
Sends a notification about a new request according to the user's notify configuration.
Declaration
Void sendNewTicket(Integer ticketId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | ticketId | The ID of the ticket to notify about. |
Returns
| Type | Description |
|---|---|
| Void |
sendNewTicket(Integer,Bool)
Sends a notification about a new request according to the user's notify configuration. By setting the parameter skipCategoryMemberNotification, this method will not notify members of the category (if set up) or the email address free-text field on the category.
Declaration
Void sendNewTicket(Integer ticketId, Bool skipCategoryMemberNotification)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | ticketId | The ID of the ticket to notify about |
| Bool | skipCategoryMemberNotification | Do not notify members or the email notification address set up on the category. |
Returns
| Type | Description |
|---|---|
| Void |
sendNewTicketMessage(Integer,Bool)
Notifies a user about a new message in the specified ticket according to the users notify configuration.
Declaration
Void sendNewTicketMessage(Integer ticketId, Bool onlyToHotLlist)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | ticketId | The ID of the ticket to be notified about |
| Bool | onlyToHotLlist | If true, only those with this ticket on their hotlists will be notified. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
If onlyToHotList is set to true, only those who has this ticket in their hotlists will be notified.
sendTicketActivated(Integer)
Sends a notification about a ticket being activated, according to the users notify configuration.
Declaration
Void sendTicketActivated(Integer ticketId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | ticketId | The ID of the ticket to be notified about. |
Returns
| Type | Description |
|---|---|
| Void |
sendTicketTakenOver(Integer,Integer,Integer)
Sends a notification to the users about a ticket being taken over.
Declaration
Void sendTicketTakenOver(Integer ticketId, Integer oldUserId, Integer newUserId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | ticketId | The ID of the ticket to be notified about |
| Integer | oldUserId | The ID of the user who owned the ticket |
| Integer | newUserId | The ID of the user who now owns the ticket. |
Returns
| Type | Description |
|---|---|
| Void |