AlertDefinitionBase
Fields every alert definition has.
Name identifies the alert. MessageType is required and sets the colour, icon and log level ('Info', 'Success', 'Warning' or 'Error'). MessageHeader is the notification title. MessageText is the body. Suspend with IsSuspended.
export interface AlertDefinitionBase extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| MessageHeader | string | Title of displayed Alert Message |
| MessageText | string | Body of the displayed alert. The title is . Tokens such as the column and the old and new values are substituted when the alert fires. When omitted, a rule-based alert uses the scope and the rule, and a row-change alert uses a count of the rows that were added or removed. alertOptions.alertMessageText overrides this text when it returns a string. |
| MessageType | AdaptableMessageType | Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging |
| Name | string | Name of the Alert Definition |
| Type | AlertType | Alert category. When omitted, inferred from Rule or Schedule. See . |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
MessageHeader
Title of displayed Alert Message
MessageHeader?: string;Property Value
string
MessageText
Body of the displayed alert. The title is .
Tokens such as the column and the old and new values are substituted when the alert fires. When omitted, a rule-based alert uses the scope and the rule, and a row-change alert uses a count of the rows that were added or removed. alertOptions.alertMessageText overrides this text when it returns a string.
MessageText?: string;Property Value
string
MessageType
Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging
MessageType: AdaptableMessageType;Property Value
Name
Name of the Alert Definition
Name: string;Property Value
string
Type
Alert category. When omitted, inferred from Rule or Schedule. See .
Type?: AlertType;Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean