Search.../
  1. APIs

getScheduleItem( )

Retrieves schedule item by ID.

Syntax

function getScheduleItem(itemId: string, options: GetScheduleItemOptions): Promise<ScheduleItem>

getScheduleItem Parameters

NAME
TYPE
DESCRIPTION
itemId
string

Schedule item ID.

options
Optional
GetScheduleItemOptions

Optional fields.

Returns

Schedule item.

Return Type:

Promise<
ScheduleItem
>
NAME
TYPE
DESCRIPTION
_createdDate
Date

Date and time when the schedule item was created.

_id
string

Schedule item ID.

_updatedDate
Date

Date and time when the schedule item was updated.

description
string

Rich text schedule item description.

draft
boolean

Whether the schedule item is draft.

eventId
string

Event ID to which the schedule belongs.

hidden
boolean

Whether a schedule item is hidden from guests.

name
string

Schedule item name.

stageName
string

Stage or room name in which the session takes place.

status
string

Schedule item status. Possible values:

  • SCHEDULED: An item is scheduled.
  • CANCELED: An item is canceled.
tags
Array<
string
>

Schedule item tags. They're used to organize the items to a theme.

timeSlot
TimeInterval

Time slot of a schedule item.

Was this helpful?

getScheduleItem example

Copy Code
1import { schedule } from 'wix-events.v2';
2  
3 async function getScheduleItem(itemId, options) {
4   try {
5     const result = await schedule.getScheduleItem(itemId, options);
6

7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13