Class Event

ICAL.js is organized into multiple layers. The bottom layer is a raw jCal object, followed by the component/property layer. The highest level is the event representation, which this class is part of. See the {@tutorial layers} guide for more details.

Alias

ICAL.Event

Hierarchy

Event

Constructors

constructor

new Event(component?, options?): Event
Creates a new ICAL.Event instance.
Parameters
- Optional component: Component
  
  The ICAL.Component to base this event on
- Optional options: {
  exceptions: (Component | Event)[];
  strictExceptions: boolean;
  }
  
  Options for this event
  - exceptions: (Component | Event)[]
    
    Exceptions to this event, either as components or events. If not specified exceptions will automatically be set in relation of component's parent
  - strictExceptions: boolean
    
    When true, will verify exceptions are related by their UUID
Returns Event
- Defined in event.ts:49

Properties

`Private` _rangeExceptionCache

_rangeExceptionCache: Record<string, Duration>

`Private` component

component: Component

exceptions

exceptions: Record<string, Event>

List of related event exceptions.

`Private` rangeExceptions

rangeExceptions: [number, string][]

strictExceptions

strictExceptions: boolean = false

When true, will verify exceptions are related by their UUID.

`Static` THISANDFUTURE

THISANDFUTURE: string = 'THISANDFUTURE'

Accessors

attendees

get attendees(): Property[]
The attendees in the event

Returns Property[]
- Defined in event.ts:431

color

get color(): string
The event color from rfc7986

Returns string
- Defined in event.ts:462
set color(value): void
Parameters
- value: string
Returns void
- Defined in event.ts:466

description

get description(): string
The event description.

Returns string
- Defined in event.ts:451
set description(value): void
Parameters
- value: string
Returns void
- Defined in event.ts:455

duration

get duration(): Duration
The duration. This can be the result directly from the property, or the duration calculated from start date and end date. Setting the property will remove any dtend properties.

Returns Duration
- Defined in event.ts:401
set duration(value): void
Parameters
- value: Duration
Returns void
- Defined in event.ts:409

endDate

get endDate(): Time
The end date. This can be the result directly from the property, or the end date calculated from start date and duration. Setting the property will remove any duration properties.

Returns Time
- Defined in event.ts:374
set endDate(value): void
Parameters
- value: Time
Returns void
- Defined in event.ts:388

location

get location(): string
The location of the event.

Returns string
- Defined in event.ts:420
set location(value): void
Parameters
- value: string
Returns void
- Defined in event.ts:424

organizer

get organizer(): string
The organizer value as an uri. In most cases this is a mailto: uri, but it can also be something else, like urn:uuid:...

Returns string
- Defined in event.ts:474
set organizer(value): void
Parameters
- value: string
Returns void
- Defined in event.ts:478

recurrenceId

get recurrenceId(): Time
The recurrence id for this event. See {@tutorial terminology} for details.

Returns Time
- Defined in event.ts:497
set recurrenceId(value): void
Parameters
- value: Time
Returns void
- Defined in event.ts:501

sequence

get sequence(): number
The sequence value for this event. Used for scheduling see {@tutorial terminology}.

Returns number
- Defined in event.ts:486
set sequence(value): void
Parameters
- value: number
Returns void
- Defined in event.ts:490

startDate

get startDate(): Time
The start date

Returns Time
- Defined in event.ts:361
set startDate(value): void
Parameters
- value: Time
Returns void
- Defined in event.ts:365

summary

get summary(): string
The event summary

Returns string
- Defined in event.ts:440
set summary(value): void
Parameters
- value: string
Returns void
- Defined in event.ts:444

uid

get uid(): null | string
The uid of this event

Returns null | string
- Defined in event.ts:350
set uid(value): void
Parameters
- value: null | string
Returns void
- Defined in event.ts:354

Methods

_firstProp

_firstProp(name): any
Parameters
- name: string
Returns any
- Defined in event.ts:546

_setProp

_setProp(name, value): void
Parameters
- name: string
- value: string | number | object
Returns void
- Defined in event.ts:542

`Private` _setTime

