AdapTable Types Reference

ScheduleApi

Provides run-time access to the Schedule Module and associated state

TypeScript
export interface

Methods

MethodDescription
addIPushPullSchedule(iPushPullSchedule)Add ipushpull-based Schedule
addOpenFinSchedule(openFinSchedule)Add OpenFin-based Schedule
addReminderSchedule(reminderSchedule)Adds Reminder-based Schedule
addReportSchedule(reportSchedule)Adds Report / Export Schedule
applySchedule(schedule, scheduleType)Applies the Schedule of given type
deleteIPushPullSchedule(iPushPullSchedule)Delete ipushpull-based Schedule
deleteOpenFinSchedule(openFinSchedule)Delete OpenFin-based Schedule
deleteReminderSchedule(reminderSchedule)Deletes Reminder-based Schedule
deleteReportSchedule(reportSchedule)Deletes Report / Export Schedule
editIPushPullSchedule(iPushPullSchedule)Edit ipushpull-based Schedule
editOpenFinSchedule(openFinSchedule)Edit OpenFin-based Schedule
editReminderSchedule(reminderSchedule)Edits Reminder-based Schedule
editReportSchedule(reportSchedule)Edits Report / Export Schedule
editSchedule(schedule)Edits a Schedule
getActiveIPushPullSchedules()Retrieves all active (not-suspended) ipushpull-based Schedules from Schedule State
getActiveOpenFinSchedules()Retrieves all active (not-suspended) OpenFin-based Schedules from Schedule State
getActiveReminderSchedules(config)Retrieves all active (not-suspended) Reminder-based Schedules from Schedule State
getActiveReportSchedules()Retrieves all active (not-suspended) Report / Export Schedules from Schedule State
getIPushPullSchedules(config)Retrieves all ipushpull-based Schedules from Schedule State
getOpenFinSchedules(config)Retrieves all OpenFin-based Schedules from Schedule State
getReminderSchedules(config)Retrieves all Reminder-based Schedules from Schedule State
getReportSchedules(config)Retrieves all Report / Export Schedules from Schedule State
getScheduleById(id, config)Retrieves Schedule by id
getScheduleByName(name)Retrieves a Schedule by its Name
getSchedules(config)Retrieves the Schedule section from Adaptable State
getScheduleState()Retrieves Schedule section from Adaptable State
getSuspendedIPushPullSchedules()Retrieves all suspended ipushpull-based Schedules from Schedule State
getSuspendedOpenFinSchedules()Retrieves all suspended OpenFin-based Schedules from Schedule State
getSuspendedReminderSchedules(config)Retrieves all suspended Reminder-based Schedules from Schedule State
getSuspendedReportSchedules()Retrieves all suspended Report / Export Schedules from Schedule State
openScheduleSettingsPanel()Opens Settings Panel with Schedule section selected and visible
suspendIPushPullSchedule(iPushPullSchedule)Suspends ipushpull-based Schedule
suspendOpenFinSchedule(openFinSchedule)Suspends OpenFin-based Schedule
suspendReminderSchedule(reminderSchedule)Suspends Reminder-based Schedule
suspendReportSchedule(reportSchedule)Suspends Report / Export Schedule
unSuspendIPushPullSchedule(iPushPullSchedule)Activates a suspended ipushpull-based Schedule
unSuspendOpenFinSchedule(openFinSchedule)Activates a suspended OpenFin-based Schedule
unSuspendReminderSchedule(reminderSchedule)Activates a suspended Reminder-based Schedule
unSuspendReportSchedule(reportSchedule)Activates a suspended Report / Export Schedule

Method Details

addIPushPullSchedule

Add ipushpull-based Schedule

TypeScript
addIPushPullSchedule(iPushPullSchedule: IPushPullSchedule): IPushPullSchedule;
Parameters
ParameterType
iPushPullScheduleIPushPullSchedule
Returns

IPushPullSchedule

addOpenFinSchedule

Add OpenFin-based Schedule

TypeScript
addOpenFinSchedule(openFinSchedule: OpenFinSchedule): OpenFinSchedule;
Parameters
ParameterType
openFinScheduleOpenFinSchedule
Returns

OpenFinSchedule

addReminderSchedule

Adds Reminder-based Schedule

TypeScript
addReminderSchedule(reminderSchedule: ReminderSchedule): ReminderSchedule;
Parameters
ParameterType
reminderScheduleReminderSchedule
Returns

ReminderSchedule

addReportSchedule

Adds Report / Export Schedule

