About the Schedule Time Frames API

The Schedule Time Frames API allows you to keep track of when schedules start and end.

With the Schedule Time Frames API, you can:

• Retrieve schedule time frames.
• Track in real-time when a schedule time frame is updated.

For example, Wix Bookings uses the Schedule Time Frames API to determine when courses start and end.

For more in-depth scheduling management, see:

• Schedules API
• Events API

Before you begin

It’s important to note the following points before starting to code:

• You can't update a schedule time frame. You can retrieve it and get notified in real-time when it's modified.

Terminology

• Schedule time frame: Defines the first and last event dates within a schedule and indicates whether any events recur indefinitely.
• Recurring event: Event that repeats based on a pattern defined by a recurrence rule. For example, weekly yoga classes or regular staff working hours. Recurring events can either end on a specified date or continue indefinitely. Learn more about recurring events.

Setup

To use the ScheduleTimeFrames API, install the @wix/calendar package using npm or Yarn:

npm install @wix/calendar

or

yarn add @wix/calendar

Then import { scheduleTimeFrames } from @wix/calendar:

import { scheduleTimeFrames } from "@wix/calendar";