Skip to main content

calendar

@codebolt/codeboltjs

Variable: calendar

const calendar: {
  createEvent: (params: ICreateEventParams) => Promise<ICreateEventResponse>;
  deleteEvent: (params: IDeleteEventParams) => Promise<IDeleteEventResponse>;
  getEvent: (params: IGetEventParams) => Promise<IGetEventResponse>;
  getEventsInRange: (params: IGetEventsInRangeParams) => Promise<IGetEventsInRangeResponse>;
  getStatus: () => Promise<IGetStatusResponse>;
  getTriggeredEvents: (params: IGetTriggeredEventsParams) => Promise<IGetTriggeredEventsResponse>;
  getTriggeredEventsAndMarkComplete: () => Promise<IGetTriggeredEventsAndMarkCompleteResponse>;
  getUpcomingEvents: (params: IGetUpcomingEventsParams) => Promise<IGetUpcomingEventsResponse>;
  listEvents: (params: IListEventsParams) => Promise<IListEventsResponse>;
  markEventComplete: (params: IMarkEventCompleteParams) => Promise<IMarkEventCompleteResponse>;
  markEventsComplete: (params: IMarkEventsCompleteParams) => Promise<IMarkEventsCompleteResponse>;
  rsvp: (params: IRSVPParams) => Promise<IRSVPResponse>;
  updateEvent: (params: IUpdateEventParams) => Promise<IUpdateEventResponse>;
};

Defined in: packages/codeboltjs/src/modules/calendar.ts:267

Type Declaration​

NameTypeDescriptionDefined in
createEvent()(params: ICreateEventParams) => Promise<ICreateEventResponse>Create a new calendar eventpackages/codeboltjs/src/modules/calendar.ts:273
deleteEvent()(params: IDeleteEventParams) => Promise<IDeleteEventResponse>Delete a calendar eventpackages/codeboltjs/src/modules/calendar.ts:303
getEvent()(params: IGetEventParams) => Promise<IGetEventResponse>Get a single calendar event by IDpackages/codeboltjs/src/modules/calendar.ts:318
getEventsInRange()(params: IGetEventsInRangeParams) => Promise<IGetEventsInRangeResponse>Get events within a specific date rangepackages/codeboltjs/src/modules/calendar.ts:348
getStatus()() => Promise<IGetStatusResponse>Get the calendar scheduler statuspackages/codeboltjs/src/modules/calendar.ts:450
getTriggeredEvents()(params: IGetTriggeredEventsParams) => Promise<IGetTriggeredEventsResponse>Get triggered events (events whose start time has passed)packages/codeboltjs/src/modules/calendar.ts:378
getTriggeredEventsAndMarkComplete()() => Promise<IGetTriggeredEventsAndMarkCompleteResponse>Get triggered events and mark them all as complete in one operationpackages/codeboltjs/src/modules/calendar.ts:422
getUpcomingEvents()(params: IGetUpcomingEventsParams) => Promise<IGetUpcomingEventsResponse>Get upcoming events within a specified time windowpackages/codeboltjs/src/modules/calendar.ts:363
listEvents()(params: IListEventsParams) => Promise<IListEventsResponse>List calendar events with optional filterspackages/codeboltjs/src/modules/calendar.ts:333
markEventComplete()(params: IMarkEventCompleteParams) => Promise<IMarkEventCompleteResponse>Mark a single event as completepackages/codeboltjs/src/modules/calendar.ts:393
markEventsComplete()(params: IMarkEventsCompleteParams) => Promise<IMarkEventsCompleteResponse>Mark multiple events as completepackages/codeboltjs/src/modules/calendar.ts:408
rsvp()(params: IRSVPParams) => Promise<IRSVPResponse>RSVP to a calendar eventpackages/codeboltjs/src/modules/calendar.ts:436
updateEvent()(params: IUpdateEventParams) => Promise<IUpdateEventResponse>Update an existing calendar eventpackages/codeboltjs/src/modules/calendar.ts:288