AlertDefinitionBase
Fields shared by all alert definitions
TypeScript
export interface AlertDefinitionBase extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| MessageHeader | string | Title of displayed Alert Message |
| MessageText | string | Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope |
| MessageType | AdaptableMessageType | Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging |
| Name | string | Name of the Alert Definition |
| 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
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
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