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
ParameterType
alertAlertDefinition
Returns

void

deleteAlert

TypeScript
deleteAlert(alertId: string): void;
Parameters
ParameterType
alertIdstring
Returns

void

editAlert

TypeScript
editAlert(alert: AlertDefinition): void;
Parameters
ParameterType
alertAlertDefinition
Returns

void

getAlertState

TypeScript
getAlertState(): AlertState;
Returns

AlertState

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
ParameterType
dataChangeDataChangeInfo
Returns

boolean