Calendar API
The calendar module of the @codebolt/plugin-sdk.
import plugin from '@codebolt/plugin-sdk';
Quick Reference
| Method | Description |
|---|---|
createEvent | Create a new calendar event |
deleteEvent | Delete a calendar event |
getEvent | Get a single calendar event by ID |
getEventsInRange | Get events within a specific date range |
getStatus | Get the calendar scheduler status |
getTriggeredEvents | Get triggered events (events whose start time has passed) |
getTriggeredEventsAndMarkComplete | Get triggered events and mark them all as complete in one operation |
getUpcomingEvents | Get upcoming events within a specified time window |
listEvents | List calendar events with optional filters |
markEventComplete | Mark a single event as complete |
markEventsComplete | Mark multiple events as complete |
rsvp | RSVP to a calendar event |
updateEvent | Update an existing calendar event |
Methods
createEvent
plugin.calendar.createEvent(params: ICreateEventParams): Promise<ICreateEventResponse>
Create a new calendar event
| Parameter | Type | Required | Description |
|---|---|---|---|
params | ICreateEventParams | Yes | Event creation parameters |
Returns: Promise<ICreateEventResponse> — Promise resolving to the created event
deleteEvent
plugin.calendar.deleteEvent(params: IDeleteEventParams): Promise<IDeleteEventResponse>
Delete a calendar event
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IDeleteEventParams | Yes | Parameters including eventId |
Returns: Promise<IDeleteEventResponse> — Promise resolving to deletion confirmation
getEvent
plugin.calendar.getEvent(params: IGetEventParams): Promise<IGetEventResponse>
Get a single calendar event by ID
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IGetEventParams | Yes | Parameters including eventId |
Returns: Promise<IGetEventResponse> — Promise resolving to the event
getEventsInRange
plugin.calendar.getEventsInRange(params: IGetEventsInRangeParams): Promise<IGetEventsInRangeResponse>
Get events within a specific date range
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IGetEventsInRangeParams | Yes | Parameters including startDate and endDate |
Returns: Promise<IGetEventsInRangeResponse> — Promise resolving to events in range
getStatus
plugin.calendar.getStatus(): Promise<IGetStatusResponse>
Get the calendar scheduler status
No parameters.
Returns: Promise<IGetStatusResponse> — Promise resolving to scheduler status information
getTriggeredEvents
plugin.calendar.getTriggeredEvents(params: IGetTriggeredEventsParams): Promise<IGetTriggeredEventsResponse>
Get triggered events (events whose start time has passed)
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IGetTriggeredEventsParams | Yes | Optional parameters including includeCompleted flag (default: {}) |
Returns: Promise<IGetTriggeredEventsResponse> — Promise resolving to triggered events
getTriggeredEventsAndMarkComplete
plugin.calendar.getTriggeredEventsAndMarkComplete(): Promise<IGetTriggeredEventsAndMarkCompleteResponse>
Get triggered events and mark them all as complete in one operation
No parameters.
Returns: Promise<IGetTriggeredEventsAndMarkCompleteResponse> — Promise resolving to the events that were retrieved and marked complete
getUpcomingEvents
plugin.calendar.getUpcomingEvents(params: IGetUpcomingEventsParams): Promise<IGetUpcomingEventsResponse>
Get upcoming events within a specified time window
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IGetUpcomingEventsParams | Yes | Optional parameters including withinMinutes (default: 60) (default: {}) |
Returns: Promise<IGetUpcomingEventsResponse> — Promise resolving to upcoming events
listEvents
plugin.calendar.listEvents(params: IListEventsParams): Promise<IListEventsResponse>
List calendar events with optional filters
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IListEventsParams | Yes | Optional filter parameters (default: {}) |
Returns: Promise<IListEventsResponse> — Promise resolving to list of events
markEventComplete
plugin.calendar.markEventComplete(params: IMarkEventCompleteParams): Promise<IMarkEventCompleteResponse>
Mark a single event as complete
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IMarkEventCompleteParams | Yes | Parameters including eventId |
Returns: Promise<IMarkEventCompleteResponse> — Promise resolving to the completed event
markEventsComplete
plugin.calendar.markEventsComplete(params: IMarkEventsCompleteParams): Promise<IMarkEventsCompleteResponse>
Mark multiple events as complete
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IMarkEventsCompleteParams | Yes | Parameters including array of eventIds |
Returns: Promise<IMarkEventsCompleteResponse> — Promise resolving to the completed events
rsvp
plugin.calendar.rsvp(params: IRSVPParams): Promise<IRSVPResponse>
RSVP to a calendar event
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IRSVPParams | Yes | Parameters including eventId, participantId, and status |
Returns: Promise<IRSVPResponse> — Promise resolving to the updated event
updateEvent
plugin.calendar.updateEvent(params: IUpdateEventParams): Promise<IUpdateEventResponse>
Update an existing calendar event
| Parameter | Type | Required | Description |
|---|---|---|---|
params | IUpdateEventParams | Yes | Event update parameters including eventId |
Returns: Promise<IUpdateEventResponse> — Promise resolving to the updated event