_setTime(propName, time): void
Private
Set/update a time property's value. This will also update the TZID of the property.

TODO: this method handles the case where we are switching from a known timezone to an implied timezone (one without TZID). This does not handle the case of moving between a known (by TimezoneService) timezone to an unknown timezone...

We will not add/remove/update the VTIMEZONE subcomponents leading to invalid ICAL data...
Parameters
- propName: string
  
  The property name
- time: Time
  
  The time to set
Returns void
- Defined in event.ts:520

findRangeException

findRangeException(time): null | string
Finds the range exception nearest to the given date.
Parameters
- time: Time
  
  usually an occurrence time of an event
Returns null | string
the related event/exception or null
- Defined in event.ts:175

getOccurrenceDetails

getOccurrenceDetails(occurrence): OccurrenceDetails
Returns the occurrence details based on its start time. If the occurrence has an exception will return the details for that exception.

NOTE: this method is intend to be used in conjunction with the iterator method.
Parameters
- occurrence: Time
  
  time occurrence
Returns OccurrenceDetails
Information about the occurrence
- Defined in event.ts:215

getRecurrenceTypes

getRecurrenceTypes(): Record<"SECONDLY" | "MINUTELY" | "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY", boolean>
Returns the types of recurrences this event may have.

Returned as an object with the following possible keys:
- YEARLY
- MONTHLY
- WEEKLY
- DAILY
- MINUTELY
- SECONDLY
Returns Record<"SECONDLY" | "MINUTELY" | "HOURLY" | "DAILY" | "WEEKLY" | "MONTHLY" | "YEARLY", boolean>
Object of recurrence flags
- Defined in event.ts:333

isRecurrenceException

isRecurrenceException(): boolean
Checks if the event describes a recurrence exception. See {@tutorial terminology} for details.

Returns boolean
True, if the event describes a recurrence exception
- Defined in event.ts:315

isRecurring

isRecurring(): boolean
Checks if the event is recurring

Returns boolean
True, if event is recurring
- Defined in event.ts:304

iterator

iterator(startTime): RecurExpansion
Builds a recur expansion instance for a specific point in time (defaults to startDate).
Parameters
- startTime: Time
  
  Starting point for expansion
Returns RecurExpansion
Expansion object
- Defined in event.ts:292

modifiesFuture

modifiesFuture(): boolean
Checks if this record is an exception and has the RANGE=THISANDFUTURE value.

Returns boolean
True, when exception is within range
- Defined in event.ts:158

relateException

relateException(obj): void
Relates a given event exception to this object. If the given component does not share the UID of this event it cannot be related and will throw an exception.

If this component is an exception it cannot have other exceptions related to it.
Parameters
- obj: Component | Event
  
  Component or event
Returns void
- Defined in event.ts:116

toString

toString(): string
The string representation of this event.

Returns string
- Defined in event.ts:553

Class Event

Alias

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional component: Component

Optional options: { exceptions: (Component | Event)[]; strictExceptions: boolean; }

exceptions: (Component | Event)[]

strictExceptions: boolean

Returns Event

Properties

Private _rangeExceptionCache

Private component

exceptions

Private rangeExceptions

strictExceptions

Static THISANDFUTURE

Accessors

attendees

Returns Property[]

color

Returns string

Parameters

value: string

Returns void

description

Returns string

Parameters

value: string

Returns void

duration

Returns Duration

Parameters

value: Duration

Returns void

endDate

Returns Time

Parameters

value: Time

Returns void

location

Returns string

Parameters

value: string

Returns void

organizer

Returns string

Parameters

value: string

Returns void

recurrenceId

Returns Time

Parameters

value: Time

Returns void

sequence

Returns number

Parameters

value: number

Returns void

startDate

Returns Time

Parameters

value: Time

Returns void

summary

Returns string

Parameters

value: string

Returns void

uid

Returns null | string

Parameters

value: null | string

`Optional` component: Component

`Optional` options: {
exceptions: (Component | Event)[];
strictExceptions: boolean;
}

`Private` _rangeExceptionCache

`Private` component

`Private` rangeExceptions

`Static` THISANDFUTURE

`Private` _setTime