AlertApi
TypeScript
declare class AlertApi extends BaseApi
Extends
BaseApi
Methods
Method |
---|
createAlert(alert) |
deleteAlert(alertId) |
editAlert(alert) |
getAlertState() |
getAllAlerts() |
getCustomActions() |
shouldPreventEdit(dataChange) |
Method Details
createAlert
TypeScript
createAlert(alert: AlertDefinition): void;
Parameters
Parameter | Type |
---|---|
alert | AlertDefinition |
Returns
void
deleteAlert
TypeScript
deleteAlert(alertId: string): void;
Parameters
Parameter | Type |
---|---|
alertId | string |
Returns
void
editAlert
TypeScript
editAlert(alert: AlertDefinition): void;
Parameters
Parameter | Type |
---|---|
alert | AlertDefinition |
Returns
void
getAlertState
TypeScript
getAlertState(): AlertState;
Returns
getAllAlerts
TypeScript
getAllAlerts(): AlertDefinition[];
Returns
AlertDefinition[]
getCustomActions
TypeScript
getCustomActions(): Record<string, CustomAlertActionDefinition> | undefined;
Returns
Record<string, CustomAlertActionDefinition> | undefined
shouldPreventEdit
TypeScript
shouldPreventEdit(dataChange: DataChangeInfo): boolean;
Parameters
Parameter | Type |
---|---|
dataChange | DataChangeInfo |
Returns
boolean