Class: AlertUtils
Defined in: core/src/AlertUtils.ts:117
The AlertUtils class is used to send alerts about important system events that have occurred
and require further monitoring or intervention.
Constructors
Constructor
new AlertUtils(
options):AlertUtils
Defined in: core/src/AlertUtils.ts:129
Creates a new instance of AuthUtils with the provided defaults.
Parameters
options
The configuration options to use.
Returns
AlertUtils
Methods
addAttachment()
addAttachment(
id,attachment,indexFile?):Promise<boolean>
Defined in: core/src/AlertUtils.ts:326
Uploads a single attachment to the alert with the given unique identifier.
Parameters
id
string
The unique identifier of the alert to add an attachment for.
attachment
The file to upload as an attachment.
indexFile?
string
Sets the indexFile parameter of the request.
Returns
Promise<boolean>
True if the operation was successful, otherwise false.
close()
close(
id,data?):Promise<boolean>
Defined in: core/src/AlertUtils.ts:147
Attempts to close the existing alert with the given identifier.
Parameters
id
string
The unique identifier of the alert to close.
data?
AlertClose = {}
Returns
Promise<boolean>
True if the operation was successful, otherwise false.
get()
get(
id):Promise<Alert|null>
Defined in: core/src/AlertUtils.ts:178
Attempts to retrieve the existing alert with the given identifier.
Parameters
id
string
The unique identifier of the alert to retrieve.
Returns
Promise<Alert | null>
The retrieved alert if successful, otherwise null.
send()
send(
alert,vars?,attachments?):Promise<string|null>
Defined in: core/src/AlertUtils.ts:204
Sends the provided alert to the configured monitoring service.
Parameters
alert
The alert to send.
vars?
any = {}
A map of vars to perform replacement on for the alert's various properties.
attachments?
The attachments to upload along with the alert.
Returns
Promise<string | null>
The unique identifier of the created alert if the operation was successful, otherwise null.