TypeScript
addReportSchedule(reportSchedule: ReportSchedule): ReportSchedule;
Parameters
ParameterType
reportScheduleReportSchedule
Returns

ReportSchedule

applySchedule

Applies the Schedule of given type

TypeScript
applySchedule(schedule: BaseSchedule, scheduleType: 'Report' | 'ipushpull' | 'Reminder' | 'OpenFin'): void;
Parameters
ParameterTypeDescription
scheduleBaseScheduleSchedule to apply
scheduleType'Report' | 'ipushpull' | 'Reminder' | 'OpenFin'type of Schedule
Returns

void

deleteIPushPullSchedule

Delete ipushpull-based Schedule

TypeScript
deleteIPushPullSchedule(iPushPullSchedule: IPushPullSchedule): void;
Parameters
ParameterType
iPushPullScheduleIPushPullSchedule
Returns

void

deleteOpenFinSchedule

Delete OpenFin-based Schedule

TypeScript
deleteOpenFinSchedule(openFinSchedule: OpenFinSchedule): void;
Parameters
ParameterType
openFinScheduleOpenFinSchedule
Returns

void

deleteReminderSchedule

Deletes Reminder-based Schedule

TypeScript
deleteReminderSchedule(reminderSchedule: ReminderSchedule): void;
Parameters
ParameterType
reminderScheduleReminderSchedule
Returns

void

deleteReportSchedule

Deletes Report / Export Schedule

TypeScript
deleteReportSchedule(reportSchedule: ReportSchedule): void;
Parameters
ParameterType
reportScheduleReportSchedule
Returns

void

editIPushPullSchedule

Edit ipushpull-based Schedule

TypeScript
editIPushPullSchedule(iPushPullSchedule: IPushPullSchedule): IPushPullSchedule;
Parameters
ParameterType
iPushPullScheduleIPushPullSchedule
Returns

IPushPullSchedule

editOpenFinSchedule

Edit OpenFin-based Schedule

TypeScript
editOpenFinSchedule(openFinSchedule: OpenFinSchedule): OpenFinSchedule;
Parameters
ParameterType
openFinScheduleOpenFinSchedule
Returns

OpenFinSchedule

editReminderSchedule

Edits Reminder-based Schedule

TypeScript
editReminderSchedule(reminderSchedule: ReminderSchedule): ReminderSchedule;
Parameters
ParameterType
reminderScheduleReminderSchedule
Returns

ReminderSchedule

editReportSchedule

Edits Report / Export Schedule

TypeScript
editReportSchedule(reportSchedule: ReportSchedule): ReportSchedule;
Parameters
ParameterType
reportScheduleReportSchedule
Returns

ReportSchedule

editSchedule

Edits a Schedule

TypeScript
editSchedule(schedule: BaseSchedule): BaseSchedule;
Parameters
ParameterTypeDescription
scheduleBaseScheduleSchedule to Edit
Returns

BaseSchedule

getActiveIPushPullSchedules

Retrieves all active (not-suspended) ipushpull-based Schedules from Schedule State

TypeScript
getActiveIPushPullSchedules(): IPushPullSchedule[];
Returns

IPushPullSchedule[]

getActiveOpenFinSchedules

Retrieves all active (not-suspended) OpenFin-based Schedules from Schedule State

TypeScript
getActiveOpenFinSchedules(): OpenFinSchedule[];
Returns

OpenFinSchedule[]

getActiveReminderSchedules

Retrieves all active (not-suspended) Reminder-based Schedules from Schedule State

TypeScript
getActiveReminderSchedules(config?: LayoutExtendedConfig): ReminderSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

ReminderSchedule[]

getActiveReportSchedules

Retrieves all active (not-suspended) Report / Export Schedules from Schedule State

TypeScript
getActiveReportSchedules(): ReportSchedule[];
Returns

ReportSchedule[]

getIPushPullSchedules

Retrieves all ipushpull-based Schedules from Schedule State

TypeScript
getIPushPullSchedules(config?: LayoutExtendedConfig): IPushPullSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

IPushPullSchedule[]

getOpenFinSchedules

Retrieves all OpenFin-based Schedules from Schedule State

TypeScript
getOpenFinSchedules(config?: LayoutExtendedConfig): OpenFinSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

OpenFinSchedule[]

getReminderSchedules

Retrieves all Reminder-based Schedules from Schedule State

TypeScript
getReminderSchedules(config?: LayoutExtendedConfig): ReminderSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

ReminderSchedule[]

getReportSchedules

Retrieves all Report / Export Schedules from Schedule State

