Introduction

With the Schedule Bookmarks API you can allow members to mark their favorite schedule items to curate their own personalized agenda for your event.

With the Schedule Bookmarks API you can:

  • Create and delete bookmarks.
  • List all bookmarks per member.

Terminology

  • Schedule: A structured plan or timetable that outlines the sequence of activities, presentations, performances, or sessions scheduled to occur during an event.
  • Event: A gathering organized by an individual or business for a group of people.
Was this helpful?
Yes
No

Setup

To use the ScheduleBookmarks API, install the @wix/events package using npm or Yarn:

Copy
1
npm install @wix/events

or

Copy
1
yarn add @wix/events

Then import { scheduleBookmarks } from @wix/events:

Copy
1
import { scheduleBookmarks } from '@wix/events'
Was this helpful?
Yes
No
createBookmark( )

Bookmarks a schedule item for a currently logged-in member.

Copy
function createBookmark(itemId: string, eventId: string): Promise<void>
Method Parameters
itemIdstringRequired
Schedule item ID.
eventIdstringRequired
Event ID to which the schedule belongs.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
deleteBookmark( )

Removes a schedule item bookmark for a currently logged-in member.

Copy
function deleteBookmark(itemId: string, eventId: string): Promise<void>
Method Parameters
itemIdstringRequired
Schedule item ID.
eventIdstringRequired
Event ID to which the schedule belongs.
Returns
Return Type:Promise<void>
Was this helpful?
Yes
No
listBookmarks( )

Retrieves a list of bookmarked schedule items for a currently logged-in member.

Copy
function listBookmarks(eventId: string): Promise<ListBookmarksResponse>
Method Parameters
eventIdstringRequired
Event ID to which the schedule belongs.
Returns
Return Type:Promise<ListBookmarksResponse>
Was this helpful?
Yes
No