ScheduledAlertDefinition

Alert that fires on a schedule (no rule or column scope)

TypeScript
export interface ScheduledAlertDefinition extends
Extends

AlertDefinitionBase

Properties

PropertyTypeDescription
AlertPropertiesScheduledAlertPropertiesNotification properties for scheduled alerts (no grid behaviours)
ScheduleScheduleWhen the alert should run
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspendedbooleanSuspends (i.e. turns off) an Adaptable Object

Property Details

AlertProperties

Notification properties for scheduled alerts (no grid behaviours)

TypeScript
AlertProperties?: ScheduledAlertProperties;
Property Value

ScheduledAlertProperties

Schedule

When the alert should run

TypeScript
Schedule: Schedule;
Property Value

Schedule

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