|
|
Reference Type: Supported, Category: Alerts, Integration Agreement: 10081
This API deletes (clears) a single alert, for the current user (XQAKILL=1)
or all recipients (XQAKILL=0 or XQAKILL undefined). The current user (as
identified by the value of DUZ) does not need to be a recipient of an
alert; however, in that case, only a value of zero (0 or undefined) for
XQAKILL makes sense.
DELETE^XQALERT, unlike DELETEA^XQALERT, deletes
only a single alert whose alert identifier matches the complete Alert
Identifier.
NOTE: For more information on alert identifiers, please
refer to the "Package Identifier versus Alert Identifier" topic in the
Kernel Programmer Manual.
DELETE^XQALERT(xqaid[,xqakill])
| xqaid: |
(required) Alert Identifier of the alert to delete. It must be a complete Alert Identifier, containing all three semicolon pieces. The first semicolon piece (Package Identifier) must be in the same form as the alert creator defined it, the second piece being the DUZ of the user who created the alert, and the third piece being the time the alert was created (the second and third pieces are defined by the Alert Handler). |
|
| xqakill: |
If XQAKILL is undefined or zero (0), the Alert Handler
deletes the alert for all recipients. If XQAKILL is set to 1, Alert
Handler only purges the alert for the current user as identified by
DUZ (using a value of 1 only makes sense if the current user is a
recipient of the alert, however).
|
|
| none |
|
|
|
VA (Internet) / VA (Intranet) / OI / HSD&D / Site Map / Terms of Use / VA Privacy Policy / Accessibility Reviewed/Updated:
November 15, 2006
|