TypeScript
getReportSchedules(config?: LayoutExtendedConfig): ReportSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

ReportSchedule[]

getScheduleById

Retrieves Schedule by id

TypeScript
getScheduleById(id: BaseSchedule['Uuid'], config?: LayoutExtendedConfig): BaseSchedule;
Parameters
ParameterTypeDescription
idBaseSchedule['Uuid']Schedule id
configLayoutExtendedConfig
Returns

BaseSchedule

getScheduleByName

Retrieves a Schedule by its Name

TypeScript
getScheduleByName(name: string): BaseSchedule | undefined;
Parameters
ParameterTypeDescription
namestringName of the Schedule
Returns

BaseSchedule | undefined

getSchedules

Retrieves the Schedule section from Adaptable State

TypeScript
getSchedules(config?: LayoutExtendedConfig): BaseSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

BaseSchedule[]

getScheduleState

Retrieves Schedule section from Adaptable State

TypeScript
getScheduleState(): ScheduleState;
Returns

ScheduleState

getSuspendedIPushPullSchedules

Retrieves all suspended ipushpull-based Schedules from Schedule State

TypeScript
getSuspendedIPushPullSchedules(): IPushPullSchedule[];
Returns

IPushPullSchedule[]

getSuspendedOpenFinSchedules

Retrieves all suspended OpenFin-based Schedules from Schedule State

TypeScript
getSuspendedOpenFinSchedules(): OpenFinSchedule[];
Returns

OpenFinSchedule[]

getSuspendedReminderSchedules

Retrieves all suspended Reminder-based Schedules from Schedule State

TypeScript
getSuspendedReminderSchedules(config?: LayoutExtendedConfig): ReminderSchedule[];
Parameters
ParameterType
configLayoutExtendedConfig
Returns

ReminderSchedule[]

getSuspendedReportSchedules

Retrieves all suspended Report / Export Schedules from Schedule State

TypeScript
getSuspendedReportSchedules(): ReportSchedule[];
Returns

ReportSchedule[]

openScheduleSettingsPanel

Opens Settings Panel with Schedule section selected and visible

TypeScript
openScheduleSettingsPanel(): void;
Returns

void

suspendIPushPullSchedule

Suspends ipushpull-based Schedule

TypeScript
suspendIPushPullSchedule(iPushPullSchedule: IPushPullSchedule): IPushPullSchedule;
Parameters
ParameterType
iPushPullScheduleIPushPullSchedule
Returns

IPushPullSchedule

suspendOpenFinSchedule

Suspends OpenFin-based Schedule

TypeScript
suspendOpenFinSchedule(openFinSchedule: OpenFinSchedule): OpenFinSchedule;
Parameters
ParameterType
openFinScheduleOpenFinSchedule
Returns

OpenFinSchedule

suspendReminderSchedule

Suspends Reminder-based Schedule

TypeScript
suspendReminderSchedule(reminderSchedule: ReminderSchedule): ReminderSchedule;
Parameters
ParameterType
reminderScheduleReminderSchedule
Returns

ReminderSchedule

suspendReportSchedule

Suspends Report / Export Schedule

TypeScript
suspendReportSchedule(reportSchedule: ReportSchedule): ReportSchedule;
Parameters
ParameterType
reportScheduleReportSchedule
Returns

ReportSchedule

unSuspendIPushPullSchedule

Activates a suspended ipushpull-based Schedule

TypeScript
unSuspendIPushPullSchedule(iPushPullSchedule: IPushPullSchedule): IPushPullSchedule;
Parameters
ParameterType
iPushPullScheduleIPushPullSchedule
Returns

IPushPullSchedule

unSuspendOpenFinSchedule

Activates a suspended OpenFin-based Schedule

TypeScript
unSuspendOpenFinSchedule(openFinSchedule: OpenFinSchedule): OpenFinSchedule;
Parameters
ParameterType
openFinScheduleOpenFinSchedule
Returns

OpenFinSchedule

unSuspendReminderSchedule

Activates a suspended Reminder-based Schedule

TypeScript
unSuspendReminderSchedule(reminderSchedule: ReminderSchedule): void;
Parameters
ParameterType
reminderScheduleReminderSchedule
Returns

void

unSuspendReportSchedule

Activates a suspended Report / Export Schedule

TypeScript
unSuspendReportSchedule(reportSchedule: ReportSchedule): ReportSchedule;
Parameters
ParameterType
reportScheduleReportSchedule
Returns

ReportSchedule

PreviousScheduleNextScheduleState