Class ScheduleService

An implementation of the FIN schedule service.

Index

Constructors

Methods

createCalendars createSchedules deleteCalendarById deleteScheduleById readAllCalendars readAllSchedules readCalendarById readCalendarSchedulesById readSchedulablePoints readScheduleById readScheduleCalendarsById readScheduleEvents updateCalendar updateSchedule updateSchedulePoints

Constructors

constructor

new ScheduleService(serviceConfig: ClientServiceConfig): ScheduleService
Constructs a new record service object.
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns ScheduleService
- Defined in src/client/schedules/ScheduleService.ts:41

Methods

createCalendars

createCalendars<Calendar extends HDict>(
calendars: Calendar | HGrid<Calendar>,
): Promise<HGrid<Calendar>>
Creates single or multiple calendars.
Type Parameters
- Calendar extends HDict
Parameters
- calendars: Calendar | HGrid<Calendar>
  The calendars to create.
Returns Promise<HGrid<Calendar>>
A grid containing the created calendar(s).
- Defined in src/client/schedules/ScheduleService.ts:237

createSchedules

createSchedules<Schedule extends HDict>(
schedules: Schedule | HGrid<Schedule>,
): Promise<HGrid<Schedule>>
Creates single or multiple schedules.
Type Parameters
- Schedule extends HDict
Parameters
- schedules: Schedule | HGrid<Schedule>
  The schedules to create.
Returns Promise<HGrid<Schedule>>
A grid of the created schedules.
- Defined in src/client/schedules/ScheduleService.ts:78

deleteCalendarById

deleteCalendarById<Calendar extends HDict>(id: string | HRef): Promise<Calendar>
Deletes a calendar by its id.
Type Parameters
- Calendar extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<Calendar>
The deleted calendar.
- Defined in src/client/schedules/ScheduleService.ts:295

deleteScheduleById

deleteScheduleById<Schedule extends HDict>(id: string | HRef): Promise<Schedule>
Deletes a schedule by its id.
Type Parameters
- Schedule extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<Schedule>
The deleted schedule.
- Defined in src/client/schedules/ScheduleService.ts:137

readAllCalendars

readAllCalendars<Calendar extends HDict>(
options?: ScheduleReadOptions,
): Promise<HGrid<Calendar>>
Query all calendars.
Type Parameters
- Calendar extends HDict
Parameters
- Optionaloptions: ScheduleReadOptions
  Optional options for reading calendars.
Returns Promise<HGrid<Calendar>>
A grid of calendars.
- Defined in src/client/schedules/ScheduleService.ts:217

readAllSchedules

readAllSchedules<Schedule extends HDict>(
options?: ScheduleReadOptions,
): Promise<HGrid<Schedule>>
Query all schedules.
Type Parameters
- Schedule extends HDict
Parameters
- Optionaloptions: ScheduleReadOptions
  Optional options for reading schedules.
Returns Promise<HGrid<Schedule>>
A grid of schedules.
- Defined in src/client/schedules/ScheduleService.ts:58

readCalendarById

readCalendarById<Calendar extends HDict>(id: string | HRef): Promise<Calendar>
Read a calendar by its id.
Type Parameters
- Calendar extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<Calendar>
The calendar record.
- Defined in src/client/schedules/ScheduleService.ts:257

readCalendarSchedulesById

readCalendarSchedulesById<Schedule extends HDict>(
id: string | HRef,
): Promise<HGrid<Schedule>>
Reads the schedules associated to a calendar.
Type Parameters
- Schedule extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<HGrid<Schedule>>
A grid of schedules.
- Defined in src/client/schedules/ScheduleService.ts:314

readSchedulablePoints

readSchedulablePoints<SchedulablePoint extends HDict>(
id: string | HRef,
options?: ScheduleReadOptions,
): Promise<HGrid<SchedulablePoint>>
Reads all the schedulable points associated to a schedule.
Type Parameters
- SchedulablePoint extends HDict
Parameters
- id: string | HRef
  The record id.
- Optionaloptions: ScheduleReadOptions
  Schedule read options.
Returns Promise<HGrid<SchedulablePoint>>
A grid of points.
- Defined in src/client/schedules/ScheduleService.ts:174

readScheduleById

