API Reference
Event
API reference for the Event class.
import { Event } from '@forcecalendar/core';
new Event(data: EventData)
See Event Model for the full list of constructor properties.
| Method | Signature | Returns |
|---|
normalize | (data: object) => EventData | Normalized event data |
validate | (data: EventData) => void | Throws on invalid normalized data |
fromObject | (obj: object) => Event | Event instance |
| Getter | Type | Description |
|---|
duration | number | Duration in milliseconds |
durationMinutes | number | Duration in minutes |
durationHours | number | Duration in hours (decimal) |
isMultiDay | boolean | Spans midnight |
isCancelled | boolean | Status is cancelled |
isTentative | boolean | Status is tentative |
isConfirmed | boolean | Status is confirmed |
isPrivate | boolean | Visibility is private |
isPublic | boolean | Visibility is public |
hasAttendees | boolean | Has attendees |
hasReminders | boolean | Has reminders |
isMeeting | boolean | Has attendees |
isVirtual | boolean | Has conference data |
category | string | null | Primary category |
| Method | Signature | Returns |
|---|
isRecurring | () => boolean | Has recurrence rule |
occursOn | (date: Date) => boolean | Occurs on date |
overlaps | (other: Event) => boolean | Time overlap |
contains | (datetime: Date) => boolean | Contains datetime |
clone | (updates?: object) => Event | Cloned event |
toObject | () => object | Plain object |
equals | (other: Event) => boolean | Deep equality |
| Method | Signature | Returns |
|---|
getStartInTimezone | (tz: string) => Date | Start in timezone |
getEndInTimezone | (tz: string) => Date | End in timezone |
updateTimes | (start: Date, end: Date, tz?: string) => void | — |
| Method | Signature | Returns |
|---|
addAttendee | (attendee: object) => void | — |
removeAttendee | (email: string) => void | — |
updateAttendeeResponse | (email: string, status: string) => void | — |
getAttendee | (email: string) => object | undefined | Attendee |
hasAttendee | (email: string) => boolean | — |
getAttendeesByStatus | (status: string) => object[] | Attendees |
getAttendeeCounts | () => object | { total, accepted, declined, ... } |
| Method | Signature | Returns |
|---|
addReminder | (reminder: object) => void | — |
removeReminder | (reminderId: string) => void | Removes the reminder whose id matches |
getActiveReminders | () => object[] | Active reminders |
getReminderTriggerTimes | () => Date[] | Trigger dates |
| Method | Signature | Returns |
|---|
addCategory | (category: string) => void | — |
removeCategory | (category: string) => void | — |
hasCategory | (category: string) => boolean | — |
hasAnyCategory | (categories: string[]) => boolean | — |
hasAllCategories | (categories: string[]) => boolean | — |
| Static method | Purpose |
|---|
isEquivalent(a, b) | Compare supported event fields for reconciliation |
occurrenceId(masterId, start) | Generate stable occurrence identity |
parseOccurrenceId(id) | Parse occurrence identity |
Core 2.5.6 preserves endTimeZone through clone()/toObject(). See full-field snapshots.