BatchJobAlerts::addAlertsToMap Method
Adds an alert entry to the supplied map instance. If no map is supplied, one is created.
Syntax
client server public static Map addAlertsToMap(
UserId _userId,
NoYes _batchJobEnded,
NoYes _batchJobError,
NoYes _batchJobCanceled,
NoYes _popup,
NoYes _email,
[Map alertsData])
Run On
Called
Parameters
- _userId
Type: UserId Extended Data Type
A UserId value for which to create the alert subscription.
- _batchJobEnded
Type: NoYes Enumeration
A NoYes enumeration value that indicates whether to notify the user when the job completes successfully.
- _batchJobError
Type: NoYes Enumeration
A NoYes enumeration value that indicates whether to notify the user when the job completes with an error.
- _batchJobCanceled
Type: NoYes Enumeration
A NoYes enumeration value that indicates whether to notify the user when the job is canceled.
- _popup
Type: NoYes Enumeration
A NoYes enumeration value that indicates whether to show alerts in a popup window.
- _email
Type: NoYes Enumeration
A NoYes enumeration value that indicates whether to send alerts as emails.
- alertsData
Type: Map Class
A map to which the alert subscription is added; a UserId value is the key. If nullNothingnullptrunita null reference (Nothing in Visual Basic) is passed a new map is created.
Return Value
Type: Map Class
A map that contains the subscription entry is returned.
Remarks
Pass null Nothing nullptr unit a null reference (Nothing in Visual Basic) as the value of the alertsData parameter to the first call of this function. In subsequent calls, pass the map that is returned as the value of the alertsData parameter.