AlertDefinition
The Alert Definition object used in the Alert function
TypeScript
export interface AlertDefinition extendsExtends
Properties
| Property | Description |
|---|---|
| AlertForm | Form to display in Alert with buttons and inputs |
| AlertProperties | Series of properties which set what happens when Alert is triggered |
| MessageHeader | Title of displayed Alert Message |
| MessageText | Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope |
| MessageType | Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging |
| Name | Name of the Alert Definition |
| Rule | When Alert should be triggered |
| Scope | Where Alert can be triggered: one, some or all columns or DataTypes |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | Suspends (i.e. turns off) an Adaptable Object |
Property Details
AlertForm
Form to display in Alert with buttons and inputs
TypeScript
AlertForm?: string | AlertButtonForm;Property Value
string |AlertButtonForm
AlertProperties
Series of properties which set what happens when Alert is triggered
TypeScript
AlertProperties?: AlertProperties;Property Value
MessageHeader
Title of displayed Alert Message
TypeScript
MessageHeader?: string;Property Value
string
MessageText
Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope
TypeScript
MessageText?: string;Property Value
string
MessageType
Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging
TypeScript
MessageType: AdaptableMessageType;Property Value
Name
Name of the Alert Definition
TypeScript
Name: string;Property Value
string
Rule
When Alert should be triggered
TypeScript
Rule: AlertRule;Property Value
Scope
Where Alert can be triggered: one, some or all columns or DataTypes
TypeScript
Scope: ColumnScope;Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
TypeScript
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean