uptime-kuma/server/notification-providers/notification-provider.js

43 lines
1.2 KiB
JavaScript
Raw Normal View History

2021-09-07 07:42:46 -07:00
class NotificationProvider {
/**
* Notification Provider Name
* @type string
*/
name = undefined;
/**
* Send a notification
* @param {BeanModel} notification
* @param {string} msg General Message
* @param {?Object} monitorJSON Monitor details (For Up/Down only)
* @param {?Object} heartbeatJSON Heartbeat details (For Up/Down only)
2021-09-07 07:42:46 -07:00
* @returns {Promise<string>} Return Successful Message
* @throws Error with fail msg
2021-09-07 07:42:46 -07:00
*/
async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
throw new Error("Have to override Notification.send(...)");
}
/**
* Throws an error
* @param {any} error The error to throw
* @throws {any} The error specified
*/
2021-09-07 07:42:46 -07:00
throwGeneralAxiosError(error) {
let msg = "Error: " + error + " ";
if (error.response && error.response.data) {
if (typeof error.response.data === "string") {
msg += error.response.data;
} else {
2022-04-13 09:30:32 -07:00
msg += JSON.stringify(error.response.data);
2021-09-07 07:42:46 -07:00
}
}
2022-04-13 09:30:32 -07:00
throw new Error(msg);
2021-09-07 07:42:46 -07:00
}
}
module.exports = NotificationProvider;