getScheduleTimeFrame( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a schedule time frame by schedule ID.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Method Declaration
Copy
function getScheduleTimeFrame(
  _id: string,
  options: GetScheduleTimeFrameOptions,
): Promise<ScheduleTimeFrame>;
Method Parameters
_idstringRequired

Schedule ID for which to retrieve the schedule time frame.

optionsGetScheduleTimeFrameOptions
Returns
Return Type:Promise<ScheduleTimeFrame>
JavaScript
import { scheduleTimeFrames } from "@wix/calendar";

async function getScheduleTimeFrame(id, options) {
  const response = await scheduleTimeFrames.getScheduleTimeFrame(id, options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?