readScheduleById<Schedule extends HDict>(id: string | HRef): Promise<Schedule>
Read a schedule by its id.
Type Parameters
- Schedule extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<Schedule>
A schedule.
- Defined in src/client/schedules/ScheduleService.ts:98

readScheduleCalendarsById

readScheduleCalendarsById<Calendar extends HDict>(
id: string | HRef,
): Promise<HGrid<Calendar>>
Reads the calendars associated to a schedule.
Type Parameters
- Calendar extends HDict
Parameters
- id: string | HRef
  The record id.
Returns Promise<HGrid<Calendar>>
A grid of calendars.
- Defined in src/client/schedules/ScheduleService.ts:156

readScheduleEvents

readScheduleEvents<ScheduleEventsResponse extends HDict>(
id: string | HRef,
options: ScheduleEventsReadOptions,
): Promise<ScheduleEventsResponse>
Reads the events associated with a schedule.

Returns the events within the start -> end range, or, if no end provided, will return the next scheduled event.
Type Parameters
- ScheduleEventsResponse extends HDict
Parameters
- id: string | HRef
  The record id.
- options: ScheduleEventsReadOptions
  The range to use for event lookup.
Returns Promise<ScheduleEventsResponse>
The events for the Schedule.
- Defined in src/client/schedules/ScheduleService.ts:335

updateCalendar

updateCalendar<Calendar extends HDict>(
id: string | HRef,
calendar: HDict,
): Promise<Calendar>
Updates a calendar.
Type Parameters
- Calendar extends HDict
Parameters
- id: string | HRef
- calendar: HDict
  The calendar record.
Returns Promise<Calendar>
The updated calendar record.
- Defined in src/client/schedules/ScheduleService.ts:274

updateSchedule

updateSchedule<Schedule extends HDict>(
id: string | HRef,
schedule: HDict,
): Promise<Schedule>
Updates a schedule.
Type Parameters
- Schedule extends HDict
Parameters
- id: string | HRef
  The record id.
- schedule: HDict
  The schedule.
Returns Promise<Schedule>
The updated schedule record.
- Defined in src/client/schedules/ScheduleService.ts:116

updateSchedulePoints

updateSchedulePoints<SchedulablePoint extends HDict>(
id: string | HRef,
pointUpdates: SchedulePointUpdate,
): Promise<HGrid<SchedulablePoint>>
Adds or Removes schedulable points to/from a schedule.
Type Parameters
- SchedulablePoint extends HDict
Parameters
- id: string | HRef
  The record id.
- pointUpdates: SchedulePointUpdate
  The schedule point updates.
Returns Promise<HGrid<SchedulablePoint>>
A grid with the schedule points added/removed.
- Defined in src/client/schedules/ScheduleService.ts:196

Class ScheduleService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ScheduleService

Methods

createCalendars

Type Parameters

Parameters

Returns Promise<HGrid<Calendar>>

createSchedules

Type Parameters

Parameters

Returns Promise<HGrid<Schedule>>

deleteCalendarById

Type Parameters

Parameters

Returns Promise<Calendar>

deleteScheduleById

Type Parameters

Parameters

Returns Promise<Schedule>

readAllCalendars

Type Parameters

Parameters

Returns Promise<HGrid<Calendar>>

readAllSchedules

Type Parameters

Parameters

Returns Promise<HGrid<Schedule>>

readCalendarById

Type Parameters

Parameters

Returns Promise<Calendar>

readCalendarSchedulesById

Type Parameters

Parameters

Returns Promise<HGrid<Schedule>>

readSchedulablePoints

Type Parameters

Parameters

Returns Promise<HGrid<SchedulablePoint>>

readScheduleById

Type Parameters

Parameters

Returns Promise<Schedule>

readScheduleCalendarsById

Type Parameters

Parameters

Returns Promise<HGrid<Calendar>>

readScheduleEvents

Type Parameters

Parameters

Returns Promise<ScheduleEventsResponse>

updateCalendar

Type Parameters

Parameters

Returns Promise<Calendar>

updateSchedule

Type Parameters

Parameters

Returns Promise<Schedule>

updateSchedulePoints

Type Parameters

Parameters

Returns Promise<HGrid<SchedulablePoint>>

Settings

On This Page