From 8c74dc064d1223b5bb3c47f82f42e37e3670e733 Mon Sep 17 00:00:00 2001 From: leftmostcat Date: Thu, 18 Apr 2024 17:11:04 +0000 Subject: [PATCH] deploy: b80403009e0de9c1249955c942ac83412238ac98 --- api/ICAL.Binary.html | 2 +- api/ICAL.Component.html | 2 +- api/ICAL.ComponentParser.html | 4 +-- api/ICAL.Duration.html | 2 +- api/ICAL.Event.html | 2 +- api/ICAL.Period.html | 2 +- api/ICAL.Property.html | 2 +- api/ICAL.Recur.html | 4 +-- api/ICAL.RecurExpansion.html | 4 +-- api/ICAL.RecurIterator.html | 2 +- api/ICAL.Time.html | 4 +-- api/ICAL.Timezone.html | 4 +-- api/ICAL.UtcOffset.html | 2 +- api/ICAL.VCardTime.html | 4 +-- api/ICAL.html | 2 +- api/ICAL.module_TimezoneService.html | 2 +- api/ICAL.module_design.html | 4 +-- api/ICAL.module_helpers.html | 4 +-- api/ICAL.parse.ParserError.html | 2 +- api/InvalidRecurrenceRuleError.html | 3 ++ api/binary.js.html | 4 +-- api/component.js.html | 4 +-- api/component_parser.js.html | 4 +-- api/data/search.json | 2 +- api/design.js.html | 4 +-- api/duration.js.html | 4 +-- api/event.js.html | 4 +-- api/helpers.js.html | 4 +-- api/index.html | 4 +-- api/module.js.html | 4 +-- api/parse.js.html | 4 +-- api/period.js.html | 4 +-- api/property.js.html | 4 +-- api/recur.js.html | 4 +-- api/recur_expansion.js.html | 4 +-- api/recur_iterator.js.html | 54 +++++++++++++++++++++++----- api/stringify.js.html | 4 +-- api/time.js.html | 4 +-- api/timezone.js.html | 4 +-- api/timezone_service.js.html | 4 +-- api/utc_offset.js.html | 4 +-- api/vcard_time.js.html | 4 +-- 42 files changed, 117 insertions(+), 76 deletions(-) create mode 100644 api/InvalidRecurrenceRuleError.html diff --git a/api/ICAL.Binary.html b/api/ICAL.Binary.html index 2fee260d..d6a2b0b9 100644 --- a/api/ICAL.Binary.html +++ b/api/ICAL.Binary.html @@ -1,3 +1,3 @@ Class: Binary
On this page

ICAL. Binary

Represents the BINARY value type, which contains extra methods for encoding and decoding.

Constructor

new Binary(aValue)

Creates a new ICAL.Binary instance

Parameters:
NameTypeDescription
aValueString

The binary data for this value

Source

Members

(constant) icaltype

The type name, to be used in the jCal object.

Default Value
  • "binary"
Source

Methods

decodeValue() → {String}

Base64 decode the current value

Source
Returns:

The base64-decoded value

Type: 
String

setEncodedValue(aValue)

Encodes the passed parameter with base64 and sets the internal value to the result.

Parameters:
NameTypeDescription
aValueString

The raw binary value to encode

Source

toString() → {String}

The string representation of this value

Source
Returns:
Type: 
String

(static) fromString(aString) → {ICAL.Binary}

Creates a binary value from the given string.

Parameters:
NameTypeDescription
aStringString

The binary value string

Source
Returns:

The binary value instance

Type: 
ICAL.Binary
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. Binary

Represents the BINARY value type, which contains extra methods for encoding and decoding.

Constructor

new Binary(aValue)

Creates a new ICAL.Binary instance

Parameters:
NameTypeDescription
aValueString

The binary data for this value

Source

Members

(constant) icaltype

The type name, to be used in the jCal object.

Default Value
  • "binary"
Source

Methods

decodeValue() → {String}

Base64 decode the current value

Source
Returns:

The base64-decoded value

Type: 
String

setEncodedValue(aValue)

Encodes the passed parameter with base64 and sets the internal value to the result.

Parameters:
NameTypeDescription
aValueString

The raw binary value to encode

Source

toString() → {String}

The string representation of this value

Source
Returns:
Type: 
String

(static) fromString(aString) → {ICAL.Binary}

Creates a binary value from the given string.

Parameters:
NameTypeDescription
aStringString

The binary value string

Source
Returns:

The binary value instance

Type: 
ICAL.Binary
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Component.html b/api/ICAL.Component.html index 8855ffd3..9b8cfd50 100644 --- a/api/ICAL.Component.html +++ b/api/ICAL.Component.html @@ -1,3 +1,3 @@ Class: Component
On this page

ICAL. Component

Wraps a jCal component, adding convenience methods to add, remove and update subcomponents and properties.

Constructor

new Component(jCal, parent)

Creates a new ICAL.Component instance.

Parameters:
NameTypeDescription
jCalArray | String

Raw jCal component data OR name of new component

parentICAL.Component

Parent component to associate

Source

Members

(readonly) name

The name of this component

Source

Methods

addProperty(property) → {ICAL.Property}

Adds an ICAL.Property to the component.

Parameters:
NameTypeDescription
propertyICAL.Property

The property to add

Source
Returns:

The passed in property

Type: 
ICAL.Property

addPropertyWithValue(name, value) → {ICAL.Property}

Helper method to add a property with a value to the component.

Parameters:
NameTypeDescription
nameString

Property name to add

valueString | Number | Object

Property value

Source
Returns:

The created property

Type: 
ICAL.Property

addSubcomponent(component) → {ICAL.Component}

Adds a single sub component.

Parameters:
NameTypeDescription
componentICAL.Component

The component to add

Source
Returns:

The passed in component

Type: 
ICAL.Component

getAllProperties(nameopt) → {Array.<ICAL.Property>}

Get all properties in the component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

List of properties

Type: 
Array.<ICAL.Property>

getAllSubcomponents(nameopt) → {Array.<ICAL.Component>}

Finds all sub components, optionally filtering by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Optional name to filter by

Source
Returns:

The found sub components

Type: 
Array.<ICAL.Component>

getFirstProperty(nameopt) → (nullable) {ICAL.Property}

Finds the first property, optionally with the given name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

The found property

Type: 
ICAL.Property

getFirstPropertyValue(nameopt) → (nullable) {String}

Returns first property's value, if available.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

The found property value.

Type: 
String

getFirstSubcomponent(nameopt) → (nullable) {ICAL.Component}

Finds first sub component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Optional name to filter by

Source
Returns:

The found subcomponent

Type: 
ICAL.Component

getTimeZoneByID(tzid) → {ICAL.Timezone}

Retrieve a time zone definition from the component tree, if any is present. If the tree contains no time zone definitions or the TZID cannot be matched, returns null.

Parameters:
NameTypeDescription
tzidString

The ID of the time zone to retrieve

Source
Returns:

The time zone corresponding to the ID, or null

Type: 
ICAL.Timezone

hasProperty(name) → {Boolean}

Returns true when a named property exists.

Parameters:
NameTypeDescription
nameString

The property name

Source
Returns:

True, when property is found

Type: 
Boolean

removeAllProperties(nameopt) → {Boolean}

Removes all properties associated with this component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

True, when deleted

Type: 
Boolean

removeAllSubcomponents(nameopt)

Removes all components or (if given) all components by a particular name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase component name

Source

removeProperty(nameOrProp) → {Boolean}

Removes a single property by name or the instance of the specific property.

Parameters:
NameTypeDescription
nameOrPropString | ICAL.Property

Property name or instance to remove

Source
Returns:

True, when deleted

Type: 
Boolean

removeSubcomponent(nameOrComp) → {Boolean}

Removes a single component by name or the instance of a specific component.

Parameters:
NameTypeDescription
nameOrCompICAL.Component | String

Name of component, or component

Source
Returns:

True when comp is removed

Type: 
Boolean

toJSON() → {Object}

Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Source
Returns:
Type: 
Object

toString() → {String}

The string representation of this component.

Source
Returns:
Type: 
String

updatePropertyWithValue(name, value) → {ICAL.Property}

Helper method that will update or create a property of the given name and sets its value. If multiple properties with the given name exist, only the first is updated.

Parameters:
NameTypeDescription
nameString

Property name to update

valueString | Number | Object

Property value

Source
Returns:

The created property

Type: 
ICAL.Property

(static) fromString(str)

Create an ICAL.Component by parsing the passed iCalendar string.

Parameters:
NameTypeDescription
strString

The iCalendar string to parse

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. Component

Wraps a jCal component, adding convenience methods to add, remove and update subcomponents and properties.

Constructor

new Component(jCal, parent)

Creates a new ICAL.Component instance.

Parameters:
NameTypeDescription
jCalArray | String

Raw jCal component data OR name of new component

parentICAL.Component

Parent component to associate

Source

Members

(readonly) name

The name of this component

Source

Methods

addProperty(property) → {ICAL.Property}

Adds an ICAL.Property to the component.

Parameters:
NameTypeDescription
propertyICAL.Property

The property to add

Source
Returns:

The passed in property

Type: 
ICAL.Property

addPropertyWithValue(name, value) → {ICAL.Property}

Helper method to add a property with a value to the component.

Parameters:
NameTypeDescription
nameString

Property name to add

valueString | Number | Object

Property value

Source
Returns:

The created property

Type: 
ICAL.Property

addSubcomponent(component) → {ICAL.Component}

Adds a single sub component.

Parameters:
NameTypeDescription
componentICAL.Component

The component to add

Source
Returns:

The passed in component

Type: 
ICAL.Component

getAllProperties(nameopt) → {Array.<ICAL.Property>}

Get all properties in the component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

List of properties

Type: 
Array.<ICAL.Property>

getAllSubcomponents(nameopt) → {Array.<ICAL.Component>}

Finds all sub components, optionally filtering by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Optional name to filter by

Source
Returns:

The found sub components

Type: 
Array.<ICAL.Component>

getFirstProperty(nameopt) → (nullable) {ICAL.Property}

Finds the first property, optionally with the given name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

The found property

Type: 
ICAL.Property

getFirstPropertyValue(nameopt) → (nullable) {String}

Returns first property's value, if available.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

The found property value.

Type: 
String

getFirstSubcomponent(nameopt) → (nullable) {ICAL.Component}

Finds first sub component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Optional name to filter by

Source
Returns:

The found subcomponent

Type: 
ICAL.Component

getTimeZoneByID(tzid) → {ICAL.Timezone}

Retrieve a time zone definition from the component tree, if any is present. If the tree contains no time zone definitions or the TZID cannot be matched, returns null.

Parameters:
NameTypeDescription
tzidString

The ID of the time zone to retrieve

Source
Returns:

The time zone corresponding to the ID, or null

Type: 
ICAL.Timezone

hasProperty(name) → {Boolean}

Returns true when a named property exists.

Parameters:
NameTypeDescription
nameString

The property name

Source
Returns:

True, when property is found

Type: 
Boolean

removeAllProperties(nameopt) → {Boolean}

Removes all properties associated with this component, optionally filtered by name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase property name

Source
Returns:

True, when deleted

Type: 
Boolean

removeAllSubcomponents(nameopt)

Removes all components or (if given) all components by a particular name.

Parameters:
NameTypeAttributesDescription
nameString<optional>

Lowercase component name

Source

removeProperty(nameOrProp) → {Boolean}

Removes a single property by name or the instance of the specific property.

Parameters:
NameTypeDescription
nameOrPropString | ICAL.Property

Property name or instance to remove

Source
Returns:

True, when deleted

Type: 
Boolean

removeSubcomponent(nameOrComp) → {Boolean}

Removes a single component by name or the instance of a specific component.

Parameters:
NameTypeDescription
nameOrCompICAL.Component | String

Name of component, or component

Source
Returns:

True when comp is removed

Type: 
Boolean

toJSON() → {Object}

Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Source
Returns:
Type: 
Object

toString() → {String}

The string representation of this component.

Source
Returns:
Type: 
String

updatePropertyWithValue(name, value) → {ICAL.Property}

Helper method that will update or create a property of the given name and sets its value. If multiple properties with the given name exist, only the first is updated.

Parameters:
NameTypeDescription
nameString

Property name to update

valueString | Number | Object

Property value

Source
Returns:

The created property

Type: 
ICAL.Property

(static) fromString(str)

Create an ICAL.Component by parsing the passed iCalendar string.

Parameters:
NameTypeDescription
strString

The iCalendar string to parse

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.ComponentParser.html b/api/ICAL.ComponentParser.html index f9c58bd5..de8eceb2 100644 --- a/api/ICAL.ComponentParser.html +++ b/api/ICAL.ComponentParser.html @@ -1,6 +1,6 @@ Class: ComponentParser
On this page

ICAL. ComponentParser

The ComponentParser is used to process a String or jCal Object, firing callbacks for various found components, as well as completion.

Constructor

new ComponentParser(optionsopt)

Creates a new ICAL.ComponentParser instance.

Parameters:
NameTypeAttributesDescription
optionsObject<optional>

Component parser options

Properties
NameTypeDescription
parseEventBoolean

Whether events should be parsed

parseTimezeoneBoolean

Whether timezones should be parsed

Source
Example
var options = {
+    
On this page
ICAL. ComponentParser
The ComponentParser is used to process a String or jCal Object, firing callbacks for various found components, as well as completion.
Constructor
new ComponentParser(optionsopt)
Creates a new ICAL.ComponentParser instance.
Parameters:
NameTypeAttributesDescription
optionsObject<optional>
Component parser options
Properties
NameTypeDescription
parseEventBoolean
Whether events should be parsed
parseTimezeoneBoolean
Whether timezones should be parsed
Source
Example
var options = {
   // when false no events will be emitted for type
   parseEvent: true,
   parseTimezone: true
@@ -18,4 +18,4 @@
 
 };
 
-parser.process(stringOrComponent);
Members
parseEvent :Boolean
When true, parse events
Type:
  • Boolean
Source
parseTimezone :Boolean
When true, parse timezones
Type:
  • Boolean
Source
Methods
process(ical)
Process a string or parse ical object. This function itself will return nothing but will start the parsing process.
Events must be registered prior to calling this method.
Parameters:
NameTypeDescription
icalICAL.Component | String | Object
The component to process, either in its final form, as a jCal Object, or string representation
Source
Type Definitions
oncomplete
Fired when parsing is complete
Source
onerror
Fired if an error occurs during parsing.
Source
onevent
Fired when a top level component (VEVENT) is found.
Source
ontimezone
Fired when a top level component (VTIMEZONE) is found
Source

\ No newline at end of file
+parser.process(stringOrComponent);

Members

parseEvent :Boolean

When true, parse events

Type:
  • Boolean
Source

parseTimezone :Boolean

When true, parse timezones

Type:
  • Boolean
Source

Methods

process(ical)

Process a string or parse ical object. This function itself will return nothing but will start the parsing process.

Events must be registered prior to calling this method.

Parameters:
NameTypeDescription
icalICAL.Component | String | Object

The component to process, either in its final form, as a jCal Object, or string representation

Source

Type Definitions

oncomplete

Fired when parsing is complete

Source

onerror

Fired if an error occurs during parsing.

Source

onevent

Fired when a top level component (VEVENT) is found.

Source

ontimezone

Fired when a top level component (VTIMEZONE) is found

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Duration.html b/api/ICAL.Duration.html index e13dbe48..eb67d51d 100644 --- a/api/ICAL.Duration.html +++ b/api/ICAL.Duration.html @@ -1,3 +1,3 @@ Class: Duration
On this page

ICAL. Duration

This class represents the "duration" value type, with various calculation and manipulation methods.

Constructor

new Duration(data)

Creates a new ICAL.Duration instance.

Parameters:
NameTypeDescription
dataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source

Members

days :Number

The days in this duration

Type:
  • Number
Default Value
  • 0
Source

hours :Number

The days in this duration

Type:
  • Number
Default Value
  • 0
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icalduration"
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "duration"
Source

isNegative :Boolean

The seconds in this duration

Type:
  • Boolean
Default Value
  • false
Source

minutes :Number

The minutes in this duration

Type:
  • Number
Default Value
  • 0
Source

seconds :Number

The seconds in this duration

Type:
  • Number
Default Value
  • 0
Source

weeks :Number

The weeks in this duration

Type:
  • Number
Default Value
  • 0
Source

Methods

clone() → {ICAL.Duration}

Returns a clone of the duration object.

Source
Returns:

The cloned object

Type: 
ICAL.Duration

compare(aOther) → {Number}

Compares the duration instance with another one.

Parameters:
NameTypeDescription
aOtherICAL.Duration

The instance to compare with

Source
Returns:

-1, 0 or 1 for less/equal/greater

Type: 
Number

fromData(aData)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source

fromSeconds(aSeconds) → {ICAL.Duration}

Reads the passed seconds value into this duration object. Afterwards, members like days and weeks will be set up accordingly.

Parameters:
NameTypeDescription
aSecondsNumber

The duration value in seconds

Source
Returns:

Returns this instance

Type: 
ICAL.Duration

normalize()

Normalizes the duration instance. For example, a duration with a value of 61 seconds will be normalized to 1 minute and 1 second.

Source

reset()

Resets the duration instance to the default values, i.e. PT0S

Source

toICALString() → {String}

The iCalendar string representation of this duration.

Source
Returns:
Type: 
String

toSeconds() → {Number}

The duration value expressed as a number of seconds.

Source
Returns:

The duration value in seconds

Type: 
Number

toString() → {String}

The string representation of this duration.

Source
Returns:
Type: 
String

(static) fromData(aData) → {ICAL.Duration}

Creates a new ICAL.Duration instance from the given data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source
Returns:

The createad duration instance

Type: 
ICAL.Duration

(static) fromSeconds(aSeconds) → {ICAL.Duration}

Returns a new ICAL.Duration instance from the passed seconds value.

Parameters:
NameTypeDescription
aSecondsNumber

The seconds to create the instance from

Source
Returns:

The newly created duration instance

Type: 
ICAL.Duration

(static) fromString(aStr) → {ICAL.Duration}

Creates a new ICAL.Duration instance from the passed string.

Parameters:
NameTypeDescription
aStrString

The string to parse

Source
Returns:

The created duration instance

Type: 
ICAL.Duration

(static) isValueString(value) → {Boolean}

Checks if the given string is an iCalendar duration value.

Parameters:
NameTypeDescription
valueString

The raw ical value

Source
Returns:

True, if the given value is of the duration ical type

Type: 
Boolean
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. Duration

This class represents the "duration" value type, with various calculation and manipulation methods.

Constructor

new Duration(data)

Creates a new ICAL.Duration instance.

Parameters:
NameTypeDescription
dataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source

Members

days :Number

The days in this duration

Type:
  • Number
Default Value
  • 0
Source

hours :Number

The days in this duration

Type:
  • Number
Default Value
  • 0
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icalduration"
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "duration"
Source

isNegative :Boolean

The seconds in this duration

Type:
  • Boolean
Default Value
  • false
Source

minutes :Number

The minutes in this duration

Type:
  • Number
Default Value
  • 0
Source

seconds :Number

The seconds in this duration

Type:
  • Number
Default Value
  • 0
Source

weeks :Number

The weeks in this duration

Type:
  • Number
Default Value
  • 0
Source

Methods

clone() → {ICAL.Duration}

Returns a clone of the duration object.

Source
Returns:

The cloned object

Type: 
ICAL.Duration

compare(aOther) → {Number}

Compares the duration instance with another one.

Parameters:
NameTypeDescription
aOtherICAL.Duration

The instance to compare with

Source
Returns:

-1, 0 or 1 for less/equal/greater

Type: 
Number

fromData(aData)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source

fromSeconds(aSeconds) → {ICAL.Duration}

Reads the passed seconds value into this duration object. Afterwards, members like days and weeks will be set up accordingly.

Parameters:
NameTypeDescription
aSecondsNumber

The duration value in seconds

Source
Returns:

Returns this instance

Type: 
ICAL.Duration

normalize()

Normalizes the duration instance. For example, a duration with a value of 61 seconds will be normalized to 1 minute and 1 second.

Source

reset()

Resets the duration instance to the default values, i.e. PT0S

Source

toICALString() → {String}

The iCalendar string representation of this duration.

Source
Returns:
Type: 
String

toSeconds() → {Number}

The duration value expressed as a number of seconds.

Source
Returns:

The duration value in seconds

Type: 
Number

toString() → {String}

The string representation of this duration.

Source
Returns:
Type: 
String

(static) fromData(aData) → {ICAL.Duration}

Creates a new ICAL.Duration instance from the given data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the duration

Properties
NameTypeDescription
weeksNumber

Duration in weeks

daysNumber

Duration in days

hoursNumber

Duration in hours

minutesNumber

Duration in minutes

secondsNumber

Duration in seconds

isNegativeBoolean

If true, the duration is negative

Source
Returns:

The createad duration instance

Type: 
ICAL.Duration

(static) fromSeconds(aSeconds) → {ICAL.Duration}

Returns a new ICAL.Duration instance from the passed seconds value.

Parameters:
NameTypeDescription
aSecondsNumber

The seconds to create the instance from

Source
Returns:

The newly created duration instance

Type: 
ICAL.Duration

(static) fromString(aStr) → {ICAL.Duration}

Creates a new ICAL.Duration instance from the passed string.

Parameters:
NameTypeDescription
aStrString

The string to parse

Source
Returns:

The created duration instance

Type: 
ICAL.Duration

(static) isValueString(value) → {Boolean}

Checks if the given string is an iCalendar duration value.

Parameters:
NameTypeDescription
valueString

The raw ical value

Source
Returns:

True, if the given value is of the duration ical type

Type: 
Boolean
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Event.html b/api/ICAL.Event.html index a7392d3e..3fd535e9 100644 --- a/api/ICAL.Event.html +++ b/api/ICAL.Event.html @@ -1,3 +1,3 @@ Class: Event
On this page

ICAL. 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 layers guide for more details.

Constructor

new Event(componentopt, options)

Creates a new ICAL.Event instance.

Parameters:
NameTypeAttributesDescription
componentICAL.Component<optional>

The ICAL.Component to base this event on

optionsObject

Options for this event

Properties
NameTypeDescription
strictExceptionsBoolean

When true, will verify exceptions are related by their UUID

exceptionsArray.<(ICAL.Component|ICAL.Event)>

Exceptions to this event, either as components or events. If not specified exceptions will automatically be set in relation of component's parent

Source

Members

(readonly) attendees :Array.<ICAL.Property>

The attendees in the event

Type:
Source

color :String

The event color from rfc7986

Type:
  • String
Source

description :String

The event description.

Type:
  • String
Source

duration :ICAL.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.

Type:
Source

endDate :ICAL.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.

Type:
Source

exceptions :Array.<ICAL.Event>

List of related event exceptions.

Type:
Source

location :String

The location of the event.

Type:
  • String
Source

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:...

Type:
  • String
Source

recurrenceId :ICAL.Time

The recurrence id for this event. See terminology for details.

Type:
Source

sequence :Number

The sequence value for this event. Used for scheduling see terminology.

Type:
  • Number
Source

startDate :ICAL.Time

The start date

Type:
Source

strictExceptions :Boolean

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

Type:
  • Boolean
Source

summary :String

The event summary

Type:
  • String
Source

uid :String

The uid of this event

Type:
  • String
Source

Methods

findRangeException(time) → (nullable) {ICAL.Event}

Finds the range exception nearest to the given date.

Parameters:
NameTypeDescription
timeICAL.Time

usually an occurrence time of an event

Source
Returns:

the related event/exception or null

Type: 
ICAL.Event

getOccurrenceDetails(occurrence) → {ICAL.Event.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:
NameTypeDescription
occurrenceICAL.Time

time occurrence

Source
Returns:

Information about the occurrence

Type: 
ICAL.Event.occurrenceDetails

getRecurrenceTypes() → {Object.<ICAL.Recur.frequencyValues, 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
Source
Returns:

Object of recurrence flags

Type: 
Object.<ICAL.Recur.frequencyValues, Boolean>

isRecurrenceException() → {Boolean}

Checks if the event describes a recurrence exception. See terminology for details.

Source
Returns:

True, if the event describes a recurrence exception

Type: 
Boolean

isRecurring() → {Boolean}

Checks if the event is recurring

Source
Returns:

True, if event is recurring

Type: 
Boolean

iterator(startTime) → {ICAL.RecurExpansion}

Builds a recur expansion instance for a specific point in time (defaults to startDate).

Parameters:
NameTypeDescription
startTimeICAL.Time

Starting point for expansion

Source
Returns:

Expansion object

Type: 
ICAL.RecurExpansion

modifiesFuture() → {Boolean}

Checks if this record is an exception and has the RANGE=THISANDFUTURE value.

Source
Returns:

True, when exception is within range

Type: 
Boolean

relateException(obj)

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:
NameTypeDescription
objICAL.Component | ICAL.Event

Component or event

Source

toString() → {String}

The string representation of this event.

Source
Returns:
Type: 
String

Type Definitions

occurrenceDetails

This object is returned by getOccurrenceDetails

Type:
  • Object
Properties
NameTypeDescription
recurrenceIdICAL.Time

The passed in recurrence id

itemICAL.Event

The occurrence

startDateICAL.Time

The start of the occurrence

endDateICAL.Time

The end of the occurrence

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. 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 layers guide for more details.

Constructor

new Event(componentopt, options)

Creates a new ICAL.Event instance.

Parameters:
NameTypeAttributesDescription
componentICAL.Component<optional>

The ICAL.Component to base this event on

optionsObject

Options for this event

Properties
NameTypeDescription
strictExceptionsBoolean

When true, will verify exceptions are related by their UUID

exceptionsArray.<(ICAL.Component|ICAL.Event)>

Exceptions to this event, either as components or events. If not specified exceptions will automatically be set in relation of component's parent

Source

Members

(readonly) attendees :Array.<ICAL.Property>

The attendees in the event

Type:
Source

color :String

The event color from rfc7986

Type:
  • String
Source

description :String

The event description.

Type:
  • String
Source

duration :ICAL.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.

Type:
Source

endDate :ICAL.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.

Type:
Source

exceptions :Array.<ICAL.Event>

List of related event exceptions.

Type:
Source

location :String

The location of the event.

Type:
  • String
Source

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:...

Type:
  • String
Source

recurrenceId :ICAL.Time

The recurrence id for this event. See terminology for details.

Type:
Source

sequence :Number

The sequence value for this event. Used for scheduling see terminology.

Type:
  • Number
Source

startDate :ICAL.Time

The start date

Type:
Source

strictExceptions :Boolean

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

Type:
  • Boolean
Source

summary :String

The event summary

Type:
  • String
Source

uid :String

The uid of this event

Type:
  • String
Source

Methods

findRangeException(time) → (nullable) {ICAL.Event}

Finds the range exception nearest to the given date.

Parameters:
NameTypeDescription
timeICAL.Time

usually an occurrence time of an event

Source
Returns:

the related event/exception or null

Type: 
ICAL.Event

getOccurrenceDetails(occurrence) → {ICAL.Event.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:
NameTypeDescription
occurrenceICAL.Time

time occurrence

Source
Returns:

Information about the occurrence

Type: 
ICAL.Event.occurrenceDetails

getRecurrenceTypes() → {Object.<ICAL.Recur.frequencyValues, 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
Source
Returns:

Object of recurrence flags

Type: 
Object.<ICAL.Recur.frequencyValues, Boolean>

isRecurrenceException() → {Boolean}

Checks if the event describes a recurrence exception. See terminology for details.

Source
Returns:

True, if the event describes a recurrence exception

Type: 
Boolean

isRecurring() → {Boolean}

Checks if the event is recurring

Source
Returns:

True, if event is recurring

Type: 
Boolean

iterator(startTime) → {ICAL.RecurExpansion}

Builds a recur expansion instance for a specific point in time (defaults to startDate).

Parameters:
NameTypeDescription
startTimeICAL.Time

Starting point for expansion

Source
Returns:

Expansion object

Type: 
ICAL.RecurExpansion

modifiesFuture() → {Boolean}

Checks if this record is an exception and has the RANGE=THISANDFUTURE value.

Source
Returns:

True, when exception is within range

Type: 
Boolean

relateException(obj)

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:
NameTypeDescription
objICAL.Component | ICAL.Event

Component or event

Source

toString() → {String}

The string representation of this event.

Source
Returns:
Type: 
String

Type Definitions

occurrenceDetails

This object is returned by getOccurrenceDetails

Type:
  • Object
Properties
NameTypeDescription
recurrenceIdICAL.Time

The passed in recurrence id

itemICAL.Event

The occurrence

startDateICAL.Time

The start of the occurrence

endDateICAL.Time

The end of the occurrence

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Period.html b/api/ICAL.Period.html index 4761bd49..4ad51c41 100644 --- a/api/ICAL.Period.html +++ b/api/ICAL.Period.html @@ -1,3 +1,3 @@ Class: Period
On this page

ICAL. Period

This class represents the "period" value type, with various calculation and manipulation methods.

Constructor

new Period(aData)

Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and a duration.

Parameters:
NameTypeDescription
aDataObject

An object with members of the period

Properties
NameTypeAttributesDescription
startICAL.Time<optional>

The start of the period

endICAL.Time<optional>

The end of the period

durationICAL.Duration<optional>

The duration of the period

Source

Members

duration :ICAL.Duration

The duration of the period

Type:
Source

end :ICAL.Time

The end of the period

Type:
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icalperiod"
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "period"
Source

start :ICAL.Time

The start of the period

Type:
Source

Methods

clone() → {ICAL.Period}

Returns a clone of the duration object.

Source
Returns:

The cloned object

Type: 
ICAL.Period

getDuration() → {ICAL.Duration}

Calculates the duration of the period, either directly or by subtracting start from end date.

Source
Returns:

The calculated duration

Type: 
ICAL.Duration

getEnd() → {ICAL.Time}

Calculates the end date of the period, either directly or by adding duration to start date.

Source
Returns:

The calculated end date

Type: 
ICAL.Time

toICALString() → {String}

The iCalendar string representation of this period.

Source
Returns:
Type: 
String

toJSON() → {Object}

The jCal representation of this period type.

Source
Returns:
Type: 
Object

toString() → {String}

The string representation of this period.

Source
Returns:
Type: 
String

(static) fromData(aData) → {ICAL.Period}

Creates a new ICAL.Period instance from the given data object. The passed data object cannot contain both and end date and a duration.

Parameters:
NameTypeDescription
aDataObject

An object with members of the period

Properties
NameTypeAttributesDescription
startICAL.Time<optional>

The start of the period

endICAL.Time<optional>

The end of the period

durationICAL.Duration<optional>

The duration of the period

Source
Returns:

The period instance

Type: 
ICAL.Period

(static) fromJSON(aData, aProp, aLenient) → {ICAL.Period}

Returns a new period instance from the given jCal data array. The first member is always the start date string, the second member is either a duration or end date string.

Parameters:
NameTypeDescription
aDataArray.<String, String>

The jCal data array

aPropICAL.Property

The property this jCal data is on

aLenientBoolean

If true, data value can be both date and date-time

Source
Returns:

The period instance

Type: 
ICAL.Period

(static) fromString(str, prop) → {ICAL.Period}

Creates a new ICAL.Period instance from the passed string.

Parameters:
NameTypeDescription
strString

The string to parse

propICAL.Property

The property this period will be on

Source
Returns:

The created period instance

Type: 
ICAL.Period
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. Period

This class represents the "period" value type, with various calculation and manipulation methods.

Constructor

new Period(aData)

Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and a duration.

Parameters:
NameTypeDescription
aDataObject

An object with members of the period

Properties
NameTypeAttributesDescription
startICAL.Time<optional>

The start of the period

endICAL.Time<optional>

The end of the period

durationICAL.Duration<optional>

The duration of the period

Source

Members

duration :ICAL.Duration

The duration of the period

Type:
Source

end :ICAL.Time

The end of the period

Type:
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icalperiod"
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "period"
Source

start :ICAL.Time

The start of the period

Type:
Source

Methods

clone() → {ICAL.Period}

Returns a clone of the duration object.

Source
Returns:

The cloned object

Type: 
ICAL.Period

getDuration() → {ICAL.Duration}

Calculates the duration of the period, either directly or by subtracting start from end date.

Source
Returns:

The calculated duration

Type: 
ICAL.Duration

getEnd() → {ICAL.Time}

Calculates the end date of the period, either directly or by adding duration to start date.

Source
Returns:

The calculated end date

Type: 
ICAL.Time

toICALString() → {String}

The iCalendar string representation of this period.

Source
Returns:
Type: 
String

toJSON() → {Object}

The jCal representation of this period type.

Source
Returns:
Type: 
Object

toString() → {String}

The string representation of this period.

Source
Returns:
Type: 
String

(static) fromData(aData) → {ICAL.Period}

Creates a new ICAL.Period instance from the given data object. The passed data object cannot contain both and end date and a duration.

Parameters:
NameTypeDescription
aDataObject

An object with members of the period

Properties
NameTypeAttributesDescription
startICAL.Time<optional>

The start of the period

endICAL.Time<optional>

The end of the period

durationICAL.Duration<optional>

The duration of the period

Source
Returns:

The period instance

Type: 
ICAL.Period

(static) fromJSON(aData, aProp, aLenient) → {ICAL.Period}

Returns a new period instance from the given jCal data array. The first member is always the start date string, the second member is either a duration or end date string.

Parameters:
NameTypeDescription
aDataArray.<String, String>

The jCal data array

aPropICAL.Property

The property this jCal data is on

aLenientBoolean

If true, data value can be both date and date-time

Source
Returns:

The period instance

Type: 
ICAL.Period

(static) fromString(str, prop) → {ICAL.Period}

Creates a new ICAL.Period instance from the passed string.

Parameters:
NameTypeDescription
strString

The string to parse

propICAL.Property

The property this period will be on

Source
Returns:

The created period instance

Type: 
ICAL.Period
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Property.html b/api/ICAL.Property.html index e69573a0..b895ed73 100644 --- a/api/ICAL.Property.html +++ b/api/ICAL.Property.html @@ -1,3 +1,3 @@ Class: Property
On this page

ICAL. Property

Provides a layer on top of the raw jCal object for manipulating a single property, with its parameters and value.

Constructor

new Property(jCal, parentopt)

Creates a new ICAL.Property instance.

It is important to note that mutations done in the wrapper directly mutate the jCal object used to initialize.

Can also be used to create new properties by passing the name of the property (as a String).

Parameters:
NameTypeAttributesDescription
jCalArray | String

Raw jCal representation OR the new name of the property

parentICAL.Component<optional>

Parent component

Source

Members

(readonly) name :String

The name of this property, in lowercase.

Type:
  • String
Source

parent :ICAL.Component

The parent component for this property.

Type:
Source

(readonly) type :String

The value type for this property

Type:
  • String
Source

Methods

getDefaultType() → {String}

Get the default type based on this property's name.

Source
Returns:

The default type for this property

Type: 
String

getFirstParameter(name) → {String}

Gets first parameter on the property.

Parameters:
NameTypeDescription
nameString

Parameter name (lowercase)

Source
Returns:

Parameter value

Type: 
String

getFirstValue() → {String}

Finds the first property value.

Source
Returns:

First property value

Type: 
String

getParameter(name) → {Array|String}

Gets a parameter on the property.

Parameters:
NameTypeDescription
nameString

Parameter name (lowercase)

Source
Returns:

Parameter value

Type: 
Array | String

getValues() → {Array}

Gets all values on the property.

NOTE: this creates an array during each call.

Source
Returns:

List of values

Type: 
Array

removeAllValues()

Removes all values from this property

Source

removeParameter(name)

Removes a parameter

Parameters:
NameTypeDescription
nameString

The parameter name

Source

resetType(type)

Sets type of property and clears out any existing values of the current type.

Parameters:
NameTypeDescription
typeString

New iCAL type (see design.*.values)

Source

setParameter(name, value)

Sets a parameter on the property.

Parameters:
NameTypeDescription
nameString

The parameter name

valueArray | String

The parameter value

Source

setValue(value)

Sets the current value of the property. If this is a multi-value property, all other values will be removed.

Parameters:
NameTypeDescription
valueString | Object

New property value.

Source

setValues(values)

Sets the values of the property. Will overwrite the existing values. This can only be used for multi-value properties.

Parameters:
NameTypeDescription
valuesArray

An array of values

Source

toICALString() → {String}

The string representation of this component.

Source
Returns:
Type: 
String

toJSON() → {Object}

Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Source
Returns:
Type: 
Object

(static) fromString(str, designSetopt) → {ICAL.Property}

Create an ICAL.Property by parsing the passed iCalendar string.

Parameters:
NameTypeAttributesDescription
strString

The iCalendar string to parse

designSetICAL.design.designSet<optional>

The design data to use for this property

Source
Returns:

The created iCalendar property

Type: 
ICAL.Property
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. Property

Provides a layer on top of the raw jCal object for manipulating a single property, with its parameters and value.

Constructor

new Property(jCal, parentopt)

Creates a new ICAL.Property instance.

It is important to note that mutations done in the wrapper directly mutate the jCal object used to initialize.

Can also be used to create new properties by passing the name of the property (as a String).

Parameters:
NameTypeAttributesDescription
jCalArray | String

Raw jCal representation OR the new name of the property

parentICAL.Component<optional>

Parent component

Source

Members

(readonly) name :String

The name of this property, in lowercase.

Type:
  • String
Source

parent :ICAL.Component

The parent component for this property.

Type:
Source

(readonly) type :String

The value type for this property

Type:
  • String
Source

Methods

getDefaultType() → {String}

Get the default type based on this property's name.

Source
Returns:

The default type for this property

Type: 
String

getFirstParameter(name) → {String}

Gets first parameter on the property.

Parameters:
NameTypeDescription
nameString

Parameter name (lowercase)

Source
Returns:

Parameter value

Type: 
String

getFirstValue() → {String}

Finds the first property value.

Source
Returns:

First property value

Type: 
String

getParameter(name) → {Array|String}

Gets a parameter on the property.

Parameters:
NameTypeDescription
nameString

Parameter name (lowercase)

Source
Returns:

Parameter value

Type: 
Array | String

getValues() → {Array}

Gets all values on the property.

NOTE: this creates an array during each call.

Source
Returns:

List of values

Type: 
Array

removeAllValues()

Removes all values from this property

Source

removeParameter(name)

Removes a parameter

Parameters:
NameTypeDescription
nameString

The parameter name

Source

resetType(type)

Sets type of property and clears out any existing values of the current type.

Parameters:
NameTypeDescription
typeString

New iCAL type (see design.*.values)

Source

setParameter(name, value)

Sets a parameter on the property.

Parameters:
NameTypeDescription
nameString

The parameter name

valueArray | String

The parameter value

Source

setValue(value)

Sets the current value of the property. If this is a multi-value property, all other values will be removed.

Parameters:
NameTypeDescription
valueString | Object

New property value.

Source

setValues(values)

Sets the values of the property. Will overwrite the existing values. This can only be used for multi-value properties.

Parameters:
NameTypeDescription
valuesArray

An array of values

Source

toICALString() → {String}

The string representation of this component.

Source
Returns:
Type: 
String

toJSON() → {Object}

Returns the Object representation of this component. The returned object is a live jCal object and should be cloned if modified.

Source
Returns:
Type: 
Object

(static) fromString(str, designSetopt) → {ICAL.Property}

Create an ICAL.Property by parsing the passed iCalendar string.

Parameters:
NameTypeAttributesDescription
strString

The iCalendar string to parse

designSetICAL.design.designSet<optional>

The design data to use for this property

Source
Returns:

The created iCalendar property

Type: 
ICAL.Property
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Recur.html b/api/ICAL.Recur.html index 27616dba..cf95d17a 100644 --- a/api/ICAL.Recur.html +++ b/api/ICAL.Recur.html @@ -1,6 +1,6 @@ Class: Recur
On this page

ICAL. Recur

This class represents the "recur" value type, used for example by RRULE. It provides methods to calculate occurrences among others.

Constructor

new Recur(data)

Create a new instance of the Recur class.

Parameters:
NameTypeDescription
dataObject

An object with members of the recurrence

Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>

The frequency value

intervalNumber<optional>

The INTERVAL value

wkstICAL.Time.weekDay<optional>

The week start value

untilICAL.Time<optional>

The end of the recurrence set

countNumber<optional>

The number of occurrences

bysecondArray.<Number><optional>

The seconds for the BYSECOND part

byminuteArray.<Number><optional>

The minutes for the BYMINUTE part

byhourArray.<Number><optional>

The hours for the BYHOUR part

bydayArray.<String><optional>

The BYDAY values

bymonthdayArray.<Number><optional>

The days for the BYMONTHDAY part

byyeardayArray.<Number><optional>

The days for the BYYEARDAY part

byweeknoArray.<Number><optional>

The weeks for the BYWEEKNO part

bymonthArray.<Number><optional>

The month for the BYMONTH part

bysetposArray.<Number><optional>

The positionals for the BYSETPOS part

Source

Members

(nullable) count :Number

The maximum number of occurrences

Type:
  • Number
Source

freq :ICAL.Recur.frequencyValues

The frequency value.

Type:
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icalrecur"
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "recur"
Source

interval :Number

The interval value for the recurrence rule.

Type:
  • Number
Source

parts :Object

An object holding the BY-parts of the recurrence rule

Type:
  • Object
Source

(nullable) until :ICAL.Time

The end of the recurrence

Type:
Source

wkst :ICAL.Time.weekDay

The week start day

Type:
Default Value
  • ICAL.Time.MONDAY
Source

Methods

addComponent(aType, aValue)

Adds a component (part) to the recurrence rule. This is not a component in the sense of ICAL.Component, but a part of the recurrence rule, i.e. BYMONTH.

Parameters:
NameTypeDescription
aTypeString

The name of the component part

aValueArray | String

The component value

Source

clone() → {ICAL.Recur}

Returns a clone of the recurrence object.

Source
Returns:

The cloned object

Type: 
ICAL.Recur

fromData(data)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
dataObject

An object with members of the recurrence

Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>

The frequency value

intervalNumber<optional>

The INTERVAL value

wkstICAL.Time.weekDay<optional>

The week start value

untilICAL.Time<optional>

The end of the recurrence set

countNumber<optional>

The number of occurrences

bysecondArray.<Number><optional>

The seconds for the BYSECOND part

byminuteArray.<Number><optional>

The minutes for the BYMINUTE part

byhourArray.<Number><optional>

The hours for the BYHOUR part

bydayArray.<String><optional>

The BYDAY values

bymonthdayArray.<Number><optional>

The days for the BYMONTHDAY part

byyeardayArray.<Number><optional>

The days for the BYYEARDAY part

byweeknoArray.<Number><optional>

The weeks for the BYWEEKNO part

bymonthArray.<Number><optional>

The month for the BYMONTH part

bysetposArray.<Number><optional>

The positionals for the BYSETPOS part

Source

getComponent(aType) → {Array}

Gets (a copy) of the requested component value.

Parameters:
NameTypeDescription
aTypeString

The component part name

Source
Returns:

The component part value

Type: 
Array

getNextOccurrence(aStartTime, aRecurrenceId) → {ICAL.Time}

Retrieves the next occurrence after the given recurrence id. See the guide on terminology for more details.

NOTE: Currently, this method iterates all occurrences from the start date. It should not be called in a loop for performance reasons. If you would like to get more than one occurrence, you can iterate the occurrences manually, see the example on the iterator method.

Parameters:
NameTypeDescription
aStartTimeICAL.Time

The start of the event series

aRecurrenceIdICAL.Time

The date of the last occurrence

Source
Returns:

The next occurrence after

Type: 
ICAL.Time

isByCount() → {Boolean}

Checks if the current rule has a count part, and not limited by an until part.

Source
Returns:

True, if the rule is by count

Type: 
Boolean

isFinite() → {Boolean}

Checks if the current rule is finite, i.e. has a count or until part.

Source
Returns:

True, if the rule is finite

Type: 
Boolean

iterator(aStart) → {ICAL.RecurIterator}

Create a new iterator for this recurrence rule. The passed start date must be the start date of the event, not the start of the range to search in.

Parameters:
NameTypeDescription
aStartICAL.Time

The item's start date

Source
Returns:

The recurrence iterator

Type: 
ICAL.RecurIterator
Example
let recur = comp.getFirstPropertyValue('rrule');
+    
On this page
ICAL. Recur
This class represents the "recur" value type, used for example by RRULE. It provides methods to calculate occurrences among others.
Constructor
new Recur(data)
Create a new instance of the Recur class.
Parameters:
NameTypeDescription
dataObject
An object with members of the recurrence
Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>
The frequency value
intervalNumber<optional>
The INTERVAL value
wkstICAL.Time.weekDay<optional>
The week start value
untilICAL.Time<optional>
The end of the recurrence set
countNumber<optional>
The number of occurrences
bysecondArray.<Number><optional>
The seconds for the BYSECOND part
byminuteArray.<Number><optional>
The minutes for the BYMINUTE part
byhourArray.<Number><optional>
The hours for the BYHOUR part
bydayArray.<String><optional>
The BYDAY values
bymonthdayArray.<Number><optional>
The days for the BYMONTHDAY part
byyeardayArray.<Number><optional>
The days for the BYYEARDAY part
byweeknoArray.<Number><optional>
The weeks for the BYWEEKNO part
bymonthArray.<Number><optional>
The month for the BYMONTH part
bysetposArray.<Number><optional>
The positionals for the BYSETPOS part
Source
Members
(nullable) count :Number
The maximum number of occurrences
Type:
  • Number
Source
freq :ICAL.Recur.frequencyValues
The frequency value.
Type:
Source
(constant) icalclass :String
The class identifier.
Type:
  • String
Default Value
  • "icalrecur"
Source
(constant) icaltype :String
The type name, to be used in the jCal object.
Type:
  • String
Default Value
  • "recur"
Source
interval :Number
The interval value for the recurrence rule.
Type:
  • Number
Source
parts :Object
An object holding the BY-parts of the recurrence rule
Type:
  • Object
Source
(nullable) until :ICAL.Time
The end of the recurrence
Type:
Source
wkst :ICAL.Time.weekDay
The week start day
Type:
Default Value
  • ICAL.Time.MONDAY
Source
Methods
addComponent(aType, aValue)
Adds a component (part) to the recurrence rule. This is not a component in the sense of ICAL.Component, but a part of the recurrence rule, i.e. BYMONTH.
Parameters:
NameTypeDescription
aTypeString
The name of the component part
aValueArray | String
The component value
Source
clone() → {ICAL.Recur}
Returns a clone of the recurrence object.
Source
Returns:
The cloned object
Type: 
ICAL.Recur
fromData(data)
Sets up the current instance using members from the passed data object.
Parameters:
NameTypeDescription
dataObject
An object with members of the recurrence
Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>
The frequency value
intervalNumber<optional>
The INTERVAL value
wkstICAL.Time.weekDay<optional>
The week start value
untilICAL.Time<optional>
The end of the recurrence set
countNumber<optional>
The number of occurrences
bysecondArray.<Number><optional>
The seconds for the BYSECOND part
byminuteArray.<Number><optional>
The minutes for the BYMINUTE part
byhourArray.<Number><optional>
The hours for the BYHOUR part
bydayArray.<String><optional>
The BYDAY values
bymonthdayArray.<Number><optional>
The days for the BYMONTHDAY part
byyeardayArray.<Number><optional>
The days for the BYYEARDAY part
byweeknoArray.<Number><optional>
The weeks for the BYWEEKNO part
bymonthArray.<Number><optional>
The month for the BYMONTH part
bysetposArray.<Number><optional>
The positionals for the BYSETPOS part
Source
getComponent(aType) → {Array}
Gets (a copy) of the requested component value.
Parameters:
NameTypeDescription
aTypeString
The component part name
Source
Returns:
The component part value
Type: 
Array
getNextOccurrence(aStartTime, aRecurrenceId) → {ICAL.Time}
Retrieves the next occurrence after the given recurrence id. See the guide on terminology for more details.
NOTE: Currently, this method iterates all occurrences from the start date. It should not be called in a loop for performance reasons. If you would like to get more than one occurrence, you can iterate the occurrences manually, see the example on the iterator method.
Parameters:
NameTypeDescription
aStartTimeICAL.Time
The start of the event series
aRecurrenceIdICAL.Time
The date of the last occurrence
Source
Returns:
The next occurrence after
Type: 
ICAL.Time
isByCount() → {Boolean}
Checks if the current rule has a count part, and not limited by an until part.
Source
Returns:
True, if the rule is by count
Type: 
Boolean
isFinite() → {Boolean}
Checks if the current rule is finite, i.e. has a count or until part.
Source
Returns:
True, if the rule is finite
Type: 
Boolean
iterator(aStart) → {ICAL.RecurIterator}
Create a new iterator for this recurrence rule. The passed start date must be the start date of the event, not the start of the range to search in.
Parameters:
NameTypeDescription
aStartICAL.Time
The item's start date
Source
Returns:
The recurrence iterator
Type: 
ICAL.RecurIterator
Example
let recur = comp.getFirstPropertyValue('rrule');
 let dtstart = comp.getFirstPropertyValue('dtstart');
 let iter = recur.iterator(dtstart);
 for (let next = iter.next(); next; next = iter.next()) {
@@ -8,4 +8,4 @@
     continue;
   }
   console.log(next.toString());
-}
setComponent(aType, aValues)
Sets the component value for the given by-part.
Parameters:
NameTypeDescription
aTypeString
The component part name
aValuesArray
The component values
Source
toJSON() → {Object}
The jCal representation of this recurrence type.
Source
Returns:
Type: 
Object
toString() → {String}
The string representation of this recurrence rule.
Source
Returns:
Type: 
String
(static) fromData(aData)
Creates a new ICAL.Recur instance using members from the passed data object.
Parameters:
NameTypeDescription
aDataObject
An object with members of the recurrence
Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>
The frequency value
intervalNumber<optional>
The INTERVAL value
wkstICAL.Time.weekDay<optional>
The week start value
untilICAL.Time<optional>
The end of the recurrence set
countNumber<optional>
The number of occurrences
bysecondArray.<Number><optional>
The seconds for the BYSECOND part
byminuteArray.<Number><optional>
The minutes for the BYMINUTE part
byhourArray.<Number><optional>
The hours for the BYHOUR part
bydayArray.<String><optional>
The BYDAY values
bymonthdayArray.<Number><optional>
The days for the BYMONTHDAY part
byyeardayArray.<Number><optional>
The days for the BYYEARDAY part
byweeknoArray.<Number><optional>
The weeks for the BYWEEKNO part
bymonthArray.<Number><optional>
The month for the BYMONTH part
bysetposArray.<Number><optional>
The positionals for the BYSETPOS part
Source
(static) fromString(string) → {ICAL.Recur}
Creates a new ICAL.Recur instance from the passed string.
Parameters:
NameTypeDescription
stringString
The string to parse
Source
Returns:
The created recurrence instance
Type: 
ICAL.Recur
(static) icalDayToNumericDay(string, aWeekStartopt) → {Number}
Convert an ical representation of a day (SU, MO, etc..) into a numeric value of that day.
Parameters:
NameTypeAttributesDescription
stringString
The iCalendar day name
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Source
Returns:
Numeric value of given day
Type: 
Number
(static) numericDayToIcalDay(num, aWeekStartopt) → {String}
Convert a numeric day value into its ical representation (SU, MO, etc..)
Parameters:
NameTypeAttributesDescription
numNumber
Numeric value of given day
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Source
Returns:
The ICAL day value, e.g SU,MO,...
Type: 
String
Type Definitions
frequencyValues
Possible frequency values for the FREQ part (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)
Type:
  • String
Source

\ No newline at end of file
+}

setComponent(aType, aValues)

Sets the component value for the given by-part.

Parameters:
NameTypeDescription
aTypeString

The component part name

aValuesArray

The component values

Source

toJSON() → {Object}

The jCal representation of this recurrence type.

Source
Returns:
Type: 
Object

toString() → {String}

The string representation of this recurrence rule.

Source
Returns:
Type: 
String

(static) fromData(aData)

Creates a new ICAL.Recur instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the recurrence

Properties
NameTypeAttributesDescription
freqICAL.Recur.frequencyValues<optional>

The frequency value

intervalNumber<optional>

The INTERVAL value

wkstICAL.Time.weekDay<optional>

The week start value

untilICAL.Time<optional>

The end of the recurrence set

countNumber<optional>

The number of occurrences

bysecondArray.<Number><optional>

The seconds for the BYSECOND part

byminuteArray.<Number><optional>

The minutes for the BYMINUTE part

byhourArray.<Number><optional>

The hours for the BYHOUR part

bydayArray.<String><optional>

The BYDAY values

bymonthdayArray.<Number><optional>

The days for the BYMONTHDAY part

byyeardayArray.<Number><optional>

The days for the BYYEARDAY part

byweeknoArray.<Number><optional>

The weeks for the BYWEEKNO part

bymonthArray.<Number><optional>

The month for the BYMONTH part

bysetposArray.<Number><optional>

The positionals for the BYSETPOS part

Source

(static) fromString(string) → {ICAL.Recur}

Creates a new ICAL.Recur instance from the passed string.

Parameters:
NameTypeDescription
stringString

The string to parse

Source
Returns:

The created recurrence instance

Type: 
ICAL.Recur

(static) icalDayToNumericDay(string, aWeekStartopt) → {Number}

Convert an ical representation of a day (SU, MO, etc..) into a numeric value of that day.

Parameters:
NameTypeAttributesDescription
stringString

The iCalendar day name

aWeekStartICAL.Time.weekDay<optional>

The week start weekday, defaults to SUNDAY

Source
Returns:

Numeric value of given day

Type: 
Number

(static) numericDayToIcalDay(num, aWeekStartopt) → {String}

Convert a numeric day value into its ical representation (SU, MO, etc..)

Parameters:
NameTypeAttributesDescription
numNumber

Numeric value of given day

aWeekStartICAL.Time.weekDay<optional>

The week start weekday, defaults to SUNDAY

Source
Returns:

The ICAL day value, e.g SU,MO,...

Type: 
String

Type Definitions

frequencyValues

Possible frequency values for the FREQ part (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)

Type:
  • String
Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.RecurExpansion.html b/api/ICAL.RecurExpansion.html index f4a8fdf3..2a7e716f 100644 --- a/api/ICAL.RecurExpansion.html +++ b/api/ICAL.RecurExpansion.html @@ -1,6 +1,6 @@ Class: RecurExpansion
On this page

ICAL. RecurExpansion

Primary class for expanding recurring rules. Can take multiple rrules, rdates, exdate(s) and iterate (in order) over each next occurrence.

Once initialized this class can also be serialized saved and continue iteration from the last point.

NOTE: it is intended that this class is to be used with ICAL.Event which handles recurrence exceptions.

Constructor

new RecurExpansion(options)

Creates a new ICAL.RecurExpansion instance.

The options object can be filled with the specified initial values. It can also contain additional members, as a result of serializing a previous expansion state, as shown in the example.

Parameters:
NameTypeDescription
optionsObject

Recurrence expansion options

Properties
NameTypeAttributesDescription
dtstartICAL.Time

Start time of the event

componentICAL.Component<optional>

Component for expansion, required if not resuming.

Source
Example
// assuming event is a parsed ical component
+    
On this page
ICAL. RecurExpansion
Primary class for expanding recurring rules. Can take multiple rrules, rdates, exdate(s) and iterate (in order) over each next occurrence.
Once initialized this class can also be serialized saved and continue iteration from the last point.
NOTE: it is intended that this class is to be used with ICAL.Event which handles recurrence exceptions.
Constructor
new RecurExpansion(options)
Creates a new ICAL.RecurExpansion instance.
The options object can be filled with the specified initial values. It can also contain additional members, as a result of serializing a previous expansion state, as shown in the example.
Parameters:
NameTypeDescription
optionsObject
Recurrence expansion options
Properties
NameTypeAttributesDescription
dtstartICAL.Time
Start time of the event
componentICAL.Component<optional>
Component for expansion, required if not resuming.
Source
Example
// assuming event is a parsed ical component
 var event;
 
 var expand = new ICAL.RecurExpansion({
@@ -25,4 +25,4 @@
 
 // NOTE: if the component's properties have changed you will need to rebuild the class and start
 // over. This only works when the component's recurrence info is the same.
-var expand = new ICAL.RecurExpansion(JSON.parse(json));
Members
complete :Boolean
True when iteration is fully completed.
Type:
  • Boolean
Source
dtstart :ICAL.Time
Start date of recurring rules.
Type:
Source
last :ICAL.Time
Last expanded time
Type:
Source
Methods
fromData(options)
Initialize the recurrence expansion from the data object. The options object may also contain additional members, see the constructor for more details.
Parameters:
NameTypeDescription
optionsObject
Recurrence expansion options
Properties
NameTypeAttributesDescription
dtstartICAL.Time
Start time of the event
componentICAL.Component<optional>
Component for expansion, required if not resuming.
Source
next() → {ICAL.Time}
Retrieve the next occurrence in the series.
Source
Returns:
Type: 
ICAL.Time
toJSON() → {Object}
Converts object into a serialize-able format. This format can be passed back into the expansion to resume iteration.
Source
Returns:
Type: 
Object

\ No newline at end of file
+var expand = new ICAL.RecurExpansion(JSON.parse(json));

Members

complete :Boolean

True when iteration is fully completed.

Type:
  • Boolean
Source

dtstart :ICAL.Time

Start date of recurring rules.

Type:
Source

last :ICAL.Time

Last expanded time

Type:
Source

Methods

fromData(options)

Initialize the recurrence expansion from the data object. The options object may also contain additional members, see the constructor for more details.

Parameters:
NameTypeDescription
optionsObject

Recurrence expansion options

Properties
NameTypeAttributesDescription
dtstartICAL.Time

Start time of the event

componentICAL.Component<optional>

Component for expansion, required if not resuming.

Source

next() → {ICAL.Time}

Retrieve the next occurrence in the series.

Source
Returns:
Type: 
ICAL.Time

toJSON() → {Object}

Converts object into a serialize-able format. This format can be passed back into the expansion to resume iteration.

Source
Returns:
Type: 
Object
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.RecurIterator.html b/api/ICAL.RecurIterator.html index 59f1608b..aa59659a 100644 --- a/api/ICAL.RecurIterator.html +++ b/api/ICAL.RecurIterator.html @@ -1,3 +1,3 @@ Class: RecurIterator
On this page

ICAL. RecurIterator

An iterator for a single recurrence rule. This class usually doesn't have to be instanciated directly, the convenience method ICAL.Recur#iterator can be used.

Constructor

new RecurIterator(options)

Creates a new ICAL.RecurIterator instance. The options object may contain additional members when resuming iteration from a previous run.

Parameters:
NameTypeDescription
optionsObject

The iterator options

Properties
NameTypeAttributesDescription
ruleICAL.Recur

The rule to iterate.

dtstartICAL.Time

The start date of the event.

initializedBoolean<optional>

When true, assume that options are from a previously constructed iterator. Initialization will not be repeated.

Source

Members

completed :Boolean

True when iteration is finished.

Type:
  • Boolean
Source

dtstart :ICAL.Time

The start date of the event being iterated.

Type:
Source

last :ICAL.Time

The last occurrence that was returned from the ICAL.RecurIterator#next method.

Type:
Source

occurrence_number :Number

The sequence number from the occurrence

Type:
  • Number
Source

rule :ICAL.Recur

The rule that is being iterated

Type:
Source

Methods

fromData(options)

Initialize the recurrence iterator from the passed data object. This method is usually not called directly, you can initialize the iterator through the constructor.

Parameters:
NameTypeDescription
optionsObject

The iterator options

Properties
NameTypeAttributesDescription
ruleICAL.Recur

The rule to iterate.

dtstartICAL.Time

The start date of the event.

initializedBoolean<optional>

When true, assume that options are from a previously constructed iterator. Initialization will not be repeated.

Source

next() → {ICAL.Time}

Retrieve the next occurrence from the iterator.

Source
Returns:
Type: 
ICAL.Time

ruleDayOfWeek(dow, aWeekStartopt)

Parameters:
NameTypeAttributesDescription
dow

(eg: '1TU', '-1MO')

aWeekStartICAL.Time.weekDay<optional>

The week start weekday

Source
Returns:

[pos, numericDow] (eg: [1, 3]) numericDow is relative to aWeekStart

toJSON() → {Object}

Convert iterator into a serialize-able object. Will preserve current iteration sequence to ensure the seamless continuation of the recurrence rule.

Source
Returns:
Type: 
Object
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. RecurIterator

An iterator for a single recurrence rule. This class usually doesn't have to be instanciated directly, the convenience method ICAL.Recur#iterator can be used.

Constructor

new RecurIterator(options)

Creates a new ICAL.RecurIterator instance. The options object may contain additional members when resuming iteration from a previous run.

Parameters:
NameTypeDescription
optionsObject

The iterator options

Properties
NameTypeAttributesDescription
ruleICAL.Recur

The rule to iterate.

dtstartICAL.Time

The start date of the event.

initializedBoolean<optional>

When true, assume that options are from a previously constructed iterator. Initialization will not be repeated.

Source

Members

completed :Boolean

True when iteration is finished.

Type:
  • Boolean
Source

dtstart :ICAL.Time

The start date of the event being iterated.

Type:
Source

last :ICAL.Time

The last occurrence that was returned from the ICAL.RecurIterator#next method.

Type:
Source

occurrence_number :Number

The sequence number from the occurrence

Type:
  • Number
Source

rule :ICAL.Recur

The rule that is being iterated

Type:
Source

Methods

fromData(options)

Initialize the recurrence iterator from the passed data object. This method is usually not called directly, you can initialize the iterator through the constructor.

Parameters:
NameTypeDescription
optionsObject

The iterator options

Properties
NameTypeAttributesDescription
ruleICAL.Recur

The rule to iterate.

dtstartICAL.Time

The start date of the event.

initializedBoolean<optional>

When true, assume that options are from a previously constructed iterator. Initialization will not be repeated.

Source

next() → {ICAL.Time}

Retrieve the next occurrence from the iterator.

Source
Returns:
Type: 
ICAL.Time

ruleDayOfWeek(dow, aWeekStartopt)

Parameters:
NameTypeAttributesDescription
dow

(eg: '1TU', '-1MO')

aWeekStartICAL.Time.weekDay<optional>

The week start weekday

Source
Returns:

[pos, numericDow] (eg: [1, 3]) numericDow is relative to aWeekStart

toJSON() → {Object}

Convert iterator into a serialize-able object. Will preserve current iteration sequence to ensure the seamless continuation of the recurrence rule.

Source
Returns:
Type: 
Object
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Time.html b/api/ICAL.Time.html index 0ceda73e..82048193 100644 --- a/api/ICAL.Time.html +++ b/api/ICAL.Time.html @@ -1,6 +1,6 @@ Class: Time
On this page

ICAL. Time

iCalendar Time representation (similar to JS Date object). Fully independent of system (OS) timezone / time. Unlike JS Date, the month January is 1, not zero.

Constructor

new Time(data, zone)

Creates a new ICAL.Time instance.

Parameters:
NameTypeDescription
dataObject

Time initialization

Properties
NameTypeAttributesDescription
yearNumber<optional>

The year for this date

monthNumber<optional>

The month for this date

dayNumber<optional>

The day for this date

hourNumber<optional>

The hour for this date

minuteNumber<optional>

The minute for this date

secondNumber<optional>

The second for this date

isDateBoolean<optional>

If true, the instance represents a date (as opposed to a date-time)

zoneICAL.Timezone

timezone this position occurs in

Source
Example
var time = new ICAL.Time({
+    
On this page
ICAL. Time
iCalendar Time representation (similar to JS Date object). Fully independent of system (OS) timezone / time. Unlike JS Date, the month January is 1, not zero.
Constructor
new Time(data, zone)
Creates a new ICAL.Time instance.
Parameters:
NameTypeDescription
dataObject
Time initialization
Properties
NameTypeAttributesDescription
yearNumber<optional>
The year for this date
monthNumber<optional>
The month for this date
dayNumber<optional>
The day for this date
hourNumber<optional>
The hour for this date
minuteNumber<optional>
The minute for this date
secondNumber<optional>
The second for this date
isDateBoolean<optional>
If true, the instance represents a date (as opposed to a date-time)
zoneICAL.Timezone
timezone this position occurs in
Source
Example
var time = new ICAL.Time({
   year: 2012,
   month: 10,
   day: 11
@@ -13,4 +13,4 @@
 
 var deserialized = JSON.parse(json);
 
-var time = new ICAL.Time(deserialized);
toString() → {String}
The string representation of this date/time, in jCal form (including : and - separators).
Source
Returns:
Type: 
String
toUnixTime() → {Number}
Converts the current instance to seconds since January 1st 1970.
Source
Returns:
Seconds since 1970
Type: 
Number
utcOffset() → {Number}
Calculates the UTC offset of the current date/time in the timezone it is in.
Source
Returns:
UTC offset in seconds
Type: 
Number
weekNumber(aWeekStart) → {Number}
Calculates the ISO 8601 week number. The first week of a year is the week that contains the first Thursday. The year can have 53 weeks, if January 1st is a Friday.
Note there are regions where the first week of the year is the one that starts on January 1st, which may offset the week number. Also, if a different week start is specified, this will also affect the week number.
Parameters:
NameTypeDescription
aWeekStartICAL.Time.weekDay
The weekday the week starts with
Source
See
Returns:
The ISO week number
Type: 
Number
(static) daysInMonth(month, year) → {Number}
Returns the days in the given month
Parameters:
NameTypeDescription
monthNumber
The month to check
yearNumber
The year to check
Source
Returns:
The number of days in the month
Type: 
Number
(static) fromDateString(aValue) → {ICAL.Time}
Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.
Parameters:
NameTypeDescription
aValueString
The string to create from
Source
Returns:
The date/time instance
Type: 
ICAL.Time
(static) fromDateTimeString(aValue, propopt) → {ICAL.Time}
Returns a new ICAL.Time instance from a date-time string, e.g 2015-01-02T03:04:05. If a property is specified, the timezone is set up from the property's TZID parameter.
Parameters:
NameTypeAttributesDescription
aValueString
The string to create from
propICAL.Property<optional>
The property the date belongs to
Source
Returns:
The date/time instance
Type: 
ICAL.Time
(static) fromDayOfYear(aDayOfYear, aYear) → {ICAL.Time}
Create a new ICAL.Time from the day of year and year. The date is returned in floating timezone.
Parameters:
NameTypeDescription
aDayOfYearNumber
The day of year
aYearNumber
The year to create the instance in
Source
Returns:
The created instance with the calculated date
Type: 
ICAL.Time
(static) fromJSDate(aDatenullable, useUTC)
Creates a new ICAL.Time instance from the given Javascript Date.
Parameters:
NameTypeAttributesDescription
aDateDate<nullable>
The Javascript Date to read, or null to reset
useUTCBoolean
If true, the UTC values of the date will be used
Source
(static) fromString(aValue, propopt) → {ICAL.Time}
Returns a new ICAL.Time instance from a date or date-time string,
Parameters:
NameTypeAttributesDescription
aValueString
The string to create from
propICAL.Property<optional>
The property the date belongs to
Source
Returns:
The date/time instance
Type: 
ICAL.Time
(static) fromStringv2(str) → {ICAL.Time}
Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.
Parameters:
NameTypeDescription
strString
The string to create from
Deprecated
Source
Returns:
The date/time instance
Type: 
ICAL.Time
(static) getDominicalLetter(yr) → {String}
Get the dominical letter for the given year. Letters range from A - G for common years, and AG to GF for leap years.
Parameters:
NameTypeDescription
yrNumber
The year to retrieve the letter for
Source
Returns:
The dominical letter.
Type: 
String
(static) isLeapYear(year) → {Boolean}
Checks if the year is a leap year
Parameters:
NameTypeDescription
yearNumber
The year to check
Source
Returns:
True, if the year is a leap year
Type: 
Boolean
(static) now() → {ICAL.Time}
Creates a new ICAL.Time instance from the current moment. The instance is “floating” - has no timezone relation. To create an instance considering the time zone, call ICAL.Time.fromJSDate(new Date(), true)
Source
Returns:
Type: 
ICAL.Time
(static) weekOneStarts(aYear, aWeekStartopt) → {ICAL.Time}
Returns the date on which ISO week number 1 starts.
Parameters:
NameTypeAttributesDescription
aYearNumber
The year to search in
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, used for calculation.
Source
See
Returns:
The date on which week number 1 starts
Type: 
ICAL.Time
Type Definitions
weekDay
The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via ICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...
Type:
  • Number
Source

\ No newline at end of file
+var time = new ICAL.Time(deserialized);

toString() → {String}

The string representation of this date/time, in jCal form (including : and - separators).

Source
Returns:
Type: 
String

toUnixTime() → {Number}

Converts the current instance to seconds since January 1st 1970.

Source
Returns:

Seconds since 1970

Type: 
Number

utcOffset() → {Number}

Calculates the UTC offset of the current date/time in the timezone it is in.

Source
Returns:

UTC offset in seconds

Type: 
Number

weekNumber(aWeekStart) → {Number}

Calculates the ISO 8601 week number. The first week of a year is the week that contains the first Thursday. The year can have 53 weeks, if January 1st is a Friday.

Note there are regions where the first week of the year is the one that starts on January 1st, which may offset the week number. Also, if a different week start is specified, this will also affect the week number.

Parameters:
NameTypeDescription
aWeekStartICAL.Time.weekDay

The weekday the week starts with

Source
See
Returns:

The ISO week number

Type: 
Number

(static) daysInMonth(month, year) → {Number}

Returns the days in the given month

Parameters:
NameTypeDescription
monthNumber

The month to check

yearNumber

The year to check

Source
Returns:

The number of days in the month

Type: 
Number

(static) fromDateString(aValue) → {ICAL.Time}

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

Parameters:
NameTypeDescription
aValueString

The string to create from

Source
Returns:

The date/time instance

Type: 
ICAL.Time

(static) fromDateTimeString(aValue, propopt) → {ICAL.Time}

Returns a new ICAL.Time instance from a date-time string, e.g 2015-01-02T03:04:05. If a property is specified, the timezone is set up from the property's TZID parameter.

Parameters:
NameTypeAttributesDescription
aValueString

The string to create from

propICAL.Property<optional>

The property the date belongs to

Source
Returns:

The date/time instance

Type: 
ICAL.Time

(static) fromDayOfYear(aDayOfYear, aYear) → {ICAL.Time}

Create a new ICAL.Time from the day of year and year. The date is returned in floating timezone.

Parameters:
NameTypeDescription
aDayOfYearNumber

The day of year

aYearNumber

The year to create the instance in

Source
Returns:

The created instance with the calculated date

Type: 
ICAL.Time

(static) fromJSDate(aDatenullable, useUTC)

Creates a new ICAL.Time instance from the given Javascript Date.

Parameters:
NameTypeAttributesDescription
aDateDate<nullable>

The Javascript Date to read, or null to reset

useUTCBoolean

If true, the UTC values of the date will be used

Source

(static) fromString(aValue, propopt) → {ICAL.Time}

Returns a new ICAL.Time instance from a date or date-time string,

Parameters:
NameTypeAttributesDescription
aValueString

The string to create from

propICAL.Property<optional>

The property the date belongs to

Source
Returns:

The date/time instance

Type: 
ICAL.Time

(static) fromStringv2(str) → {ICAL.Time}

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

Parameters:
NameTypeDescription
strString

The string to create from

Deprecated
Source
Returns:

The date/time instance

Type: 
ICAL.Time

(static) getDominicalLetter(yr) → {String}

Get the dominical letter for the given year. Letters range from A - G for common years, and AG to GF for leap years.

Parameters:
NameTypeDescription
yrNumber

The year to retrieve the letter for

Source
Returns:

The dominical letter.

Type: 
String

(static) isLeapYear(year) → {Boolean}

Checks if the year is a leap year

Parameters:
NameTypeDescription
yearNumber

The year to check

Source
Returns:

True, if the year is a leap year

Type: 
Boolean

(static) now() → {ICAL.Time}

Creates a new ICAL.Time instance from the current moment. The instance is “floating” - has no timezone relation. To create an instance considering the time zone, call ICAL.Time.fromJSDate(new Date(), true)

Source
Returns:
Type: 
ICAL.Time

(static) weekOneStarts(aYear, aWeekStartopt) → {ICAL.Time}

Returns the date on which ISO week number 1 starts.

Parameters:
NameTypeAttributesDescription
aYearNumber

The year to search in

aWeekStartICAL.Time.weekDay<optional>

The week start weekday, used for calculation.

Source
See
Returns:

The date on which week number 1 starts

Type: 
ICAL.Time

Type Definitions

weekDay

The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via ICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...

Type:
  • Number
Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.Timezone.html b/api/ICAL.Timezone.html index beaac6d6..1b254931 100644 --- a/api/ICAL.Timezone.html +++ b/api/ICAL.Timezone.html @@ -1,10 +1,10 @@ Class: Timezone
On this page

ICAL. Timezone

Timezone representation.

Constructor

new Timezone(data)

Creates a new ICAL.Timezone instance, by passing in a tzid and component.

Parameters:
NameTypeDescription
dataICAL.Component | Object

options for class

Properties
NameTypeDescription
componentString | ICAL.Component

If data is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component

tzidString

The timezone identifier

locationString

The timezone locationw

tznamesString

An alternative string representation of the timezone

latitudeNumber

The latitude of the timezone

longitudeNumber

The longitude of the timezone

Source
Example
var vcalendar;
+    
On this page
ICAL. Timezone
Timezone representation.
Constructor
new Timezone(data)
Creates a new ICAL.Timezone instance, by passing in a tzid and component.
Parameters:
NameTypeDescription
dataICAL.Component | Object
options for class
Properties
NameTypeDescription
componentString | ICAL.Component
If data is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component
tzidString
The timezone identifier
locationString
The timezone locationw
tznamesString
An alternative string representation of the timezone
latitudeNumber
The latitude of the timezone
longitudeNumber
The longitude of the timezone
Source
Example
var vcalendar;
 var timezoneComp = vcalendar.getFirstSubcomponent('vtimezone');
 var tzid = timezoneComp.getFirstPropertyValue('tzid');
 
 var timezone = new ICAL.Timezone({
   component: timezoneComp,
   tzid
-});
Members
component :ICAL.Component
The vtimezone component for this timezone.
Type:
Source
(constant) icalclass :String
The class identifier.
Type:
  • String
Default Value
  • "icaltimezone"
Source
latitude :Number
The primary latitude for the timezone.
Type:
  • Number
Source
location :String
Timezone location
Type:
  • String
Source
longitude :Number
The primary longitude for the timezone.
Type:
  • Number
Source
tzid :String
Timezone identifier
Type:
  • String
Source
tznames :String
Alternative timezone name, for the string representation
Type:
  • String
Source
Methods
fromData(aData)
Sets up the current instance using members from the passed data object.
Parameters:
NameTypeDescription
aDataICAL.Component | Object
options for class
Properties
NameTypeDescription
componentString | ICAL.Component
If aData is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component
tzidString
The timezone identifier
locationString
The timezone locationw
tznamesString
An alternative string representation of the timezone
latitudeNumber
The latitude of the timezone
longitudeNumber
The longitude of the timezone
Source
toString() → {String}
The string representation of this timezone.
Source
Returns:
Type: 
String
utcOffset(tt) → {Number}
Finds the utcOffset the given time would occur in this timezone.
Parameters:
NameTypeDescription
ttICAL.Time
The time to check for
Source
Returns:
utc offset in seconds
Type: 
Number
(static) convert_time(tt, from_zone, to_zone) → {ICAL.Time}
Convert the date/time from one zone to the next.
Parameters:
NameTypeDescription
ttICAL.Time
The time to convert
from_zoneICAL.Timezone
The source zone to convert from
to_zoneICAL.Timezone
The target zone to convert to
Source
Returns:
The converted date/time object
Type: 
ICAL.Time
(static) fromData(aData)
Creates a new ICAL.Timezone instance from the passed data object.
Parameters:
NameTypeDescription
aDataICAL.Component | Object
options for class
Properties
NameTypeDescription
componentString | ICAL.Component
If aData is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component
tzidString
The timezone identifier
locationString
The timezone locationw
tznamesString
An alternative string representation of the timezone
latitudeNumber
The latitude of the timezone
longitudeNumber
The longitude of the timezone
Source

\ No newline at end of file
+});

Members

component :ICAL.Component

The vtimezone component for this timezone.

Type:
Source

(constant) icalclass :String

The class identifier.

Type:
  • String
Default Value
  • "icaltimezone"
Source

latitude :Number

The primary latitude for the timezone.

Type:
  • Number
Source

location :String

Timezone location

Type:
  • String
Source

longitude :Number

The primary longitude for the timezone.

Type:
  • Number
Source

tzid :String

Timezone identifier

Type:
  • String
Source

tznames :String

Alternative timezone name, for the string representation

Type:
  • String
Source

Methods

fromData(aData)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataICAL.Component | Object

options for class

Properties
NameTypeDescription
componentString | ICAL.Component

If aData is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component

tzidString

The timezone identifier

locationString

The timezone locationw

tznamesString

An alternative string representation of the timezone

latitudeNumber

The latitude of the timezone

longitudeNumber

The longitude of the timezone

Source

toString() → {String}

The string representation of this timezone.

Source
Returns:
Type: 
String

utcOffset(tt) → {Number}

Finds the utcOffset the given time would occur in this timezone.

Parameters:
NameTypeDescription
ttICAL.Time

The time to check for

Source
Returns:

utc offset in seconds

Type: 
Number

(static) convert_time(tt, from_zone, to_zone) → {ICAL.Time}

Convert the date/time from one zone to the next.

Parameters:
NameTypeDescription
ttICAL.Time

The time to convert

from_zoneICAL.Timezone

The source zone to convert from

to_zoneICAL.Timezone

The target zone to convert to

Source
Returns:

The converted date/time object

Type: 
ICAL.Time

(static) fromData(aData)

Creates a new ICAL.Timezone instance from the passed data object.

Parameters:
NameTypeDescription
aDataICAL.Component | Object

options for class

Properties
NameTypeDescription
componentString | ICAL.Component

If aData is a simple object, then this member can be set to either a string containing the component data, or an already parsed ICAL.Component

tzidString

The timezone identifier

locationString

The timezone locationw

tznamesString

An alternative string representation of the timezone

latitudeNumber

The latitude of the timezone

longitudeNumber

The longitude of the timezone

Source
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.UtcOffset.html b/api/ICAL.UtcOffset.html index 6ad8565f..3d12e0a7 100644 --- a/api/ICAL.UtcOffset.html +++ b/api/ICAL.UtcOffset.html @@ -1,3 +1,3 @@ Class: UtcOffset
On this page

ICAL. UtcOffset

This class represents the "utc-offset" value type, with various calculation and manipulation methods.

Constructor

new UtcOffset(aData)

Creates a new ICAL.UtcOffset instance.

Parameters:
NameTypeDescription
aDataObject

An object with members of the utc offset

Properties
NameTypeAttributesDescription
hoursNumber<optional>

The hours for the utc offset

minutesNumber<optional>

The minutes in the utc offset

factorNumber<optional>

The factor for the utc-offset, either -1 or 1

Source

Members

factor :Number

The sign of the utc offset, 1 for positive offset, -1 for negative offsets.

Type:
  • Number
Source

hours :Number

The hours in the utc-offset

Type:
  • Number
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "utc-offset"
Source

minutes :Number

The minutes in the utc-offset

Type:
  • Number
Source

Methods

clone() → {ICAL.UtcOffset}

Returns a clone of the utc offset object.

Source
Returns:

The cloned object

Type: 
ICAL.UtcOffset

compare(other) → {Number}

Compare this utc offset with another one.

Parameters:
NameTypeDescription
otherICAL.UtcOffset

The other offset to compare with

Source
Returns:

-1, 0 or 1 for less/equal/greater

Type: 
Number

fromData(aData)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the utc offset

Properties
NameTypeAttributesDescription
hoursNumber<optional>

The hours for the utc offset

minutesNumber<optional>

The minutes in the utc offset

factorNumber<optional>

The factor for the utc-offset, either -1 or 1

Source

fromSeconds(aSeconds)

Sets up the current instance from the given seconds value. The seconds value is truncated to the minute. Offsets are wrapped when the world ends, the hour after UTC+14:00 is UTC-12:00.

Parameters:
NameTypeDescription
aSecondsNumber

The seconds to convert into an offset

Source

toICALString() → {String}

The iCalendar string representation of this utc-offset.

Source
Returns:
Type: 
String

toSeconds() → {Number}

Convert the current offset to a value in seconds

Source
Returns:

The offset in seconds

Type: 
Number

toString() → {String}

The string representation of this utc-offset.

Source
Returns:
Type: 
String

(static) fromSeconds(aSeconds)

Creates a new ICAL.UtcOffset instance from the passed seconds value.

Parameters:
NameTypeDescription
aSecondsNumber

The number of seconds to convert

Source

(static) fromString(aString) → {ICAL.Duration}

Creates a new ICAL.UtcOffset instance from the passed string.

Parameters:
NameTypeDescription
aStringString

The string to parse

Source
Returns:

The created utc-offset instance

Type: 
ICAL.Duration
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL. UtcOffset

This class represents the "utc-offset" value type, with various calculation and manipulation methods.

Constructor

new UtcOffset(aData)

Creates a new ICAL.UtcOffset instance.

Parameters:
NameTypeDescription
aDataObject

An object with members of the utc offset

Properties
NameTypeAttributesDescription
hoursNumber<optional>

The hours for the utc offset

minutesNumber<optional>

The minutes in the utc offset

factorNumber<optional>

The factor for the utc-offset, either -1 or 1

Source

Members

factor :Number

The sign of the utc offset, 1 for positive offset, -1 for negative offsets.

Type:
  • Number
Source

hours :Number

The hours in the utc-offset

Type:
  • Number
Source

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:
  • String
Default Value
  • "utc-offset"
Source

minutes :Number

The minutes in the utc-offset

Type:
  • Number
Source

Methods

clone() → {ICAL.UtcOffset}

Returns a clone of the utc offset object.

Source
Returns:

The cloned object

Type: 
ICAL.UtcOffset

compare(other) → {Number}

Compare this utc offset with another one.

Parameters:
NameTypeDescription
otherICAL.UtcOffset

The other offset to compare with

Source
Returns:

-1, 0 or 1 for less/equal/greater

Type: 
Number

fromData(aData)

Sets up the current instance using members from the passed data object.

Parameters:
NameTypeDescription
aDataObject

An object with members of the utc offset

Properties
NameTypeAttributesDescription
hoursNumber<optional>

The hours for the utc offset

minutesNumber<optional>

The minutes in the utc offset

factorNumber<optional>

The factor for the utc-offset, either -1 or 1

Source

fromSeconds(aSeconds)

Sets up the current instance from the given seconds value. The seconds value is truncated to the minute. Offsets are wrapped when the world ends, the hour after UTC+14:00 is UTC-12:00.

Parameters:
NameTypeDescription
aSecondsNumber

The seconds to convert into an offset

Source

toICALString() → {String}

The iCalendar string representation of this utc-offset.

Source
Returns:
Type: 
String

toSeconds() → {Number}

Convert the current offset to a value in seconds

Source
Returns:

The offset in seconds

Type: 
Number

toString() → {String}

The string representation of this utc-offset.

Source
Returns:
Type: 
String

(static) fromSeconds(aSeconds)

Creates a new ICAL.UtcOffset instance from the passed seconds value.

Parameters:
NameTypeDescription
aSecondsNumber

The number of seconds to convert

Source

(static) fromString(aString) → {ICAL.Duration}

Creates a new ICAL.UtcOffset instance from the passed string.

Parameters:
NameTypeDescription
aStringString

The string to parse

Source
Returns:

The created utc-offset instance

Type: 
ICAL.Duration
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.VCardTime.html b/api/ICAL.VCardTime.html index fb279e3c..90a13bc7 100644 --- a/api/ICAL.VCardTime.html +++ b/api/ICAL.VCardTime.html @@ -1,9 +1,9 @@ Class: VCardTime
On this page

ICAL. VCardTime

Describes a vCard time, which has slight differences to the ICAL.Time. Properties can be null if not specified, for example for dates with reduced accuracy or truncation.

Note that currently not all methods are correctly re-implemented for VCardTime. For example, comparison will have undefined results when some members are null.

Also, normalization is not yet implemented for this class!

Constructor

new VCardTime(data, zone, icaltype)

Creates a new ICAL.VCardTime instance.

Parameters:
NameTypeDescription
dataObject

The data for the time instance

Properties
NameTypeAttributesDescription
yearNumber<optional>

The year for this date

monthNumber<optional>

The month for this date

dayNumber<optional>

The day for this date

hourNumber<optional>

The hour for this date

minuteNumber<optional>

The minute for this date

secondNumber<optional>

The second for this date

zoneICAL.Timezone | ICAL.UtcOffset

The timezone to use

icaltypeString

The type for this date/time object

Source

Extends

Members

(constant) DEFAULT_WEEK_START

The default weekday for the WKST part.

Overrides
Default Value
  • ICAL.Time.MONDAY
Source

daysInYearPassedMonth :Array.<Array.<Number>>

The days that have passed in the year after a given month. The array has two members, one being an array of passed days for non-leap years, the other analog for leap years.

Type:
  • Array.<Array.<Number>>
Overrides
Source
Example
var isLeapYear = ICAL.Time.isLeapYear(year);
+    
On this page
ICAL. VCardTime
Describes a vCard time, which has slight differences to the ICAL.Time. Properties can be null if not specified, for example for dates with reduced accuracy or truncation.
Note that currently not all methods are correctly re-implemented for VCardTime. For example, comparison will have undefined results when some members are null.
Also, normalization is not yet implemented for this class!
Constructor
new VCardTime(data, zone, icaltype)
Creates a new ICAL.VCardTime instance.
Parameters:
NameTypeDescription
dataObject
The data for the time instance
Properties
NameTypeAttributesDescription
yearNumber<optional>
The year for this date
monthNumber<optional>
The month for this date
dayNumber<optional>
The day for this date
hourNumber<optional>
The hour for this date
minuteNumber<optional>
The minute for this date
secondNumber<optional>
The second for this date
zoneICAL.Timezone | ICAL.UtcOffset
The timezone to use
icaltypeString
The type for this date/time object
Source
Extends
Members
(constant) DEFAULT_WEEK_START
The default weekday for the WKST part.
Overrides
Default Value
  • ICAL.Time.MONDAY
Source
daysInYearPassedMonth :Array.<Array.<Number>>
The days that have passed in the year after a given month. The array has two members, one being an array of passed days for non-leap years, the other analog for leap years.
Type:
  • Array.<Array.<Number>>
Overrides
Source
Example
var isLeapYear = ICAL.Time.isLeapYear(year);
 var passedDays = ICAL.Time.daysInYearPassedMonth[isLeapYear][month];
(constant) epochTime :ICAL.Time
January 1st, 1970 as an ICAL.Time.
Type:
Overrides
Source
fromData
Creates a new ICAL.Time instance from the the passed data object.
Overrides
Source
(constant) icalclass :String
The class identifier.
Type:
  • String
Overrides
Default Value
  • "vcardtime"
Source
icaltype :String
The type name, to be used in the jCal object.
Type:
  • String
Overrides
Default Value
  • "date-and-or-time"
Source
zone :ICAL.Timezone
The timezone for this time.
Type:
Overrides
Source
Methods
addDuration(aDuration)
Adds the duration to the current time. The instance is modified in place.
Parameters:
NameTypeDescription
aDurationICAL.Duration
The duration to add
Overrides
Source
adjust(aExtraDays, aExtraHours, aExtraMinutes, aExtraSeconds, aTimeopt)
Adjust the date/time by the given offset
Parameters:
NameTypeAttributesDescription
aExtraDaysNumber
The extra amount of days
aExtraHoursNumber
The extra amount of hours
aExtraMinutesNumber
The extra amount of minutes
aExtraSecondsNumber
The extra amount of seconds
aTimeNumber<optional>
The time to adjust, defaults to the current instance.
Overrides
Source
clone() → {ICAL.VCardTime}
Returns a clone of the vcard date/time object.
Overrides
Source
Returns:
The cloned object
Type: 
ICAL.VCardTime
compare(aOther) → {Number}
Compares the ICAL.Time instance with another one.
Parameters:
NameTypeDescription
aOtherICAL.Duration
The instance to compare with
Overrides
Source
Returns:
-1, 0 or 1 for less/equal/greater
Type: 
Number
compareDateOnlyTz(other, tz) → {Number}
Compares only the date part of this instance with another one.
Parameters:
NameTypeDescription
otherICAL.Duration
The instance to compare with
tzICAL.Timezone
The timezone to compare in
Overrides
Source
Returns:
-1, 0 or 1 for less/equal/greater
Type: 
Number
convertToZone(zone) → {ICAL.Time}
Convert the instance into another timezone. The returned ICAL.Time instance is always a copy.
Parameters:
NameTypeDescription
zoneICAL.Timezone
The zone to convert to
Overrides
Source
Returns:
The copy, converted to the zone
Type: 
ICAL.Time
dayOfWeek(aWeekStartopt) → {ICAL.Time.weekDay}
Calculate the day of week.
Parameters:
NameTypeAttributesDescription
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Overrides
Source
Returns:
Type: 
ICAL.Time.weekDay
dayOfYear() → {Number}
Calculate the day of year.
Overrides
Source
Returns:
Type: 
Number
endOfMonth() → {ICAL.Time}
Returns a copy of the current date/time, shifted to the end of the month. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Overrides
Source
Returns:
The end of the month (cloned)
Type: 
ICAL.Time
endOfWeek(aWeekStartopt) → {ICAL.Time}
Returns a copy of the current date/time, shifted to the end of the week. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Parameters:
NameTypeAttributesDescription
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Overrides
Source
Returns:
The end of the week (cloned)
Type: 
ICAL.Time
endOfYear() → {ICAL.Time}
Returns a copy of the current date/time, shifted to the end of the year. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Overrides
Source
Returns:
The end of the year (cloned)
Type: 
ICAL.Time
fromJSDate(aDatenullable, useUTC)
Set up the current instance from the Javascript date value.
Parameters:
NameTypeAttributesDescription
aDateDate<nullable>
The Javascript Date to read, or null to reset
useUTCBoolean
If true, the UTC values of the date will be used
Overrides
Source
fromUnixTime(seconds)
Sets up the current instance from unix time, the number of seconds since January 1st, 1970.
Parameters:
NameTypeDescription
secondsNumber
The seconds to set up with
Overrides
Source
getDominicalLetter(yr) → {String}
Get the dominical letter for the current year. Letters range from A - G for common years, and AG to GF for leap years.
Parameters:
NameTypeDescription
yrNumber
The year to retrieve the letter for
Overrides
Source
Returns:
The dominical letter.
Type: 
String
isNthWeekDay(aDayOfWeek, aPos) → {Boolean}
Checks if current time is the nth weekday, relative to the current month. Will always return false when rule resolves outside of current month.
Parameters:
NameTypeDescription
aDayOfWeekICAL.Time.weekDay
Day of week to check
aPosNumber
Relative position
Overrides
Source
Returns:
True, if it is the nth weekday
Type: 
Boolean
nthWeekDay(aDayOfWeek, aPos) → {Number}
Finds the nthWeekDay relative to the current month (not day). The returned value is a day relative the month that this month belongs to so 1 would indicate the first of the month and 40 would indicate a day in the following month.
Parameters:
NameTypeDescription
aDayOfWeekNumber
Day of the week see the day name constants
aPosNumber
Nth occurrence of a given week day values of 1 and 0 both indicate the first weekday of that type. aPos may be either positive or negative
Overrides
Source
Returns:
numeric value indicating a day relative to the current month of this time object
Type: 
Number
reset()
Reset the time instance to epoch time
Overrides
Source
resetTo(year, month, day, hour, minute, second, timezone)
Reset the time instance to the given date/time values.
Parameters:
NameTypeDescription
yearNumber
The year to set
monthNumber
The month to set
dayNumber
The day to set
hourNumber
The hour to set
minuteNumber
The minute to set
secondNumber
The second to set
timezoneICAL.Timezone
The timezone to set
Overrides
Source
startDoyWeek(aFirstDayOfWeekopt) → {Number}
First calculates the start of the week, then returns the day of year for this date. If the day falls into the previous year, the day is zero or negative.
Parameters:
NameTypeAttributesDescription
aFirstDayOfWeekICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Overrides
Source
Returns:
The calculated day of year
Type: 
Number
startOfMonth() → {ICAL.Time}
Returns a copy of the current date/time, rewound to the start of the month. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Overrides
Source
Returns:
The start of the month (cloned)
Type: 
ICAL.Time
startOfWeek(aWeekStartopt) → {ICAL.Time}
Returns a copy of the current date/time, rewound to the start of the week. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Parameters:
NameTypeAttributesDescription
aWeekStartICAL.Time.weekDay<optional>
The week start weekday, defaults to SUNDAY
Overrides
Source
Returns:
The start of the week (cloned)
Type: 
ICAL.Time
startOfYear() → {ICAL.Time}
Returns a copy of the current date/time, rewound to the start of the year. The resulting ICAL.Time instance is of icaltype date, even if this is a date-time.
Overrides
Source
Returns:
The start of the year (cloned)
Type: 
ICAL.Time
subtractDate(aDate) → {ICAL.Duration}
Subtract the date details (excluding timezone). Useful for finding the relative difference between two time objects excluding their timezone differences.
Parameters:
NameTypeDescription
aDateICAL.Time
The date to subtract
Overrides
Source
Returns:
The difference as a duration
Type: 
ICAL.Duration
subtractDateTz(aDate) → {ICAL.Duration}
Subtract the date details, taking timezones into account.
Parameters:
NameTypeDescription
aDateICAL.Time
The date to subtract
Overrides
Source
Returns:
The difference in duration
Type: 
ICAL.Duration
toICALString() → {String}
Returns an RFC 6350 compliant representation of this object.
Overrides
Source
Returns:
vcard date/time string
Type: 
String
toJSDate() → {Date}
Converts the current instance to a Javascript date
Overrides
Source
Returns:
Type: 
Date
toJSON() → {Object}
Converts time to into Object which can be serialized then re-created using the constructor.
Overrides
Source
Returns:
Type: 
Object
Example
// toJSON will automatically be called
 var json = JSON.stringify(mytime);
 
 var deserialized = JSON.parse(json);
 
-var time = new ICAL.Time(deserialized);
toString() → {String}
The string representation of this date/time, in jCard form (including : and - separators).
Overrides
Source
Returns:
Type: 
String
toUnixTime() → {Number}
Converts the current instance to seconds since January 1st 1970.
Overrides
Source
Returns:
Seconds since 1970
Type: 
Number
utcOffset() → {Number}
Calculates the UTC offset of the current date/time in the timezone it is in.
Overrides
Source
Returns:
UTC offset in seconds
Type: 
Number
weekNumber(aWeekStart) → {Number}
Calculates the ISO 8601 week number. The first week of a year is the week that contains the first Thursday. The year can have 53 weeks, if January 1st is a Friday.
Note there are regions where the first week of the year is the one that starts on January 1st, which may offset the week number. Also, if a different week start is specified, this will also affect the week number.
Parameters:
NameTypeDescription
aWeekStartICAL.Time.weekDay
The weekday the week starts with
Overrides
Source
See
Returns:
The ISO week number
Type: 
Number
(static) fromDateAndOrTimeString(aValue, aIcalType) → {ICAL.VCardTime}
Returns a new ICAL.VCardTime instance from a date and/or time string.
Parameters:
NameTypeDescription
aValueString
The string to create from
aIcalTypeString
The type for this instance, e.g. date-and-or-time
Source
Returns:
The date/time instance
Type: 
ICAL.VCardTime

\ No newline at end of file
+var time = new ICAL.Time(deserialized);

toString() → {String}

The string representation of this date/time, in jCard form (including : and - separators).

Overrides
Source
Returns:
Type: 
String

toUnixTime() → {Number}

Converts the current instance to seconds since January 1st 1970.

Overrides
Source
Returns:

Seconds since 1970

Type: 
Number

utcOffset() → {Number}

Calculates the UTC offset of the current date/time in the timezone it is in.

Overrides
Source
Returns:

UTC offset in seconds

Type: 
Number

weekNumber(aWeekStart) → {Number}

Calculates the ISO 8601 week number. The first week of a year is the week that contains the first Thursday. The year can have 53 weeks, if January 1st is a Friday.

Note there are regions where the first week of the year is the one that starts on January 1st, which may offset the week number. Also, if a different week start is specified, this will also affect the week number.

Parameters:
NameTypeDescription
aWeekStartICAL.Time.weekDay

The weekday the week starts with

Overrides
Source
See
Returns:

The ISO week number

Type: 
Number

(static) fromDateAndOrTimeString(aValue, aIcalType) → {ICAL.VCardTime}

Returns a new ICAL.VCardTime instance from a date and/or time string.

Parameters:
NameTypeDescription
aValueString

The string to create from

aIcalTypeString

The type for this instance, e.g. date-and-or-time

Source
Returns:

The date/time instance

Type: 
ICAL.VCardTime
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.html b/api/ICAL.html index b030aa48..72def86d 100644 --- a/api/ICAL.html +++ b/api/ICAL.html @@ -1,3 +1,3 @@ Namespace: ICAL
On this page

ICAL

The main ICAL module. Provides access to everything else.

Properties
NameTypeDescription
designICAL.design
helpersICAL.helpers
Source

Classes

Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime

Methods

(static) parse(input) → {Object|Array.<Object>}

Parses iCalendar or vCard data into a raw jCal object. Consult documentation on the layers|layers of parsing for more details.

Parameters:
NameTypeDescription
inputString

The string data to parse

Source
To Do
  • Fix the API to be more clear on the return type
Returns:

A single jCal object, or an array thereof

Type: 
Object | Array.<Object>

(static) stringify(jCal) → {String}

Convert a full jCal/jCard array into a iCalendar/vCard string.

Parameters:
NameTypeDescription
jCalArray

The jCal/jCard document

Source
Returns:

The stringified iCalendar/vCard document

Type: 
String
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ICAL

The main ICAL module. Provides access to everything else.

Properties
NameTypeDescription
designICAL.design
helpersICAL.helpers
Source

Classes

Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime

Methods

(static) parse(input) → {Object|Array.<Object>}

Parses iCalendar or vCard data into a raw jCal object. Consult documentation on the layers|layers of parsing for more details.

Parameters:
NameTypeDescription
inputString

The string data to parse

Source
To Do
  • Fix the API to be more clear on the return type
Returns:

A single jCal object, or an array thereof

Type: 
Object | Array.<Object>

(static) stringify(jCal) → {String}

Convert a full jCal/jCard array into a iCalendar/vCard string.

Parameters:
NameTypeDescription
jCalArray

The jCal/jCard document

Source
Returns:

The stringified iCalendar/vCard document

Type: 
String
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.module_TimezoneService.html b/api/ICAL.module_TimezoneService.html index 5b3a7ff7..5ea6c39c 100644 --- a/api/ICAL.module_TimezoneService.html +++ b/api/ICAL.module_TimezoneService.html @@ -1,3 +1,3 @@ Module: TimezoneService
On this page
Source

Methods

(static) get(tzid) → (nullable) {ICAL.Timezone}

Returns a timezone by its tzid if present.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

The timezone, or null if not found

Type: 
ICAL.Timezone

(static) has(tzid) → {Boolean}

Checks if timezone id has been registered.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

False, when not present

Type: 
Boolean

(static) register(nameopt, zone)

Registers a timezone object or component.

Parameters:
NameTypeAttributesDescription
nameString<optional>

The name of the timezone. Defaults to the component's TZID if not passed.

zoneICAL.Component | ICAL.Timezone

The initialized zone or vtimezone.

Source

(static) remove(tzid) → (nullable) {ICAL.Timezone}

Removes a timezone by its tzid from the list.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

The removed timezone, or null if not registered

Type: 
ICAL.Timezone
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page
Source

Methods

(static) get(tzid) → (nullable) {ICAL.Timezone}

Returns a timezone by its tzid if present.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

The timezone, or null if not found

Type: 
ICAL.Timezone

(static) has(tzid) → {Boolean}

Checks if timezone id has been registered.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

False, when not present

Type: 
Boolean

(static) register(nameopt, zone)

Registers a timezone object or component.

Parameters:
NameTypeAttributesDescription
nameString<optional>

The name of the timezone. Defaults to the component's TZID if not passed.

zoneICAL.Component | ICAL.Timezone

The initialized zone or vtimezone.

Source

(static) remove(tzid) → (nullable) {ICAL.Timezone}

Removes a timezone by its tzid from the list.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Source
Returns:

The removed timezone, or null if not registered

Type: 
ICAL.Timezone
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.module_design.html b/api/ICAL.module_design.html index bf48db27..2749b151 100644 --- a/api/ICAL.module_design.html +++ b/api/ICAL.module_design.html @@ -1,6 +1,6 @@ Module: design
On this page
Source

Members

(static) components :Object

Holds the design set for known top-level components

Type:
  • Object
Properties
NameTypeDescription
vcardICAL.design.designSet

vCard VCARD

veventICAL.design.designSet

iCalendar VEVENT

vtodoICAL.design.designSet

iCalendar VTODO

vjournalICAL.design.designSet

iCalendar VJOURNAL

valarmICAL.design.designSet

iCalendar VALARM

vtimezoneICAL.design.designSet

iCalendar VTIMEZONE

daylightICAL.design.designSet

iCalendar DAYLIGHT

standardICAL.design.designSet

iCalendar STANDARD

Source
Example
let propertyName = 'fn';
+    
On this page
Source
Members
(static) components :Object
Holds the design set for known top-level components
Type:
  • Object
Properties
NameTypeDescription
vcardICAL.design.designSet
vCard VCARD
veventICAL.design.designSet
iCalendar VEVENT
vtodoICAL.design.designSet
iCalendar VTODO
vjournalICAL.design.designSet
iCalendar VJOURNAL
valarmICAL.design.designSet
iCalendar VALARM
vtimezoneICAL.design.designSet
iCalendar VTIMEZONE
daylightICAL.design.designSet
iCalendar DAYLIGHT
standardICAL.design.designSet
iCalendar STANDARD
Source
Example
let propertyName = 'fn';
 let componentDesign = ICAL.design.components.vcard;
 let propertyDetails = componentDesign.property[propertyName];
 if (propertyDetails.defaultType == 'text') {
@@ -10,4 +10,4 @@
 let propertyDetails = componentDesign.property[propertyName];
 if (propertyDetails.defaultType == 'text') {
   // Yep, sure is...
-}
(static) defaultSet :ICAL.design.designSet
The default set for new properties and components if none is specified.
Type:
Source
(static) defaultType :String
The default type for unknown properties
Type:
  • String
Source
(static) icalendar :ICAL.design.designSet
The design set for iCalendar (rfc5545/rfc7265) components.
Type:
Source
(static) strict
Can be set to false to make the parser more lenient.
Source
(static) vcard :ICAL.design.designSet
The design set for vCard (rfc6350/rfc7095) components.
Type:
Source
(static) vcard3 :ICAL.design.designSet
The design set for vCard (rfc2425/rfc2426/rfc7095) components.
Type:
Source
(inner) icalSet :ICAL.design.designSet
iCalendar design set
Type:
Source
(inner) vcard3Set :ICAL.design.designSet
vCard 3.0 design set
Type:
Source
(inner) vcardSet :ICAL.design.designSet
vCard 4.0 design set
Type:
Source
Methods
(static) getDesignSet(componentName) → {ICAL.design.designSet}
Gets the design set for the given component name.
Parameters:
NameTypeDescription
componentNameString
The name of the component
Source
Returns:
The design set for the component
Type: 
ICAL.design.designSet

\ No newline at end of file
+}

(static) defaultSet :ICAL.design.designSet

The default set for new properties and components if none is specified.

Type:
Source

(static) defaultType :String

The default type for unknown properties

Type:
  • String
Source

(static) icalendar :ICAL.design.designSet

The design set for iCalendar (rfc5545/rfc7265) components.

Type:
Source

(static) strict

Can be set to false to make the parser more lenient.

Source

(static) vcard :ICAL.design.designSet

The design set for vCard (rfc6350/rfc7095) components.

Type:
Source

(static) vcard3 :ICAL.design.designSet

The design set for vCard (rfc2425/rfc2426/rfc7095) components.

Type:
Source

(inner) icalSet :ICAL.design.designSet

iCalendar design set

Type:
Source

(inner) vcard3Set :ICAL.design.designSet

vCard 3.0 design set

Type:
Source

(inner) vcardSet :ICAL.design.designSet

vCard 4.0 design set

Type:
Source

Methods

(static) getDesignSet(componentName) → {ICAL.design.designSet}

Gets the design set for the given component name.

Parameters:
NameTypeDescription
componentNameString

The name of the component

Source
Returns:

The design set for the component

Type: 
ICAL.design.designSet
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.module_helpers.html b/api/ICAL.module_helpers.html index 98ab4597..48d6e04c 100644 --- a/api/ICAL.module_helpers.html +++ b/api/ICAL.module_helpers.html @@ -1,6 +1,6 @@ Module: helpers
On this page

Helper functions used in various places within ical.js

Source

Methods

(static) binsearchInsert(list, seekVal, cmpfunc) → {Number}

Find the index for insertion using binary search.

Parameters:
NameTypeDescription
listArray

The list to search

seekVal?

The value to insert

cmpfuncfunction

The comparison func, that can compare two seekVals

Source
Returns:

The insert position

Type: 
Number

(static) clone(aSrc, aDeepopt) → {*}

Clone the passed object or primitive. By default a shallow clone will be executed.

Parameters:
NameTypeAttributesDescription
aSrc*

The thing to clone

aDeepBoolean<optional>

If true, a deep clone will be performed

Source
Returns:

The copy of the thing

Type: 
*

(static) extend(source, target) → {Object}

Poor-man's cross-browser object extension. Doesn't support all the features, but enough for our usage. Note that the target's properties are not overwritten with the source properties.

Parameters:
NameTypeDescription
sourceObject

The object to extend

targetObject

The object to extend with

Source
Returns:

Returns the target.

Type: 
Object
Example
var child = ICAL.helpers.extend(parent, {
+    
On this page
Helper functions used in various places within ical.js
Source
Methods
(static) binsearchInsert(list, seekVal, cmpfunc) → {Number}
Find the index for insertion using binary search.
Parameters:
NameTypeDescription
listArray
The list to search
seekVal?
The value to insert
cmpfuncfunction
The comparison func, that can compare two seekVals
Source
Returns:
The insert position
Type: 
Number
(static) clone(aSrc, aDeepopt) → {*}
Clone the passed object or primitive. By default a shallow clone will be executed.
Parameters:
NameTypeAttributesDescription
aSrc*
The thing to clone
aDeepBoolean<optional>
If true, a deep clone will be performed
Source
Returns:
The copy of the thing
Type: 
*
(static) extend(source, target) → {Object}
Poor-man's cross-browser object extension. Doesn't support all the features, but enough for our usage. Note that the target's properties are not overwritten with the source properties.
Parameters:
NameTypeDescription
sourceObject
The object to extend
targetObject
The object to extend with
Source
Returns:
Returns the target.
Type: 
Object
Example
var child = ICAL.helpers.extend(parent, {
   "bar": 123
 });
(static) foldline(aLine) → {String}
Performs iCalendar line folding. A line ending character is inserted and the next line begins with a whitespace.
Parameters:
NameTypeDescription
aLineString
The line to fold
Source
Returns:
The folded line
Type: 
String
Example
SUMMARY:This line will be fold
  ed right in the middle of a word.
(static) formatClassType(data, type) → {?}
Creates or returns a class instance of a given type with the initialization data if the data is not already an instance of the given type.
Parameters:
NameTypeDescription
dataObject
object initialization data
typeObject
object type (like ICAL.Time)
Source
Returns:
An instance of the found type.
Type: 
?
Example
var time = new ICAL.Time(...);
@@ -11,4 +11,4 @@
 
 result = ICAL.helpers.formatClassType({}, ICAL.Time);
 (result isntanceof ICAL.Time)
-// => true
(static) isStrictlyNaN(number) → {Boolean}
Checks if the given type is of the number type and also NaN.
Parameters:
NameTypeDescription
numberNumber
The number to check
Source
Returns:
True, if the number is strictly NaN
Type: 
Boolean
(static) pad2(data) → {String}
Pads the given string or number with zeros so it will have at least two characters.
Parameters:
NameTypeDescription
dataString | Number
The string or number to pad
Source
Returns:
The number padded as a string
Type: 
String
(static) strictParseInt(string) → {Number}
Parses a string value that is expected to be an integer, when the valid is not an integer throws a decoration error.
Parameters:
NameTypeDescription
stringString
Raw string input
Source
Returns:
Parsed integer
Type: 
Number
(static) trunc(number) → {Number}
Truncates the given number, correctly handling negative numbers.
Parameters:
NameTypeDescription
numberNumber
The number to truncate
Source
Returns:
The truncated number
Type: 
Number
(static) unescapedIndexOf(buffer, search, pos) → {Number}
Identical to indexOf but will only match values when they are not preceded by a backslash character.
Parameters:
NameTypeDescription
bufferString
String to search
searchString
Value to look for
posNumber
Start position
Source
Returns:
The position, or -1 if not found
Type: 
Number
(static) updateTimezones(vcal) → {ICAL.Component}
Compiles a list of all referenced TZIDs in all subcomponents and removes any extra VTIMEZONE subcomponents. In addition, if any TZIDs are referenced by a component, but a VTIMEZONE does not exist, an attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.
Parameters:
NameTypeDescription
vcalICAL.Component
The top-level VCALENDAR component.
Source
Returns:
The ICAL.Component that was passed in.
Type: 
ICAL.Component

\ No newline at end of file
+// => true

(static) isStrictlyNaN(number) → {Boolean}

Checks if the given type is of the number type and also NaN.

Parameters:
NameTypeDescription
numberNumber

The number to check

Source
Returns:

True, if the number is strictly NaN

Type: 
Boolean

(static) pad2(data) → {String}

Pads the given string or number with zeros so it will have at least two characters.

Parameters:
NameTypeDescription
dataString | Number

The string or number to pad

Source
Returns:

The number padded as a string

Type: 
String

(static) strictParseInt(string) → {Number}

Parses a string value that is expected to be an integer, when the valid is not an integer throws a decoration error.

Parameters:
NameTypeDescription
stringString

Raw string input

Source
Returns:

Parsed integer

Type: 
Number

(static) trunc(number) → {Number}

Truncates the given number, correctly handling negative numbers.

Parameters:
NameTypeDescription
numberNumber

The number to truncate

Source
Returns:

The truncated number

Type: 
Number

(static) unescapedIndexOf(buffer, search, pos) → {Number}

Identical to indexOf but will only match values when they are not preceded by a backslash character.

Parameters:
NameTypeDescription
bufferString

String to search

searchString

Value to look for

posNumber

Start position

Source
Returns:

The position, or -1 if not found

Type: 
Number

(static) updateTimezones(vcal) → {ICAL.Component}

Compiles a list of all referenced TZIDs in all subcomponents and removes any extra VTIMEZONE subcomponents. In addition, if any TZIDs are referenced by a component, but a VTIMEZONE does not exist, an attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.

Parameters:
NameTypeDescription
vcalICAL.Component

The top-level VCALENDAR component.

Source
Returns:

The ICAL.Component that was passed in.

Type: 
ICAL.Component
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/ICAL.parse.ParserError.html b/api/ICAL.parse.ParserError.html index 8e356328..49fba71c 100644 --- a/api/ICAL.parse.ParserError.html +++ b/api/ICAL.parse.ParserError.html @@ -1,3 +1,3 @@ Class: ParserError
On this page

ParserError

An error that occurred during parsing.

Constructor

new ParserError(message)

Parameters:
NameTypeDescription
messageString

The error message

Source

Extends

  • Error
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
ICAL
\ No newline at end of file +
On this page

ParserError

An error that occurred during parsing.

Constructor

new ParserError(message)

Parameters:
NameTypeDescription
messageString

The error message

Source

Extends

  • Error
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/InvalidRecurrenceRuleError.html b/api/InvalidRecurrenceRuleError.html new file mode 100644 index 00000000..fc80c5bf --- /dev/null +++ b/api/InvalidRecurrenceRuleError.html @@ -0,0 +1,3 @@ +Class: InvalidRecurrenceRuleError
On this page

InvalidRecurrenceRuleError

An error indicating that a recurrence rule is invalid and produces no occurrences.

Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/binary.js.html b/api/binary.js.html index 981192a6..089b8acc 100644 --- a/api/binary.js.html +++ b/api/binary.js.html @@ -1,6 +1,6 @@ Source: binary.js
On this page

binary.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
binary.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -174,4 +174,4 @@
   }
 }
 export default Binary;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/component.js.html b/api/component.js.html index 530e5eea..a5a98111 100644 --- a/api/component.js.html +++ b/api/component.js.html @@ -1,6 +1,6 @@ Source: component.js
On this page

component.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
component.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -566,4 +566,4 @@
   }
 }
 export default Component;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/component_parser.js.html b/api/component_parser.js.html index 7304d23e..9f8827e4 100644 --- a/api/component_parser.js.html +++ b/api/component_parser.js.html @@ -1,6 +1,6 @@ Source: component_parser.js
On this page

component_parser.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
component_parser.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -158,4 +158,4 @@
   }
 }
 export default ComponentParser;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/data/search.json b/api/data/search.json index a0cc9bc3..59435aad 100644 --- a/api/data/search.json +++ b/api/data/search.json @@ -1 +1 @@ -{"list":[{"title":"ICAL","link":"ICAL","description":"

The main ICAL module. Provides access to everything else.

"},{"title":"ICAL.Binary","link":"Binary","description":"

Creates a new ICAL.Binary instance

"},{"title":"ICAL.Binary#decodeValue","link":"decodeValue","description":"

Base64 decode the current value

"},{"title":"ICAL.Binary#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Binary#setEncodedValue","link":"setEncodedValue","description":"

Encodes the passed parameter with base64 and sets the internal\nvalue to the result.

"},{"title":"ICAL.Binary#toString","link":"toString","description":"

The string representation of this value

"},{"title":"ICAL.Binary.fromString","link":"fromString","description":"

Creates a binary value from the given string.

"},{"title":"ICAL.Component","link":"Component","description":"

Creates a new ICAL.Component instance.

"},{"title":"ICAL.Component#addProperty","link":"addProperty","description":"

Adds an {@link ICAL.Property} to the component.

"},{"title":"ICAL.Component#addPropertyWithValue","link":"addPropertyWithValue","description":"

Helper method to add a property with a value to the component.

"},{"title":"ICAL.Component#addSubcomponent","link":"addSubcomponent","description":"

Adds a single sub component.

"},{"title":"ICAL.Component#getAllProperties","link":"getAllProperties","description":"

Get all properties in the component, optionally filtered by name.

"},{"title":"ICAL.Component#getAllSubcomponents","link":"getAllSubcomponents","description":"

Finds all sub components, optionally filtering by name.

"},{"title":"ICAL.Component#getFirstProperty","link":"getFirstProperty","description":"

Finds the first property, optionally with the given name.

"},{"title":"ICAL.Component#getFirstPropertyValue","link":"getFirstPropertyValue","description":"

Returns first property's value, if available.

"},{"title":"ICAL.Component#getFirstSubcomponent","link":"getFirstSubcomponent","description":"

Finds first sub component, optionally filtered by name.

"},{"title":"ICAL.Component#getTimeZoneByID","link":"getTimeZoneByID","description":"

Retrieve a time zone definition from the component tree, if any is present.\nIf the tree contains no time zone definitions or the TZID cannot be\nmatched, returns null.

"},{"title":"ICAL.Component#hasProperty","link":"hasProperty","description":"

Returns true when a named property exists.

"},{"title":"ICAL.Component#name","link":"name","description":"

The name of this component

"},{"title":"ICAL.Component#removeAllProperties","link":"removeAllProperties","description":"

Removes all properties associated with this component, optionally\nfiltered by name.

"},{"title":"ICAL.Component#removeAllSubcomponents","link":"removeAllSubcomponents","description":"

Removes all components or (if given) all components by a particular\nname.

"},{"title":"ICAL.Component#removeProperty","link":"removeProperty","description":"

Removes a single property by name or the instance of the specific\nproperty.

"},{"title":"ICAL.Component#removeSubcomponent","link":"removeSubcomponent","description":"

Removes a single component by name or the instance of a specific\ncomponent.

"},{"title":"ICAL.Component#toJSON","link":"toJSON","description":"

Returns the Object representation of this component. The returned object\nis a live jCal object and should be cloned if modified.

"},{"title":"ICAL.Component#toString","link":"toString","description":"

The string representation of this component.

"},{"title":"ICAL.Component#updatePropertyWithValue","link":"updatePropertyWithValue","description":"

Helper method that will update or create a property of the given name\nand sets its value. If multiple properties with the given name exist,\nonly the first is updated.

"},{"title":"ICAL.Component.fromString","link":"fromString","description":"

Create an {@link ICAL.Component} by parsing the passed iCalendar string.

"},{"title":"ICAL.ComponentParser","link":"ComponentParser","description":"

Creates a new ICAL.ComponentParser instance.

"},{"title":"ICAL.ComponentParser#oncomplete","link":"oncomplete","description":"

Fired when parsing is complete

"},{"title":"ICAL.ComponentParser#onerror","link":"onerror","description":"

Fired if an error occurs during parsing.

"},{"title":"ICAL.ComponentParser#onevent","link":"onevent","description":"

Fired when a top level component (VEVENT) is found.

"},{"title":"ICAL.ComponentParser#ontimezone","link":"ontimezone","description":"

Fired when a top level component (VTIMEZONE) is found

"},{"title":"ICAL.ComponentParser#parseEvent","link":"parseEvent","description":"

When true, parse events

"},{"title":"ICAL.ComponentParser#parseTimezone","link":"parseTimezone","description":"

When true, parse timezones

"},{"title":"ICAL.ComponentParser#process","link":"process","description":"

Process a string or parse ical object. This function itself will return\nnothing but will start the parsing process.

\n

Events must be registered prior to calling this method.

"},{"title":"ICAL.Duration","link":"Duration","description":"

Creates a new ICAL.Duration instance.

"},{"title":"ICAL.Duration#clone","link":"clone","description":"

Returns a clone of the duration object.

"},{"title":"ICAL.Duration#compare","link":"compare","description":"

Compares the duration instance with another one.

"},{"title":"ICAL.Duration#days","link":"days","description":"

The days in this duration

"},{"title":"ICAL.Duration#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Duration#fromSeconds","link":"fromSeconds","description":"

Reads the passed seconds value into this duration object. Afterwards,\nmembers like {@link ICAL.Duration#days days} and {@link ICAL.Duration#weeks weeks} will be set up\naccordingly.

"},{"title":"ICAL.Duration#hours","link":"hours","description":"

The days in this duration

"},{"title":"ICAL.Duration#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Duration#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Duration#isNegative","link":"isNegative","description":"

The seconds in this duration

"},{"title":"ICAL.Duration#minutes","link":"minutes","description":"

The minutes in this duration

"},{"title":"ICAL.Duration#normalize","link":"normalize","description":"

Normalizes the duration instance. For example, a duration with a value\nof 61 seconds will be normalized to 1 minute and 1 second.

"},{"title":"ICAL.Duration#reset","link":"reset","description":"

Resets the duration instance to the default values, i.e. PT0S

"},{"title":"ICAL.Duration#seconds","link":"seconds","description":"

The seconds in this duration

"},{"title":"ICAL.Duration#toICALString","link":"toICALString","description":"

The iCalendar string representation of this duration.

"},{"title":"ICAL.Duration#toSeconds","link":"toSeconds","description":"

The duration value expressed as a number of seconds.

"},{"title":"ICAL.Duration#toString","link":"toString","description":"

The string representation of this duration.

"},{"title":"ICAL.Duration#weeks","link":"weeks","description":"

The weeks in this duration

"},{"title":"ICAL.Duration.fromData","link":"fromData","description":"

Creates a new ICAL.Duration instance from the given data object.

"},{"title":"ICAL.Duration.fromSeconds","link":"fromSeconds","description":"

Returns a new ICAL.Duration instance from the passed seconds value.

"},{"title":"ICAL.Duration.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Duration} instance from the passed string.

"},{"title":"ICAL.Duration.isValueString","link":"isValueString","description":"

Checks if the given string is an iCalendar duration value.

"},{"title":"ICAL.Event","link":"Event","description":"

Creates a new ICAL.Event instance.

"},{"title":"ICAL.Event#attendees","link":"attendees","description":"

The attendees in the event

"},{"title":"ICAL.Event#color","link":"color","description":"

The event color from rfc7986

"},{"title":"ICAL.Event#description","link":"description","description":"

The event description.

"},{"title":"ICAL.Event#duration","link":"duration","description":"

The duration. This can be the result directly from the property, or the\nduration calculated from start date and end date. Setting the property\nwill remove any dtend properties.

"},{"title":"ICAL.Event#endDate","link":"endDate","description":"

The end date. This can be the result directly from the property, or the\nend date calculated from start date and duration. Setting the property\nwill remove any duration properties.

"},{"title":"ICAL.Event#exceptions","link":"exceptions","description":"

List of related event exceptions.

"},{"title":"ICAL.Event#findRangeException","link":"findRangeException","description":"

Finds the range exception nearest to the given date.

"},{"title":"ICAL.Event#getOccurrenceDetails","link":"getOccurrenceDetails","description":"

Returns the occurrence details based on its start time. If the\noccurrence has an exception will return the details for that exception.

\n

NOTE: this method is intend to be used in conjunction\nwith the {@link ICAL.Event#iterator iterator} method.

"},{"title":"ICAL.Event#getRecurrenceTypes","link":"getRecurrenceTypes","description":"

Returns the types of recurrences this event may have.

\n

Returned as an object with the following possible keys:

\n"},{"title":"ICAL.Event#isRecurrenceException","link":"isRecurrenceException","description":"

Checks if the event describes a recurrence exception. See\n{@tutorial terminology} for details.

"},{"title":"ICAL.Event#isRecurring","link":"isRecurring","description":"

Checks if the event is recurring

"},{"title":"ICAL.Event#iterator","link":"iterator","description":"

Builds a recur expansion instance for a specific point in time (defaults\nto startDate).

"},{"title":"ICAL.Event#location","link":"location","description":"

The location of the event.

"},{"title":"ICAL.Event#modifiesFuture","link":"modifiesFuture","description":"

Checks if this record is an exception and has the RANGE=THISANDFUTURE\nvalue.

"},{"title":"ICAL.Event#organizer","link":"organizer","description":"

The organizer value as an uri. In most cases this is a mailto: uri, but\nit can also be something else, like urn:uuid:...

"},{"title":"ICAL.Event#recurrenceId","link":"recurrenceId","description":"

The recurrence id for this event. See {@tutorial terminology} for details.

"},{"title":"ICAL.Event#relateException","link":"relateException","description":"

Relates a given event exception to this object. If the given component\ndoes not share the UID of this event it cannot be related and will throw\nan exception.

\n

If this component is an exception it cannot have other exceptions\nrelated to it.

"},{"title":"ICAL.Event#sequence","link":"sequence","description":"

The sequence value for this event. Used for scheduling\nsee {@tutorial terminology}.

"},{"title":"ICAL.Event#startDate","link":"startDate","description":"

The start date

"},{"title":"ICAL.Event#strictExceptions","link":"strictExceptions","description":"

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

"},{"title":"ICAL.Event#summary","link":"summary","description":"

The event summary

"},{"title":"ICAL.Event#toString","link":"toString","description":"

The string representation of this event.

"},{"title":"ICAL.Event#uid","link":"uid","description":"

The uid of this event

"},{"title":"ICAL.Event.occurrenceDetails","link":"occurrenceDetails","description":"

This object is returned by {@link ICAL.Event#getOccurrenceDetails getOccurrenceDetails}

"},{"title":"ICAL.Period","link":"Period","description":"

Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and\na duration.

"},{"title":"ICAL.Period#clone","link":"clone","description":"

Returns a clone of the duration object.

"},{"title":"ICAL.Period#duration","link":"duration","description":"

The duration of the period

"},{"title":"ICAL.Period#end","link":"end","description":"

The end of the period

"},{"title":"ICAL.Period#getDuration","link":"getDuration","description":"

Calculates the duration of the period, either directly or by subtracting\nstart from end date.

"},{"title":"ICAL.Period#getEnd","link":"getEnd","description":"

Calculates the end date of the period, either directly or by adding\nduration to start date.

"},{"title":"ICAL.Period#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Period#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Period#start","link":"start","description":"

The start of the period

"},{"title":"ICAL.Period#toICALString","link":"toICALString","description":"

The iCalendar string representation of this period.

"},{"title":"ICAL.Period#toJSON","link":"toJSON","description":"

The jCal representation of this period type.

"},{"title":"ICAL.Period#toString","link":"toString","description":"

The string representation of this period.

"},{"title":"ICAL.Period.fromData","link":"fromData","description":"

Creates a new {@link ICAL.Period} instance from the given data object.\nThe passed data object cannot contain both and end date and a duration.

"},{"title":"ICAL.Period.fromJSON","link":"fromJSON","description":"

Returns a new period instance from the given jCal data array. The first\nmember is always the start date string, the second member is either a\nduration or end date string.

"},{"title":"ICAL.Period.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Period} instance from the passed string.

"},{"title":"ICAL.Property","link":"Property","description":"

Creates a new ICAL.Property instance.

\n

It is important to note that mutations done in the wrapper directly mutate the jCal object used\nto initialize.

\n

Can also be used to create new properties by passing the name of the property (as a String).

"},{"title":"ICAL.Property#getDefaultType","link":"getDefaultType","description":"

Get the default type based on this property's name.

"},{"title":"ICAL.Property#getFirstParameter","link":"getFirstParameter","description":"

Gets first parameter on the property.

"},{"title":"ICAL.Property#getFirstValue","link":"getFirstValue","description":"

Finds the first property value.

"},{"title":"ICAL.Property#getParameter","link":"getParameter","description":"

Gets a parameter on the property.

"},{"title":"ICAL.Property#getValues","link":"getValues","description":"

Gets all values on the property.

\n

NOTE: this creates an array during each call.

"},{"title":"ICAL.Property#name","link":"name","description":"

The name of this property, in lowercase.

"},{"title":"ICAL.Property#parent","link":"parent","description":"

The parent component for this property.

"},{"title":"ICAL.Property#removeAllValues","link":"removeAllValues","description":"

Removes all values from this property

"},{"title":"ICAL.Property#removeParameter","link":"removeParameter","description":"

Removes a parameter

"},{"title":"ICAL.Property#resetType","link":"resetType","description":"

Sets type of property and clears out any existing values of the current\ntype.

"},{"title":"ICAL.Property#setParameter","link":"setParameter","description":"

Sets a parameter on the property.

"},{"title":"ICAL.Property#setValue","link":"setValue","description":"

Sets the current value of the property. If this is a multi-value\nproperty, all other values will be removed.

"},{"title":"ICAL.Property#setValues","link":"setValues","description":"

Sets the values of the property. Will overwrite the existing values.\nThis can only be used for multi-value properties.

"},{"title":"ICAL.Property#toICALString","link":"toICALString","description":"

The string representation of this component.

"},{"title":"ICAL.Property#toJSON","link":"toJSON","description":"

Returns the Object representation of this component. The returned object\nis a live jCal object and should be cloned if modified.

"},{"title":"ICAL.Property#type","link":"type","description":"

The value type for this property

"},{"title":"ICAL.Property.fromString","link":"fromString","description":"

Create an {@link ICAL.Property} by parsing the passed iCalendar string.

"},{"title":"ICAL.Recur","link":"Recur","description":"

Create a new instance of the Recur class.

"},{"title":"ICAL.Recur#addComponent","link":"addComponent","description":"

Adds a component (part) to the recurrence rule. This is not a component\nin the sense of {@link ICAL.Component}, but a part of the recurrence\nrule, i.e. BYMONTH.

"},{"title":"ICAL.Recur#clone","link":"clone","description":"

Returns a clone of the recurrence object.

"},{"title":"ICAL.Recur#count","link":"count","description":"

The maximum number of occurrences

"},{"title":"ICAL.Recur#freq","link":"freq","description":"

The frequency value.

"},{"title":"ICAL.Recur#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Recur#getComponent","link":"getComponent","description":"

Gets (a copy) of the requested component value.

"},{"title":"ICAL.Recur#getNextOccurrence","link":"getNextOccurrence","description":"

Retrieves the next occurrence after the given recurrence id. See the\nguide on {@tutorial terminology} for more details.

\n

NOTE: Currently, this method iterates all occurrences from the start\ndate. It should not be called in a loop for performance reasons. If you\nwould like to get more than one occurrence, you can iterate the\noccurrences manually, see the example on the\n{@link ICAL.Recur#iterator iterator} method.

"},{"title":"ICAL.Recur#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Recur#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Recur#interval","link":"interval","description":"

The interval value for the recurrence rule.

"},{"title":"ICAL.Recur#isByCount","link":"isByCount","description":"

Checks if the current rule has a count part, and not limited by an until\npart.

"},{"title":"ICAL.Recur#isFinite","link":"isFinite","description":"

Checks if the current rule is finite, i.e. has a count or until part.

"},{"title":"ICAL.Recur#iterator","link":"iterator","description":"

Create a new iterator for this recurrence rule. The passed start date\nmust be the start date of the event, not the start of the range to\nsearch in.

"},{"title":"ICAL.Recur#parts","link":"parts","description":"

An object holding the BY-parts of the recurrence rule

"},{"title":"ICAL.Recur#setComponent","link":"setComponent","description":"

Sets the component value for the given by-part.

"},{"title":"ICAL.Recur#toJSON","link":"toJSON","description":"

The jCal representation of this recurrence type.

"},{"title":"ICAL.Recur#toString","link":"toString","description":"

The string representation of this recurrence rule.

"},{"title":"ICAL.Recur#until","link":"until","description":"

The end of the recurrence

"},{"title":"ICAL.Recur#wkst","link":"wkst","description":"

The week start day

"},{"title":"ICAL.Recur.frequencyValues","link":"frequencyValues","description":"

Possible frequency values for the FREQ part\n(YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)

"},{"title":"ICAL.Recur.fromData","link":"fromData","description":"

Creates a new {@link ICAL.Recur} instance using members from the passed\ndata object.

"},{"title":"ICAL.Recur.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Recur} instance from the passed string.

"},{"title":"ICAL.Recur.icalDayToNumericDay","link":"icalDayToNumericDay","description":"

Convert an ical representation of a day (SU, MO, etc..)\ninto a numeric value of that day.

"},{"title":"ICAL.Recur.numericDayToIcalDay","link":"numericDayToIcalDay","description":"

Convert a numeric day value into its ical representation (SU, MO, etc..)

"},{"title":"ICAL.RecurExpansion","link":"RecurExpansion","description":"

Creates a new ICAL.RecurExpansion instance.

\n

The options object can be filled with the specified initial values. It can also contain\nadditional members, as a result of serializing a previous expansion state, as shown in the\nexample.

"},{"title":"ICAL.RecurExpansion#complete","link":"complete","description":"

True when iteration is fully completed.

"},{"title":"ICAL.RecurExpansion#dtstart","link":"dtstart","description":"

Start date of recurring rules.

"},{"title":"ICAL.RecurExpansion#fromData","link":"fromData","description":"

Initialize the recurrence expansion from the data object. The options\nobject may also contain additional members, see the\n{@link ICAL.RecurExpansion constructor} for more details.

"},{"title":"ICAL.RecurExpansion#last","link":"last","description":"

Last expanded time

"},{"title":"ICAL.RecurExpansion#next","link":"next","description":"

Retrieve the next occurrence in the series.

"},{"title":"ICAL.RecurExpansion#toJSON","link":"toJSON","description":"

Converts object into a serialize-able format. This format can be passed\nback into the expansion to resume iteration.

"},{"title":"ICAL.RecurIterator","link":"RecurIterator","description":"

Creates a new ICAL.RecurIterator instance. The options object may contain additional members\nwhen resuming iteration from a previous run.

"},{"title":"ICAL.RecurIterator#completed","link":"completed","description":"

True when iteration is finished.

"},{"title":"ICAL.RecurIterator#dtstart","link":"dtstart","description":"

The start date of the event being iterated.

"},{"title":"ICAL.RecurIterator#fromData","link":"fromData","description":"

Initialize the recurrence iterator from the passed data object. This\nmethod is usually not called directly, you can initialize the iterator\nthrough the constructor.

"},{"title":"ICAL.RecurIterator#last","link":"last","description":"

The last occurrence that was returned from the\n{@link ICAL.RecurIterator#next} method.

"},{"title":"ICAL.RecurIterator#last.year","link":"year","description":"

The normalization horrors below are due to\nthe fact that when the year/month/day changes\nit can effect the other operations that come after.

"},{"title":"ICAL.RecurIterator#next","link":"next","description":"

Retrieve the next occurrence from the iterator.

"},{"title":"ICAL.RecurIterator#occurrence_number","link":"occurrence_number","description":"

The sequence number from the occurrence

"},{"title":"ICAL.RecurIterator#rule","link":"rule","description":"

The rule that is being iterated

"},{"title":"ICAL.RecurIterator#ruleDayOfWeek","link":"ruleDayOfWeek"},{"title":"ICAL.RecurIterator#toJSON","link":"toJSON","description":"

Convert iterator into a serialize-able object. Will preserve current\niteration sequence to ensure the seamless continuation of the recurrence\nrule.

"},{"title":"ICAL.Time","link":"Time","description":"

Creates a new ICAL.Time instance.

"},{"title":"ICAL.Time#DEFAULT_WEEK_START","link":"DEFAULT_WEEK_START","description":"

The default weekday for the WKST part.

"},{"title":"ICAL.Time#addDuration","link":"addDuration","description":"

Adds the duration to the current time. The instance is modified in\nplace.

"},{"title":"ICAL.Time#adjust","link":"adjust","description":"

Adjust the date/time by the given offset

"},{"title":"ICAL.Time#clone","link":"clone","description":"

Returns a clone of the time object.

"},{"title":"ICAL.Time#compare","link":"compare","description":"

Compares the ICAL.Time instance with another one.

"},{"title":"ICAL.Time#compareDateOnlyTz","link":"compareDateOnlyTz","description":"

Compares only the date part of this instance with another one.

"},{"title":"ICAL.Time#convertToZone","link":"convertToZone","description":"

Convert the instance into another timezone. The returned ICAL.Time\ninstance is always a copy.

"},{"title":"ICAL.Time#dayOfWeek","link":"dayOfWeek","description":"

Calculate the day of week.

"},{"title":"ICAL.Time#dayOfYear","link":"dayOfYear","description":"

Calculate the day of year.

"},{"title":"ICAL.Time#daysInYearPassedMonth","link":"daysInYearPassedMonth","description":"

The days that have passed in the year after a given month. The array has\ntwo members, one being an array of passed days for non-leap years, the\nother analog for leap years.

"},{"title":"ICAL.Time#endOfMonth","link":"endOfMonth","description":"

Returns a copy of the current date/time, shifted to the end of the\nmonth. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#endOfWeek","link":"endOfWeek","description":"

Returns a copy of the current date/time, shifted to the end of the week.\nThe resulting ICAL.Time instance is of icaltype date, even if this is a\ndate-time.

"},{"title":"ICAL.Time#endOfYear","link":"endOfYear","description":"

Returns a copy of the current date/time, shifted to the end of the\nyear. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#epochTime","link":"epochTime","description":"

January 1st, 1970 as an ICAL.Time.

"},{"title":"ICAL.Time#fromData","link":"fromData","description":"

Creates a new ICAL.Time instance from the the passed data object.

"},{"title":"ICAL.Time#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Time#fromJSDate","link":"fromJSDate","description":"

Set up the current instance from the Javascript date value.

"},{"title":"ICAL.Time#fromUnixTime","link":"fromUnixTime","description":"

Sets up the current instance from unix time, the number of seconds since\nJanuary 1st, 1970.

"},{"title":"ICAL.Time#getDominicalLetter","link":"getDominicalLetter","description":"

Get the dominical letter for the current year. Letters range from A - G\nfor common years, and AG to GF for leap years.

"},{"title":"ICAL.Time#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Time#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object. This value may change and\nis strictly defined by the {@link ICAL.Time#isDate isDate} member.

"},{"title":"ICAL.Time#isNthWeekDay","link":"isNthWeekDay","description":"

Checks if current time is the nth weekday, relative to the current\nmonth. Will always return false when rule resolves outside of current\nmonth.

"},{"title":"ICAL.Time#nthWeekDay","link":"nthWeekDay","description":"

Finds the nthWeekDay relative to the current month (not day). The\nreturned value is a day relative the month that this month belongs to so\n1 would indicate the first of the month and 40 would indicate a day in\nthe following month.

"},{"title":"ICAL.Time#reset","link":"reset","description":"

Reset the time instance to epoch time

"},{"title":"ICAL.Time#resetTo","link":"resetTo","description":"

Reset the time instance to the given date/time values.

"},{"title":"ICAL.Time#startDoyWeek","link":"startDoyWeek","description":"

First calculates the start of the week, then returns the day of year for\nthis date. If the day falls into the previous year, the day is zero or negative.

"},{"title":"ICAL.Time#startOfMonth","link":"startOfMonth","description":"

Returns a copy of the current date/time, rewound to the start of the\nmonth. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#startOfWeek","link":"startOfWeek","description":"

Returns a copy of the current date/time, rewound to the start of the\nweek. The resulting ICAL.Time instance is of icaltype date, even if this\nis a date-time.

"},{"title":"ICAL.Time#startOfYear","link":"startOfYear","description":"

Returns a copy of the current date/time, rewound to the start of the\nyear. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#subtractDate","link":"subtractDate","description":"

Subtract the date details (excluding timezone). Useful for finding\nthe relative difference between two time objects excluding their\ntimezone differences.

"},{"title":"ICAL.Time#subtractDateTz","link":"subtractDateTz","description":"

Subtract the date details, taking timezones into account.

"},{"title":"ICAL.Time#toICALString","link":"toICALString","description":"

Returns an RFC 5545 compliant ical representation of this object.

"},{"title":"ICAL.Time#toJSDate","link":"toJSDate","description":"

Converts the current instance to a Javascript date

"},{"title":"ICAL.Time#toJSON","link":"toJSON","description":"

Converts time to into Object which can be serialized then re-created\nusing the constructor.

"},{"title":"ICAL.Time#toString","link":"toString","description":"

The string representation of this date/time, in jCal form\n(including : and - separators).

"},{"title":"ICAL.Time#toUnixTime","link":"toUnixTime","description":"

Converts the current instance to seconds since January 1st 1970.

"},{"title":"ICAL.Time#utcOffset","link":"utcOffset","description":"

Calculates the UTC offset of the current date/time in the timezone it is\nin.

"},{"title":"ICAL.Time#weekNumber","link":"weekNumber","description":"

Calculates the ISO 8601 week number. The first week of a year is the\nweek that contains the first Thursday. The year can have 53 weeks, if\nJanuary 1st is a Friday.

\n

Note there are regions where the first week of the year is the one that\nstarts on January 1st, which may offset the week number. Also, if a\ndifferent week start is specified, this will also affect the week\nnumber.

"},{"title":"ICAL.Time#zone","link":"zone","description":"

The timezone for this time.

"},{"title":"ICAL.Time.daysInMonth","link":"daysInMonth","description":"

Returns the days in the given month

"},{"title":"ICAL.Time.fromDateString","link":"fromDateString","description":"

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

"},{"title":"ICAL.Time.fromDateTimeString","link":"fromDateTimeString","description":"

Returns a new ICAL.Time instance from a date-time string, e.g\n2015-01-02T03:04:05. If a property is specified, the timezone is set up\nfrom the property's TZID parameter.

"},{"title":"ICAL.Time.fromDayOfYear","link":"fromDayOfYear","description":"

Create a new ICAL.Time from the day of year and year. The date is returned\nin floating timezone.

"},{"title":"ICAL.Time.fromJSDate","link":"fromJSDate","description":"

Creates a new ICAL.Time instance from the given Javascript Date.

"},{"title":"ICAL.Time.fromString","link":"fromString","description":"

Returns a new ICAL.Time instance from a date or date-time string,

"},{"title":"ICAL.Time.fromStringv2","link":"fromStringv2","description":"

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

"},{"title":"ICAL.Time.getDominicalLetter","link":"getDominicalLetter","description":"

Get the dominical letter for the given year. Letters range from A - G for\ncommon years, and AG to GF for leap years.

"},{"title":"ICAL.Time.isLeapYear","link":"isLeapYear","description":"

Checks if the year is a leap year

"},{"title":"ICAL.Time.now","link":"now","description":"

Creates a new ICAL.Time instance from the current moment.\nThe instance is “floating” - has no timezone relation.\nTo create an instance considering the time zone, call\nICAL.Time.fromJSDate(new Date(), true)

"},{"title":"ICAL.Time.weekDay","link":"weekDay","description":"

The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via\nICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...

"},{"title":"ICAL.Time.weekOneStarts","link":"weekOneStarts","description":"

Returns the date on which ISO week number 1 starts.

"},{"title":"ICAL.Timezone","link":"Timezone","description":"

Creates a new ICAL.Timezone instance, by passing in a tzid and component.

"},{"title":"ICAL.Timezone#component","link":"component","description":"

The vtimezone component for this timezone.

"},{"title":"ICAL.Timezone#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Timezone#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Timezone#latitude","link":"latitude","description":"

The primary latitude for the timezone.

"},{"title":"ICAL.Timezone#location","link":"location","description":"

Timezone location

"},{"title":"ICAL.Timezone#longitude","link":"longitude","description":"

The primary longitude for the timezone.

"},{"title":"ICAL.Timezone#toString","link":"toString","description":"

The string representation of this timezone.

"},{"title":"ICAL.Timezone#tzid","link":"tzid","description":"

Timezone identifier

"},{"title":"ICAL.Timezone#tznames","link":"tznames","description":"

Alternative timezone name, for the string representation

"},{"title":"ICAL.Timezone#utcOffset","link":"utcOffset","description":"

Finds the utcOffset the given time would occur in this timezone.

"},{"title":"ICAL.Timezone.convert_time","link":"convert_time","description":"

Convert the date/time from one zone to the next.

"},{"title":"ICAL.Timezone.fromData","link":"fromData","description":"

Creates a new ICAL.Timezone instance from the passed data object.

"},{"title":"ICAL.UtcOffset","link":"UtcOffset","description":"

Creates a new ICAL.UtcOffset instance.

"},{"title":"ICAL.UtcOffset#clone","link":"clone","description":"

Returns a clone of the utc offset object.

"},{"title":"ICAL.UtcOffset#compare","link":"compare","description":"

Compare this utc offset with another one.

"},{"title":"ICAL.UtcOffset#factor","link":"factor","description":"

The sign of the utc offset, 1 for positive offset, -1 for negative\noffsets.

"},{"title":"ICAL.UtcOffset#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.UtcOffset#fromSeconds","link":"fromSeconds","description":"

Sets up the current instance from the given seconds value. The seconds\nvalue is truncated to the minute. Offsets are wrapped when the world\nends, the hour after UTC+14:00 is UTC-12:00.

"},{"title":"ICAL.UtcOffset#hours","link":"hours","description":"

The hours in the utc-offset

"},{"title":"ICAL.UtcOffset#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.UtcOffset#minutes","link":"minutes","description":"

The minutes in the utc-offset

"},{"title":"ICAL.UtcOffset#toICALString","link":"toICALString","description":"

The iCalendar string representation of this utc-offset.

"},{"title":"ICAL.UtcOffset#toSeconds","link":"toSeconds","description":"

Convert the current offset to a value in seconds

"},{"title":"ICAL.UtcOffset#toString","link":"toString","description":"

The string representation of this utc-offset.

"},{"title":"ICAL.UtcOffset.fromSeconds","link":"fromSeconds","description":"

Creates a new {@link ICAL.UtcOffset} instance from the passed seconds\nvalue.

"},{"title":"ICAL.UtcOffset.fromString","link":"fromString","description":"

Creates a new {@link ICAL.UtcOffset} instance from the passed string.

"},{"title":"ICAL.VCardTime","link":"VCardTime","description":"

Creates a new ICAL.VCardTime instance.

"},{"title":"ICAL.VCardTime#clone","link":"clone","description":"

Returns a clone of the vcard date/time object.

"},{"title":"ICAL.VCardTime#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.VCardTime#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.VCardTime#toICALString","link":"toICALString","description":"

Returns an RFC 6350 compliant representation of this object.

"},{"title":"ICAL.VCardTime#toString","link":"toString","description":"

The string representation of this date/time, in jCard form\n(including : and - separators).

"},{"title":"ICAL.VCardTime.fromDateAndOrTimeString","link":"fromDateAndOrTimeString","description":"

Returns a new ICAL.VCardTime instance from a date and/or time string.

"},{"title":"ICAL.design.designSet","link":"designSet","description":"

A designSet describes value, parameter and property data. It is used by\nther parser and stringifier in components and properties to determine they\nshould be represented.

"},{"title":"ICAL.module:TimezoneService","link":"TimezoneService"},{"title":"ICAL.module:TimezoneService.get","link":"get","description":"

Returns a timezone by its tzid if present.

"},{"title":"ICAL.module:TimezoneService.has","link":"has","description":"

Checks if timezone id has been registered.

"},{"title":"ICAL.module:TimezoneService.register","link":"register","description":"

Registers a timezone object or component.

"},{"title":"ICAL.module:TimezoneService.remove","link":"remove","description":"

Removes a timezone by its tzid from the list.

"},{"title":"ICAL.module:design","link":"design"},{"title":"ICAL.module:design","link":"design","description":"

The design data, used by the parser to determine types for properties and\nother metadata needed to produce correct jCard/jCal data.

"},{"title":"ICAL.module:design.components","link":"components","description":"

Holds the design set for known top-level components

"},{"title":"ICAL.module:design.defaultSet","link":"defaultSet","description":"

The default set for new properties and components if none is specified.

"},{"title":"ICAL.module:design.defaultType","link":"defaultType","description":"

The default type for unknown properties

"},{"title":"ICAL.module:design.getDesignSet","link":"getDesignSet","description":"

Gets the design set for the given component name.

"},{"title":"ICAL.module:design.icalendar","link":"icalendar","description":"

The design set for iCalendar (rfc5545/rfc7265) components.

"},{"title":"ICAL.module:design.strict","link":"strict","description":"

Can be set to false to make the parser more lenient.

"},{"title":"ICAL.module:design.vcard","link":"vcard","description":"

The design set for vCard (rfc6350/rfc7095) components.

"},{"title":"ICAL.module:design.vcard3","link":"vcard3","description":"

The design set for vCard (rfc2425/rfc2426/rfc7095) components.

"},{"title":"ICAL.module:design~date.undecorate","link":"undecorate","description":"

undecorates a time object.

"},{"title":"ICAL.module:design~icalSet","link":"icalSet","description":"

iCalendar design set

"},{"title":"ICAL.module:design~vcard3Set","link":"vcard3Set","description":"

vCard 3.0 design set

"},{"title":"ICAL.module:design~vcardSet","link":"vcardSet","description":"

vCard 4.0 design set

"},{"title":"ICAL.module:helpers","link":"helpers","description":"

Helper functions used in various places within ical.js

"},{"title":"ICAL.module:helpers.binsearchInsert","link":"binsearchInsert","description":"

Find the index for insertion using binary search.

"},{"title":"ICAL.module:helpers.clone","link":"clone","description":"

Clone the passed object or primitive. By default a shallow clone will be\nexecuted.

"},{"title":"ICAL.module:helpers.extend","link":"extend","description":"

Poor-man's cross-browser object extension. Doesn't support all the\nfeatures, but enough for our usage. Note that the target's properties are\nnot overwritten with the source properties.

"},{"title":"ICAL.module:helpers.foldline","link":"foldline","description":"

Performs iCalendar line folding. A line ending character is inserted and\nthe next line begins with a whitespace.

"},{"title":"ICAL.module:helpers.formatClassType","link":"formatClassType","description":"

Creates or returns a class instance of a given type with the initialization\ndata if the data is not already an instance of the given type.

"},{"title":"ICAL.module:helpers.isStrictlyNaN","link":"isStrictlyNaN","description":"

Checks if the given type is of the number type and also NaN.

"},{"title":"ICAL.module:helpers.pad2","link":"pad2","description":"

Pads the given string or number with zeros so it will have at least two\ncharacters.

"},{"title":"ICAL.module:helpers.strictParseInt","link":"strictParseInt","description":"

Parses a string value that is expected to be an integer, when the valid is\nnot an integer throws a decoration error.

"},{"title":"ICAL.module:helpers.trunc","link":"trunc","description":"

Truncates the given number, correctly handling negative numbers.

"},{"title":"ICAL.module:helpers.unescapedIndexOf","link":"unescapedIndexOf","description":"

Identical to indexOf but will only match values when they are not preceded\nby a backslash character.

"},{"title":"ICAL.module:helpers.updateTimezones","link":"updateTimezones","description":"

Compiles a list of all referenced TZIDs in all subcomponents and\nremoves any extra VTIMEZONE subcomponents. In addition, if any TZIDs\nare referenced by a component, but a VTIMEZONE does not exist,\nan attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.

"},{"title":"ICAL.parse(function)","link":"parse","description":"

Parses iCalendar or vCard data into a raw jCal object. Consult\ndocumentation on the {@tutorial layers|layers of parsing} for more\ndetails.

"},{"title":"ICAL.parse.ParserError","link":"ParserError"},{"title":"ICAL.parse._rfc6868Escape","link":"_rfc6868Escape","description":"

Internal helper for rfc6868. Exposing this on ICAL.parse so that\nhackers can disable the rfc6868 parsing if the really need to.

"},{"title":"ICAL.parse.component","link":"component","description":"

Convenience method to parse a component. You can use ICAL.parse() directly\ninstead.

"},{"title":"ICAL.parse.property","link":"property","description":"

Parse an iCalendar property value into the jCal for a single property

"},{"title":"ICAL.stringify(function)","link":"stringify","description":"

Convert a full jCal/jCard array into a iCalendar/vCard string.

"},{"title":"ICAL.stringify.component","link":"component","description":"

Converts an jCal component array into a ICAL string.\nRecursive will resolve sub-components.

\n

Exact component/property order is not saved all\nproperties will come before subcomponents.

"},{"title":"ICAL.stringify.multiValue","link":"multiValue","description":"

Converts an array of ical values into a single\nstring based on a type and a delimiter value (like ",").

"},{"title":"ICAL.stringify.paramPropertyValue","link":"paramPropertyValue","description":"

Handles escaping of property values that may contain:

\n

COLON (:), SEMICOLON (;), or COMMA (,)

\n

If any of the above are present the result is wrapped\nin double quotes.

"},{"title":"ICAL.stringify.property","link":"property","description":"

Converts a single jCal/jCard property to a iCalendar/vCard string.

"},{"title":"ICAL.stringify.value","link":"value","description":"

Processes a single ical value runs the associated "toICAL" method from the\ndesign value type if available to convert the value.

"},{"title":"module.exports.foldLength","link":"foldLength","description":"

The number of characters before iCalendar line folding should occur

"},{"title":"module.exports.newLineChar","link":"newLineChar","description":"

The character(s) to be used for a newline. The default value is provided by\nrfc5545.

"},{"title":"parse._handleContentLine~result","link":"result","description":"

Note on var result juggling:

\n

I observed that building the array in pieces has adverse\neffects on performance, so where possible we inline the creation.\nIt is a little ugly but resulted in ~2000 additional ops/sec.

"},{"title":"stringify._rfc6868Unescape","link":"_rfc6868Unescape","description":"

Internal helper for rfc6868. Exposing this on ICAL.stringify so that\nhackers can disable the rfc6868 parsing if the really need to.

"}]} \ No newline at end of file +{"list":[{"title":"ICAL","link":"ICAL","description":"

The main ICAL module. Provides access to everything else.

"},{"title":"ICAL.Binary","link":"Binary","description":"

Creates a new ICAL.Binary instance

"},{"title":"ICAL.Binary#decodeValue","link":"decodeValue","description":"

Base64 decode the current value

"},{"title":"ICAL.Binary#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Binary#setEncodedValue","link":"setEncodedValue","description":"

Encodes the passed parameter with base64 and sets the internal\nvalue to the result.

"},{"title":"ICAL.Binary#toString","link":"toString","description":"

The string representation of this value

"},{"title":"ICAL.Binary.fromString","link":"fromString","description":"

Creates a binary value from the given string.

"},{"title":"ICAL.Component","link":"Component","description":"

Creates a new ICAL.Component instance.

"},{"title":"ICAL.Component#addProperty","link":"addProperty","description":"

Adds an {@link ICAL.Property} to the component.

"},{"title":"ICAL.Component#addPropertyWithValue","link":"addPropertyWithValue","description":"

Helper method to add a property with a value to the component.

"},{"title":"ICAL.Component#addSubcomponent","link":"addSubcomponent","description":"

Adds a single sub component.

"},{"title":"ICAL.Component#getAllProperties","link":"getAllProperties","description":"

Get all properties in the component, optionally filtered by name.

"},{"title":"ICAL.Component#getAllSubcomponents","link":"getAllSubcomponents","description":"

Finds all sub components, optionally filtering by name.

"},{"title":"ICAL.Component#getFirstProperty","link":"getFirstProperty","description":"

Finds the first property, optionally with the given name.

"},{"title":"ICAL.Component#getFirstPropertyValue","link":"getFirstPropertyValue","description":"

Returns first property's value, if available.

"},{"title":"ICAL.Component#getFirstSubcomponent","link":"getFirstSubcomponent","description":"

Finds first sub component, optionally filtered by name.

"},{"title":"ICAL.Component#getTimeZoneByID","link":"getTimeZoneByID","description":"

Retrieve a time zone definition from the component tree, if any is present.\nIf the tree contains no time zone definitions or the TZID cannot be\nmatched, returns null.

"},{"title":"ICAL.Component#hasProperty","link":"hasProperty","description":"

Returns true when a named property exists.

"},{"title":"ICAL.Component#name","link":"name","description":"

The name of this component

"},{"title":"ICAL.Component#removeAllProperties","link":"removeAllProperties","description":"

Removes all properties associated with this component, optionally\nfiltered by name.

"},{"title":"ICAL.Component#removeAllSubcomponents","link":"removeAllSubcomponents","description":"

Removes all components or (if given) all components by a particular\nname.

"},{"title":"ICAL.Component#removeProperty","link":"removeProperty","description":"

Removes a single property by name or the instance of the specific\nproperty.

"},{"title":"ICAL.Component#removeSubcomponent","link":"removeSubcomponent","description":"

Removes a single component by name or the instance of a specific\ncomponent.

"},{"title":"ICAL.Component#toJSON","link":"toJSON","description":"

Returns the Object representation of this component. The returned object\nis a live jCal object and should be cloned if modified.

"},{"title":"ICAL.Component#toString","link":"toString","description":"

The string representation of this component.

"},{"title":"ICAL.Component#updatePropertyWithValue","link":"updatePropertyWithValue","description":"

Helper method that will update or create a property of the given name\nand sets its value. If multiple properties with the given name exist,\nonly the first is updated.

"},{"title":"ICAL.Component.fromString","link":"fromString","description":"

Create an {@link ICAL.Component} by parsing the passed iCalendar string.

"},{"title":"ICAL.ComponentParser","link":"ComponentParser","description":"

Creates a new ICAL.ComponentParser instance.

"},{"title":"ICAL.ComponentParser#oncomplete","link":"oncomplete","description":"

Fired when parsing is complete

"},{"title":"ICAL.ComponentParser#onerror","link":"onerror","description":"

Fired if an error occurs during parsing.

"},{"title":"ICAL.ComponentParser#onevent","link":"onevent","description":"

Fired when a top level component (VEVENT) is found.

"},{"title":"ICAL.ComponentParser#ontimezone","link":"ontimezone","description":"

Fired when a top level component (VTIMEZONE) is found

"},{"title":"ICAL.ComponentParser#parseEvent","link":"parseEvent","description":"

When true, parse events

"},{"title":"ICAL.ComponentParser#parseTimezone","link":"parseTimezone","description":"

When true, parse timezones

"},{"title":"ICAL.ComponentParser#process","link":"process","description":"

Process a string or parse ical object. This function itself will return\nnothing but will start the parsing process.

\n

Events must be registered prior to calling this method.

"},{"title":"ICAL.Duration","link":"Duration","description":"

Creates a new ICAL.Duration instance.

"},{"title":"ICAL.Duration#clone","link":"clone","description":"

Returns a clone of the duration object.

"},{"title":"ICAL.Duration#compare","link":"compare","description":"

Compares the duration instance with another one.

"},{"title":"ICAL.Duration#days","link":"days","description":"

The days in this duration

"},{"title":"ICAL.Duration#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Duration#fromSeconds","link":"fromSeconds","description":"

Reads the passed seconds value into this duration object. Afterwards,\nmembers like {@link ICAL.Duration#days days} and {@link ICAL.Duration#weeks weeks} will be set up\naccordingly.

"},{"title":"ICAL.Duration#hours","link":"hours","description":"

The days in this duration

"},{"title":"ICAL.Duration#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Duration#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Duration#isNegative","link":"isNegative","description":"

The seconds in this duration

"},{"title":"ICAL.Duration#minutes","link":"minutes","description":"

The minutes in this duration

"},{"title":"ICAL.Duration#normalize","link":"normalize","description":"

Normalizes the duration instance. For example, a duration with a value\nof 61 seconds will be normalized to 1 minute and 1 second.

"},{"title":"ICAL.Duration#reset","link":"reset","description":"

Resets the duration instance to the default values, i.e. PT0S

"},{"title":"ICAL.Duration#seconds","link":"seconds","description":"

The seconds in this duration

"},{"title":"ICAL.Duration#toICALString","link":"toICALString","description":"

The iCalendar string representation of this duration.

"},{"title":"ICAL.Duration#toSeconds","link":"toSeconds","description":"

The duration value expressed as a number of seconds.

"},{"title":"ICAL.Duration#toString","link":"toString","description":"

The string representation of this duration.

"},{"title":"ICAL.Duration#weeks","link":"weeks","description":"

The weeks in this duration

"},{"title":"ICAL.Duration.fromData","link":"fromData","description":"

Creates a new ICAL.Duration instance from the given data object.

"},{"title":"ICAL.Duration.fromSeconds","link":"fromSeconds","description":"

Returns a new ICAL.Duration instance from the passed seconds value.

"},{"title":"ICAL.Duration.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Duration} instance from the passed string.

"},{"title":"ICAL.Duration.isValueString","link":"isValueString","description":"

Checks if the given string is an iCalendar duration value.

"},{"title":"ICAL.Event","link":"Event","description":"

Creates a new ICAL.Event instance.

"},{"title":"ICAL.Event#attendees","link":"attendees","description":"

The attendees in the event

"},{"title":"ICAL.Event#color","link":"color","description":"

The event color from rfc7986

"},{"title":"ICAL.Event#description","link":"description","description":"

The event description.

"},{"title":"ICAL.Event#duration","link":"duration","description":"

The duration. This can be the result directly from the property, or the\nduration calculated from start date and end date. Setting the property\nwill remove any dtend properties.

"},{"title":"ICAL.Event#endDate","link":"endDate","description":"

The end date. This can be the result directly from the property, or the\nend date calculated from start date and duration. Setting the property\nwill remove any duration properties.

"},{"title":"ICAL.Event#exceptions","link":"exceptions","description":"

List of related event exceptions.

"},{"title":"ICAL.Event#findRangeException","link":"findRangeException","description":"

Finds the range exception nearest to the given date.

"},{"title":"ICAL.Event#getOccurrenceDetails","link":"getOccurrenceDetails","description":"

Returns the occurrence details based on its start time. If the\noccurrence has an exception will return the details for that exception.

\n

NOTE: this method is intend to be used in conjunction\nwith the {@link ICAL.Event#iterator iterator} method.

"},{"title":"ICAL.Event#getRecurrenceTypes","link":"getRecurrenceTypes","description":"

Returns the types of recurrences this event may have.

\n

Returned as an object with the following possible keys:

\n"},{"title":"ICAL.Event#isRecurrenceException","link":"isRecurrenceException","description":"

Checks if the event describes a recurrence exception. See\n{@tutorial terminology} for details.

"},{"title":"ICAL.Event#isRecurring","link":"isRecurring","description":"

Checks if the event is recurring

"},{"title":"ICAL.Event#iterator","link":"iterator","description":"

Builds a recur expansion instance for a specific point in time (defaults\nto startDate).

"},{"title":"ICAL.Event#location","link":"location","description":"

The location of the event.

"},{"title":"ICAL.Event#modifiesFuture","link":"modifiesFuture","description":"

Checks if this record is an exception and has the RANGE=THISANDFUTURE\nvalue.

"},{"title":"ICAL.Event#organizer","link":"organizer","description":"

The organizer value as an uri. In most cases this is a mailto: uri, but\nit can also be something else, like urn:uuid:...

"},{"title":"ICAL.Event#recurrenceId","link":"recurrenceId","description":"

The recurrence id for this event. See {@tutorial terminology} for details.

"},{"title":"ICAL.Event#relateException","link":"relateException","description":"

Relates a given event exception to this object. If the given component\ndoes not share the UID of this event it cannot be related and will throw\nan exception.

\n

If this component is an exception it cannot have other exceptions\nrelated to it.

"},{"title":"ICAL.Event#sequence","link":"sequence","description":"

The sequence value for this event. Used for scheduling\nsee {@tutorial terminology}.

"},{"title":"ICAL.Event#startDate","link":"startDate","description":"

The start date

"},{"title":"ICAL.Event#strictExceptions","link":"strictExceptions","description":"

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

"},{"title":"ICAL.Event#summary","link":"summary","description":"

The event summary

"},{"title":"ICAL.Event#toString","link":"toString","description":"

The string representation of this event.

"},{"title":"ICAL.Event#uid","link":"uid","description":"

The uid of this event

"},{"title":"ICAL.Event.occurrenceDetails","link":"occurrenceDetails","description":"

This object is returned by {@link ICAL.Event#getOccurrenceDetails getOccurrenceDetails}

"},{"title":"ICAL.Period","link":"Period","description":"

Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and\na duration.

"},{"title":"ICAL.Period#clone","link":"clone","description":"

Returns a clone of the duration object.

"},{"title":"ICAL.Period#duration","link":"duration","description":"

The duration of the period

"},{"title":"ICAL.Period#end","link":"end","description":"

The end of the period

"},{"title":"ICAL.Period#getDuration","link":"getDuration","description":"

Calculates the duration of the period, either directly or by subtracting\nstart from end date.

"},{"title":"ICAL.Period#getEnd","link":"getEnd","description":"

Calculates the end date of the period, either directly or by adding\nduration to start date.

"},{"title":"ICAL.Period#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Period#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Period#start","link":"start","description":"

The start of the period

"},{"title":"ICAL.Period#toICALString","link":"toICALString","description":"

The iCalendar string representation of this period.

"},{"title":"ICAL.Period#toJSON","link":"toJSON","description":"

The jCal representation of this period type.

"},{"title":"ICAL.Period#toString","link":"toString","description":"

The string representation of this period.

"},{"title":"ICAL.Period.fromData","link":"fromData","description":"

Creates a new {@link ICAL.Period} instance from the given data object.\nThe passed data object cannot contain both and end date and a duration.

"},{"title":"ICAL.Period.fromJSON","link":"fromJSON","description":"

Returns a new period instance from the given jCal data array. The first\nmember is always the start date string, the second member is either a\nduration or end date string.

"},{"title":"ICAL.Period.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Period} instance from the passed string.

"},{"title":"ICAL.Property","link":"Property","description":"

Creates a new ICAL.Property instance.

\n

It is important to note that mutations done in the wrapper directly mutate the jCal object used\nto initialize.

\n

Can also be used to create new properties by passing the name of the property (as a String).

"},{"title":"ICAL.Property#getDefaultType","link":"getDefaultType","description":"

Get the default type based on this property's name.

"},{"title":"ICAL.Property#getFirstParameter","link":"getFirstParameter","description":"

Gets first parameter on the property.

"},{"title":"ICAL.Property#getFirstValue","link":"getFirstValue","description":"

Finds the first property value.

"},{"title":"ICAL.Property#getParameter","link":"getParameter","description":"

Gets a parameter on the property.

"},{"title":"ICAL.Property#getValues","link":"getValues","description":"

Gets all values on the property.

\n

NOTE: this creates an array during each call.

"},{"title":"ICAL.Property#name","link":"name","description":"

The name of this property, in lowercase.

"},{"title":"ICAL.Property#parent","link":"parent","description":"

The parent component for this property.

"},{"title":"ICAL.Property#removeAllValues","link":"removeAllValues","description":"

Removes all values from this property

"},{"title":"ICAL.Property#removeParameter","link":"removeParameter","description":"

Removes a parameter

"},{"title":"ICAL.Property#resetType","link":"resetType","description":"

Sets type of property and clears out any existing values of the current\ntype.

"},{"title":"ICAL.Property#setParameter","link":"setParameter","description":"

Sets a parameter on the property.

"},{"title":"ICAL.Property#setValue","link":"setValue","description":"

Sets the current value of the property. If this is a multi-value\nproperty, all other values will be removed.

"},{"title":"ICAL.Property#setValues","link":"setValues","description":"

Sets the values of the property. Will overwrite the existing values.\nThis can only be used for multi-value properties.

"},{"title":"ICAL.Property#toICALString","link":"toICALString","description":"

The string representation of this component.

"},{"title":"ICAL.Property#toJSON","link":"toJSON","description":"

Returns the Object representation of this component. The returned object\nis a live jCal object and should be cloned if modified.

"},{"title":"ICAL.Property#type","link":"type","description":"

The value type for this property

"},{"title":"ICAL.Property.fromString","link":"fromString","description":"

Create an {@link ICAL.Property} by parsing the passed iCalendar string.

"},{"title":"ICAL.Recur","link":"Recur","description":"

Create a new instance of the Recur class.

"},{"title":"ICAL.Recur#addComponent","link":"addComponent","description":"

Adds a component (part) to the recurrence rule. This is not a component\nin the sense of {@link ICAL.Component}, but a part of the recurrence\nrule, i.e. BYMONTH.

"},{"title":"ICAL.Recur#clone","link":"clone","description":"

Returns a clone of the recurrence object.

"},{"title":"ICAL.Recur#count","link":"count","description":"

The maximum number of occurrences

"},{"title":"ICAL.Recur#freq","link":"freq","description":"

The frequency value.

"},{"title":"ICAL.Recur#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Recur#getComponent","link":"getComponent","description":"

Gets (a copy) of the requested component value.

"},{"title":"ICAL.Recur#getNextOccurrence","link":"getNextOccurrence","description":"

Retrieves the next occurrence after the given recurrence id. See the\nguide on {@tutorial terminology} for more details.

\n

NOTE: Currently, this method iterates all occurrences from the start\ndate. It should not be called in a loop for performance reasons. If you\nwould like to get more than one occurrence, you can iterate the\noccurrences manually, see the example on the\n{@link ICAL.Recur#iterator iterator} method.

"},{"title":"ICAL.Recur#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Recur#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.Recur#interval","link":"interval","description":"

The interval value for the recurrence rule.

"},{"title":"ICAL.Recur#isByCount","link":"isByCount","description":"

Checks if the current rule has a count part, and not limited by an until\npart.

"},{"title":"ICAL.Recur#isFinite","link":"isFinite","description":"

Checks if the current rule is finite, i.e. has a count or until part.

"},{"title":"ICAL.Recur#iterator","link":"iterator","description":"

Create a new iterator for this recurrence rule. The passed start date\nmust be the start date of the event, not the start of the range to\nsearch in.

"},{"title":"ICAL.Recur#parts","link":"parts","description":"

An object holding the BY-parts of the recurrence rule

"},{"title":"ICAL.Recur#setComponent","link":"setComponent","description":"

Sets the component value for the given by-part.

"},{"title":"ICAL.Recur#toJSON","link":"toJSON","description":"

The jCal representation of this recurrence type.

"},{"title":"ICAL.Recur#toString","link":"toString","description":"

The string representation of this recurrence rule.

"},{"title":"ICAL.Recur#until","link":"until","description":"

The end of the recurrence

"},{"title":"ICAL.Recur#wkst","link":"wkst","description":"

The week start day

"},{"title":"ICAL.Recur.frequencyValues","link":"frequencyValues","description":"

Possible frequency values for the FREQ part\n(YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)

"},{"title":"ICAL.Recur.fromData","link":"fromData","description":"

Creates a new {@link ICAL.Recur} instance using members from the passed\ndata object.

"},{"title":"ICAL.Recur.fromString","link":"fromString","description":"

Creates a new {@link ICAL.Recur} instance from the passed string.

"},{"title":"ICAL.Recur.icalDayToNumericDay","link":"icalDayToNumericDay","description":"

Convert an ical representation of a day (SU, MO, etc..)\ninto a numeric value of that day.

"},{"title":"ICAL.Recur.numericDayToIcalDay","link":"numericDayToIcalDay","description":"

Convert a numeric day value into its ical representation (SU, MO, etc..)

"},{"title":"ICAL.RecurExpansion","link":"RecurExpansion","description":"

Creates a new ICAL.RecurExpansion instance.

\n

The options object can be filled with the specified initial values. It can also contain\nadditional members, as a result of serializing a previous expansion state, as shown in the\nexample.

"},{"title":"ICAL.RecurExpansion#complete","link":"complete","description":"

True when iteration is fully completed.

"},{"title":"ICAL.RecurExpansion#dtstart","link":"dtstart","description":"

Start date of recurring rules.

"},{"title":"ICAL.RecurExpansion#fromData","link":"fromData","description":"

Initialize the recurrence expansion from the data object. The options\nobject may also contain additional members, see the\n{@link ICAL.RecurExpansion constructor} for more details.

"},{"title":"ICAL.RecurExpansion#last","link":"last","description":"

Last expanded time

"},{"title":"ICAL.RecurExpansion#next","link":"next","description":"

Retrieve the next occurrence in the series.

"},{"title":"ICAL.RecurExpansion#toJSON","link":"toJSON","description":"

Converts object into a serialize-able format. This format can be passed\nback into the expansion to resume iteration.

"},{"title":"ICAL.RecurIterator","link":"RecurIterator","description":"

Creates a new ICAL.RecurIterator instance. The options object may contain additional members\nwhen resuming iteration from a previous run.

"},{"title":"ICAL.RecurIterator#completed","link":"completed","description":"

True when iteration is finished.

"},{"title":"ICAL.RecurIterator#dtstart","link":"dtstart","description":"

The start date of the event being iterated.

"},{"title":"ICAL.RecurIterator#fromData","link":"fromData","description":"

Initialize the recurrence iterator from the passed data object. This\nmethod is usually not called directly, you can initialize the iterator\nthrough the constructor.

"},{"title":"ICAL.RecurIterator#last","link":"last","description":"

The last occurrence that was returned from the\n{@link ICAL.RecurIterator#next} method.

"},{"title":"ICAL.RecurIterator#last.year","link":"year","description":"

The normalization horrors below are due to\nthe fact that when the year/month/day changes\nit can effect the other operations that come after.

"},{"title":"ICAL.RecurIterator#next","link":"next","description":"

Retrieve the next occurrence from the iterator.

"},{"title":"ICAL.RecurIterator#occurrence_number","link":"occurrence_number","description":"

The sequence number from the occurrence

"},{"title":"ICAL.RecurIterator#rule","link":"rule","description":"

The rule that is being iterated

"},{"title":"ICAL.RecurIterator#ruleDayOfWeek","link":"ruleDayOfWeek"},{"title":"ICAL.RecurIterator#toJSON","link":"toJSON","description":"

Convert iterator into a serialize-able object. Will preserve current\niteration sequence to ensure the seamless continuation of the recurrence\nrule.

"},{"title":"ICAL.Time","link":"Time","description":"

Creates a new ICAL.Time instance.

"},{"title":"ICAL.Time#DEFAULT_WEEK_START","link":"DEFAULT_WEEK_START","description":"

The default weekday for the WKST part.

"},{"title":"ICAL.Time#addDuration","link":"addDuration","description":"

Adds the duration to the current time. The instance is modified in\nplace.

"},{"title":"ICAL.Time#adjust","link":"adjust","description":"

Adjust the date/time by the given offset

"},{"title":"ICAL.Time#clone","link":"clone","description":"

Returns a clone of the time object.

"},{"title":"ICAL.Time#compare","link":"compare","description":"

Compares the ICAL.Time instance with another one.

"},{"title":"ICAL.Time#compareDateOnlyTz","link":"compareDateOnlyTz","description":"

Compares only the date part of this instance with another one.

"},{"title":"ICAL.Time#convertToZone","link":"convertToZone","description":"

Convert the instance into another timezone. The returned ICAL.Time\ninstance is always a copy.

"},{"title":"ICAL.Time#dayOfWeek","link":"dayOfWeek","description":"

Calculate the day of week.

"},{"title":"ICAL.Time#dayOfYear","link":"dayOfYear","description":"

Calculate the day of year.

"},{"title":"ICAL.Time#daysInYearPassedMonth","link":"daysInYearPassedMonth","description":"

The days that have passed in the year after a given month. The array has\ntwo members, one being an array of passed days for non-leap years, the\nother analog for leap years.

"},{"title":"ICAL.Time#endOfMonth","link":"endOfMonth","description":"

Returns a copy of the current date/time, shifted to the end of the\nmonth. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#endOfWeek","link":"endOfWeek","description":"

Returns a copy of the current date/time, shifted to the end of the week.\nThe resulting ICAL.Time instance is of icaltype date, even if this is a\ndate-time.

"},{"title":"ICAL.Time#endOfYear","link":"endOfYear","description":"

Returns a copy of the current date/time, shifted to the end of the\nyear. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#epochTime","link":"epochTime","description":"

January 1st, 1970 as an ICAL.Time.

"},{"title":"ICAL.Time#fromData","link":"fromData","description":"

Creates a new ICAL.Time instance from the the passed data object.

"},{"title":"ICAL.Time#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Time#fromJSDate","link":"fromJSDate","description":"

Set up the current instance from the Javascript date value.

"},{"title":"ICAL.Time#fromUnixTime","link":"fromUnixTime","description":"

Sets up the current instance from unix time, the number of seconds since\nJanuary 1st, 1970.

"},{"title":"ICAL.Time#getDominicalLetter","link":"getDominicalLetter","description":"

Get the dominical letter for the current year. Letters range from A - G\nfor common years, and AG to GF for leap years.

"},{"title":"ICAL.Time#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Time#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object. This value may change and\nis strictly defined by the {@link ICAL.Time#isDate isDate} member.

"},{"title":"ICAL.Time#isNthWeekDay","link":"isNthWeekDay","description":"

Checks if current time is the nth weekday, relative to the current\nmonth. Will always return false when rule resolves outside of current\nmonth.

"},{"title":"ICAL.Time#nthWeekDay","link":"nthWeekDay","description":"

Finds the nthWeekDay relative to the current month (not day). The\nreturned value is a day relative the month that this month belongs to so\n1 would indicate the first of the month and 40 would indicate a day in\nthe following month.

"},{"title":"ICAL.Time#reset","link":"reset","description":"

Reset the time instance to epoch time

"},{"title":"ICAL.Time#resetTo","link":"resetTo","description":"

Reset the time instance to the given date/time values.

"},{"title":"ICAL.Time#startDoyWeek","link":"startDoyWeek","description":"

First calculates the start of the week, then returns the day of year for\nthis date. If the day falls into the previous year, the day is zero or negative.

"},{"title":"ICAL.Time#startOfMonth","link":"startOfMonth","description":"

Returns a copy of the current date/time, rewound to the start of the\nmonth. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#startOfWeek","link":"startOfWeek","description":"

Returns a copy of the current date/time, rewound to the start of the\nweek. The resulting ICAL.Time instance is of icaltype date, even if this\nis a date-time.

"},{"title":"ICAL.Time#startOfYear","link":"startOfYear","description":"

Returns a copy of the current date/time, rewound to the start of the\nyear. The resulting ICAL.Time instance is of icaltype date, even if\nthis is a date-time.

"},{"title":"ICAL.Time#subtractDate","link":"subtractDate","description":"

Subtract the date details (excluding timezone). Useful for finding\nthe relative difference between two time objects excluding their\ntimezone differences.

"},{"title":"ICAL.Time#subtractDateTz","link":"subtractDateTz","description":"

Subtract the date details, taking timezones into account.

"},{"title":"ICAL.Time#toICALString","link":"toICALString","description":"

Returns an RFC 5545 compliant ical representation of this object.

"},{"title":"ICAL.Time#toJSDate","link":"toJSDate","description":"

Converts the current instance to a Javascript date

"},{"title":"ICAL.Time#toJSON","link":"toJSON","description":"

Converts time to into Object which can be serialized then re-created\nusing the constructor.

"},{"title":"ICAL.Time#toString","link":"toString","description":"

The string representation of this date/time, in jCal form\n(including : and - separators).

"},{"title":"ICAL.Time#toUnixTime","link":"toUnixTime","description":"

Converts the current instance to seconds since January 1st 1970.

"},{"title":"ICAL.Time#utcOffset","link":"utcOffset","description":"

Calculates the UTC offset of the current date/time in the timezone it is\nin.

"},{"title":"ICAL.Time#weekNumber","link":"weekNumber","description":"

Calculates the ISO 8601 week number. The first week of a year is the\nweek that contains the first Thursday. The year can have 53 weeks, if\nJanuary 1st is a Friday.

\n

Note there are regions where the first week of the year is the one that\nstarts on January 1st, which may offset the week number. Also, if a\ndifferent week start is specified, this will also affect the week\nnumber.

"},{"title":"ICAL.Time#zone","link":"zone","description":"

The timezone for this time.

"},{"title":"ICAL.Time.daysInMonth","link":"daysInMonth","description":"

Returns the days in the given month

"},{"title":"ICAL.Time.fromDateString","link":"fromDateString","description":"

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

"},{"title":"ICAL.Time.fromDateTimeString","link":"fromDateTimeString","description":"

Returns a new ICAL.Time instance from a date-time string, e.g\n2015-01-02T03:04:05. If a property is specified, the timezone is set up\nfrom the property's TZID parameter.

"},{"title":"ICAL.Time.fromDayOfYear","link":"fromDayOfYear","description":"

Create a new ICAL.Time from the day of year and year. The date is returned\nin floating timezone.

"},{"title":"ICAL.Time.fromJSDate","link":"fromJSDate","description":"

Creates a new ICAL.Time instance from the given Javascript Date.

"},{"title":"ICAL.Time.fromString","link":"fromString","description":"

Returns a new ICAL.Time instance from a date or date-time string,

"},{"title":"ICAL.Time.fromStringv2","link":"fromStringv2","description":"

Returns a new ICAL.Time instance from a date string, e.g 2015-01-02.

"},{"title":"ICAL.Time.getDominicalLetter","link":"getDominicalLetter","description":"

Get the dominical letter for the given year. Letters range from A - G for\ncommon years, and AG to GF for leap years.

"},{"title":"ICAL.Time.isLeapYear","link":"isLeapYear","description":"

Checks if the year is a leap year

"},{"title":"ICAL.Time.now","link":"now","description":"

Creates a new ICAL.Time instance from the current moment.\nThe instance is “floating” - has no timezone relation.\nTo create an instance considering the time zone, call\nICAL.Time.fromJSDate(new Date(), true)

"},{"title":"ICAL.Time.weekDay","link":"weekDay","description":"

The weekday, 1 = SUNDAY, 7 = SATURDAY. Access via\nICAL.Time.MONDAY, ICAL.Time.TUESDAY, ...

"},{"title":"ICAL.Time.weekOneStarts","link":"weekOneStarts","description":"

Returns the date on which ISO week number 1 starts.

"},{"title":"ICAL.Timezone","link":"Timezone","description":"

Creates a new ICAL.Timezone instance, by passing in a tzid and component.

"},{"title":"ICAL.Timezone#component","link":"component","description":"

The vtimezone component for this timezone.

"},{"title":"ICAL.Timezone#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.Timezone#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.Timezone#latitude","link":"latitude","description":"

The primary latitude for the timezone.

"},{"title":"ICAL.Timezone#location","link":"location","description":"

Timezone location

"},{"title":"ICAL.Timezone#longitude","link":"longitude","description":"

The primary longitude for the timezone.

"},{"title":"ICAL.Timezone#toString","link":"toString","description":"

The string representation of this timezone.

"},{"title":"ICAL.Timezone#tzid","link":"tzid","description":"

Timezone identifier

"},{"title":"ICAL.Timezone#tznames","link":"tznames","description":"

Alternative timezone name, for the string representation

"},{"title":"ICAL.Timezone#utcOffset","link":"utcOffset","description":"

Finds the utcOffset the given time would occur in this timezone.

"},{"title":"ICAL.Timezone.convert_time","link":"convert_time","description":"

Convert the date/time from one zone to the next.

"},{"title":"ICAL.Timezone.fromData","link":"fromData","description":"

Creates a new ICAL.Timezone instance from the passed data object.

"},{"title":"ICAL.UtcOffset","link":"UtcOffset","description":"

Creates a new ICAL.UtcOffset instance.

"},{"title":"ICAL.UtcOffset#clone","link":"clone","description":"

Returns a clone of the utc offset object.

"},{"title":"ICAL.UtcOffset#compare","link":"compare","description":"

Compare this utc offset with another one.

"},{"title":"ICAL.UtcOffset#factor","link":"factor","description":"

The sign of the utc offset, 1 for positive offset, -1 for negative\noffsets.

"},{"title":"ICAL.UtcOffset#fromData","link":"fromData","description":"

Sets up the current instance using members from the passed data object.

"},{"title":"ICAL.UtcOffset#fromSeconds","link":"fromSeconds","description":"

Sets up the current instance from the given seconds value. The seconds\nvalue is truncated to the minute. Offsets are wrapped when the world\nends, the hour after UTC+14:00 is UTC-12:00.

"},{"title":"ICAL.UtcOffset#hours","link":"hours","description":"

The hours in the utc-offset

"},{"title":"ICAL.UtcOffset#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.UtcOffset#minutes","link":"minutes","description":"

The minutes in the utc-offset

"},{"title":"ICAL.UtcOffset#toICALString","link":"toICALString","description":"

The iCalendar string representation of this utc-offset.

"},{"title":"ICAL.UtcOffset#toSeconds","link":"toSeconds","description":"

Convert the current offset to a value in seconds

"},{"title":"ICAL.UtcOffset#toString","link":"toString","description":"

The string representation of this utc-offset.

"},{"title":"ICAL.UtcOffset.fromSeconds","link":"fromSeconds","description":"

Creates a new {@link ICAL.UtcOffset} instance from the passed seconds\nvalue.

"},{"title":"ICAL.UtcOffset.fromString","link":"fromString","description":"

Creates a new {@link ICAL.UtcOffset} instance from the passed string.

"},{"title":"ICAL.VCardTime","link":"VCardTime","description":"

Creates a new ICAL.VCardTime instance.

"},{"title":"ICAL.VCardTime#clone","link":"clone","description":"

Returns a clone of the vcard date/time object.

"},{"title":"ICAL.VCardTime#icalclass","link":"icalclass","description":"

The class identifier.

"},{"title":"ICAL.VCardTime#icaltype","link":"icaltype","description":"

The type name, to be used in the jCal object.

"},{"title":"ICAL.VCardTime#toICALString","link":"toICALString","description":"

Returns an RFC 6350 compliant representation of this object.

"},{"title":"ICAL.VCardTime#toString","link":"toString","description":"

The string representation of this date/time, in jCard form\n(including : and - separators).

"},{"title":"ICAL.VCardTime.fromDateAndOrTimeString","link":"fromDateAndOrTimeString","description":"

Returns a new ICAL.VCardTime instance from a date and/or time string.

"},{"title":"ICAL.design.designSet","link":"designSet","description":"

A designSet describes value, parameter and property data. It is used by\nther parser and stringifier in components and properties to determine they\nshould be represented.

"},{"title":"ICAL.module:TimezoneService","link":"TimezoneService"},{"title":"ICAL.module:TimezoneService.get","link":"get","description":"

Returns a timezone by its tzid if present.

"},{"title":"ICAL.module:TimezoneService.has","link":"has","description":"

Checks if timezone id has been registered.

"},{"title":"ICAL.module:TimezoneService.register","link":"register","description":"

Registers a timezone object or component.

"},{"title":"ICAL.module:TimezoneService.remove","link":"remove","description":"

Removes a timezone by its tzid from the list.

"},{"title":"ICAL.module:design","link":"design"},{"title":"ICAL.module:design","link":"design","description":"

The design data, used by the parser to determine types for properties and\nother metadata needed to produce correct jCard/jCal data.

"},{"title":"ICAL.module:design.components","link":"components","description":"

Holds the design set for known top-level components

"},{"title":"ICAL.module:design.defaultSet","link":"defaultSet","description":"

The default set for new properties and components if none is specified.

"},{"title":"ICAL.module:design.defaultType","link":"defaultType","description":"

The default type for unknown properties

"},{"title":"ICAL.module:design.getDesignSet","link":"getDesignSet","description":"

Gets the design set for the given component name.

"},{"title":"ICAL.module:design.icalendar","link":"icalendar","description":"

The design set for iCalendar (rfc5545/rfc7265) components.

"},{"title":"ICAL.module:design.strict","link":"strict","description":"

Can be set to false to make the parser more lenient.

"},{"title":"ICAL.module:design.vcard","link":"vcard","description":"

The design set for vCard (rfc6350/rfc7095) components.

"},{"title":"ICAL.module:design.vcard3","link":"vcard3","description":"

The design set for vCard (rfc2425/rfc2426/rfc7095) components.

"},{"title":"ICAL.module:design~date.undecorate","link":"undecorate","description":"

undecorates a time object.

"},{"title":"ICAL.module:design~icalSet","link":"icalSet","description":"

iCalendar design set

"},{"title":"ICAL.module:design~vcard3Set","link":"vcard3Set","description":"

vCard 3.0 design set

"},{"title":"ICAL.module:design~vcardSet","link":"vcardSet","description":"

vCard 4.0 design set

"},{"title":"ICAL.module:helpers","link":"helpers","description":"

Helper functions used in various places within ical.js

"},{"title":"ICAL.module:helpers.binsearchInsert","link":"binsearchInsert","description":"

Find the index for insertion using binary search.

"},{"title":"ICAL.module:helpers.clone","link":"clone","description":"

Clone the passed object or primitive. By default a shallow clone will be\nexecuted.

"},{"title":"ICAL.module:helpers.extend","link":"extend","description":"

Poor-man's cross-browser object extension. Doesn't support all the\nfeatures, but enough for our usage. Note that the target's properties are\nnot overwritten with the source properties.

"},{"title":"ICAL.module:helpers.foldline","link":"foldline","description":"

Performs iCalendar line folding. A line ending character is inserted and\nthe next line begins with a whitespace.

"},{"title":"ICAL.module:helpers.formatClassType","link":"formatClassType","description":"

Creates or returns a class instance of a given type with the initialization\ndata if the data is not already an instance of the given type.

"},{"title":"ICAL.module:helpers.isStrictlyNaN","link":"isStrictlyNaN","description":"

Checks if the given type is of the number type and also NaN.

"},{"title":"ICAL.module:helpers.pad2","link":"pad2","description":"

Pads the given string or number with zeros so it will have at least two\ncharacters.

"},{"title":"ICAL.module:helpers.strictParseInt","link":"strictParseInt","description":"

Parses a string value that is expected to be an integer, when the valid is\nnot an integer throws a decoration error.

"},{"title":"ICAL.module:helpers.trunc","link":"trunc","description":"

Truncates the given number, correctly handling negative numbers.

"},{"title":"ICAL.module:helpers.unescapedIndexOf","link":"unescapedIndexOf","description":"

Identical to indexOf but will only match values when they are not preceded\nby a backslash character.

"},{"title":"ICAL.module:helpers.updateTimezones","link":"updateTimezones","description":"

Compiles a list of all referenced TZIDs in all subcomponents and\nremoves any extra VTIMEZONE subcomponents. In addition, if any TZIDs\nare referenced by a component, but a VTIMEZONE does not exist,\nan attempt will be made to generate a VTIMEZONE using ICAL.TimezoneService.

"},{"title":"ICAL.parse(function)","link":"parse","description":"

Parses iCalendar or vCard data into a raw jCal object. Consult\ndocumentation on the {@tutorial layers|layers of parsing} for more\ndetails.

"},{"title":"ICAL.parse.ParserError","link":"ParserError"},{"title":"ICAL.parse._rfc6868Escape","link":"_rfc6868Escape","description":"

Internal helper for rfc6868. Exposing this on ICAL.parse so that\nhackers can disable the rfc6868 parsing if the really need to.

"},{"title":"ICAL.parse.component","link":"component","description":"

Convenience method to parse a component. You can use ICAL.parse() directly\ninstead.

"},{"title":"ICAL.parse.property","link":"property","description":"

Parse an iCalendar property value into the jCal for a single property

"},{"title":"ICAL.stringify(function)","link":"stringify","description":"

Convert a full jCal/jCard array into a iCalendar/vCard string.

"},{"title":"ICAL.stringify.component","link":"component","description":"

Converts an jCal component array into a ICAL string.\nRecursive will resolve sub-components.

\n

Exact component/property order is not saved all\nproperties will come before subcomponents.

"},{"title":"ICAL.stringify.multiValue","link":"multiValue","description":"

Converts an array of ical values into a single\nstring based on a type and a delimiter value (like ",").

"},{"title":"ICAL.stringify.paramPropertyValue","link":"paramPropertyValue","description":"

Handles escaping of property values that may contain:

\n

COLON (:), SEMICOLON (;), or COMMA (,)

\n

If any of the above are present the result is wrapped\nin double quotes.

"},{"title":"ICAL.stringify.property","link":"property","description":"

Converts a single jCal/jCard property to a iCalendar/vCard string.

"},{"title":"ICAL.stringify.value","link":"value","description":"

Processes a single ical value runs the associated "toICAL" method from the\ndesign value type if available to convert the value.

"},{"title":"InvalidRecurrenceRuleError","link":"InvalidRecurrenceRuleError"},{"title":"module.exports.foldLength","link":"foldLength","description":"

The number of characters before iCalendar line folding should occur

"},{"title":"module.exports.newLineChar","link":"newLineChar","description":"

The character(s) to be used for a newline. The default value is provided by\nrfc5545.

"},{"title":"parse._handleContentLine~result","link":"result","description":"

Note on var result juggling:

\n

I observed that building the array in pieces has adverse\neffects on performance, so where possible we inline the creation.\nIt is a little ugly but resulted in ~2000 additional ops/sec.

"},{"title":"stringify._rfc6868Unescape","link":"_rfc6868Unescape","description":"

Internal helper for rfc6868. Exposing this on ICAL.stringify so that\nhackers can disable the rfc6868 parsing if the really need to.

"}]} \ No newline at end of file diff --git a/api/design.js.html b/api/design.js.html index cf592851..8ac88ccd 100644 --- a/api/design.js.html +++ b/api/design.js.html @@ -1,6 +1,6 @@ Source: design.js
On this page

design.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
design.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -1030,4 +1030,4 @@
   }
 };
 export default design;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/duration.js.html b/api/duration.js.html index 9a24f500..69ea5de9 100644 --- a/api/duration.js.html +++ b/api/duration.js.html @@ -1,6 +1,6 @@ Source: duration.js
On this page

duration.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
duration.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -355,4 +355,4 @@
 
   return 1;
 }
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/event.js.html b/api/event.js.html index 3414484f..781bce8f 100644 --- a/api/event.js.html +++ b/api/event.js.html @@ -1,6 +1,6 @@ Source: event.js
On this page

event.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
event.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -566,4 +566,4 @@
   if (b[0] > a[0]) return -1;
   return 0;
 }
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/helpers.js.html b/api/helpers.js.html index 2586e55c..4f21e166 100644 --- a/api/helpers.js.html +++ b/api/helpers.js.html @@ -1,6 +1,6 @@ Source: helpers.js
On this page

helpers.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
helpers.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -314,4 +314,4 @@
   }
   return target;
 }
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/index.html b/api/index.html index 6881ae16..22c31a75 100644 --- a/api/index.html +++ b/api/index.html @@ -1,6 +1,6 @@ Home
On this page

ical.js - Javascript parser for iCalendar, jCal, vCard, jCard.

This is a library to parse the formats defined in the following rfcs and their extensions:

The initial goal was to use it as a replacement for libical in the Mozilla Calendar Project, but the library has been written with the web in mind. This library enables you to do all sorts of cool experiments with calendar data and the web. Most algorithms here were taken from libical. If you are bugfixing this library, please check if the fix can be upstreamed to libical.

Build Status Coverage Statusnpm versionCDNJS

Sandbox and Validator

If you want to try out ICAL.js right now, there is a jsfiddle set up and ready to use. Read on for documentation and example links.

There is also a validator that demonstrates how to use the library in a webpage in the tools/ subdirectory.

Try the validator online, it always uses the latest release of ICAL.js.

Installing

ICAL.js has no dependencies and is written in modern JavaScript. You can install ICAL.js via npm, if you would like to use it in Node.js:

npm install ical.js
+    
On this page
ical.js - Javascript parser for iCalendar, jCal, vCard, jCard.
This is a library to parse the formats defined in the following rfcs and their extensions:
The initial goal was to use it as a replacement for libical in the Mozilla Calendar Project, but the library has been written with the web in mind. This library enables you to do all sorts of cool experiments with calendar data and the web. Most algorithms here were taken from libical. If you are bugfixing this library, please check if the fix can be upstreamed to libical.
Build Status Coverage Statusnpm versionCDNJS
Sandbox and Validator
If you want to try out ICAL.js right now, there is a jsfiddle set up and ready to use. Read on for documentation and example links.
There is also a validator that demonstrates how to use the library in a webpage in the tools/ subdirectory.
Try the validator online, it always uses the latest release of ICAL.js.
Installing
ICAL.js has no dependencies and is written in modern JavaScript. You can install ICAL.js via npm, if you would like to use it in Node.js:
npm install ical.js
 
Then simply import it for use:
import ICAL from "ical.js";
 
If you are working with a browser, be aware this is an ES6 module:
<script type="module">
   import ICAL from "https://unpkg.com/ical.js";
@@ -18,4 +18,4 @@
 
 npm run test              # Node unit and acceptance tests (This is fast and covers most aspects)
 npm run test-all          # All of the above
-
See the wiki for more details.
Code coverage is automatically generated for the node unit tests. You can view the coverage results online, or run them locally to make sure new code is covered.
Linters
To make sure all ICAL.js code uses a common style, please run the linters using npm run lint. Please make sure you fix any issues shown by this command before sending a pull request.
Documentation
You can generate the documentation locally, this is also helpful to ensure the jsdoc you have written is valid. To do so, run npm run jsdoc. You will find the output in the docs/api/ subdirectory.
Packaging
When you are done with your work, you can run npm run build to create the single-file build for use in the browser, including its minified counterpart and the source map.
License
ical.js is licensed under the Mozilla Public License, version 2.0.

\ No newline at end of file
+

See the wiki for more details.

Code coverage is automatically generated for the node unit tests. You can view the coverage results online, or run them locally to make sure new code is covered.

Linters

To make sure all ICAL.js code uses a common style, please run the linters using npm run lint. Please make sure you fix any issues shown by this command before sending a pull request.

Documentation

You can generate the documentation locally, this is also helpful to ensure the jsdoc you have written is valid. To do so, run npm run jsdoc. You will find the output in the docs/api/ subdirectory.

Packaging

When you are done with your work, you can run npm run build to create the single-file build for use in the browser, including its minified counterpart and the source map.

License

ical.js is licensed under the Mozilla Public License, version 2.0.

Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/module.js.html b/api/module.js.html index 21bebb46..d4bc9f68 100644 --- a/api/module.js.html +++ b/api/module.js.html @@ -1,6 +1,6 @@ Source: module.js
On this page

module.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
module.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -73,4 +73,4 @@
   design,
   helpers
 };
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/parse.js.html b/api/parse.js.html index 4f0bce41..3c1903ba 100644 --- a/api/parse.js.html +++ b/api/parse.js.html @@ -1,6 +1,6 @@ Source: parse.js
On this page

parse.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
parse.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -561,4 +561,4 @@
   if (line.length)
     callback(null, line);
 };
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/period.js.html b/api/period.js.html index a3dd1918..b4276a77 100644 --- a/api/period.js.html +++ b/api/period.js.html @@ -1,6 +1,6 @@ Source: period.js
On this page

period.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
period.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -234,4 +234,4 @@
   }
 }
 export default Period;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/property.js.html b/api/property.js.html index 3d0d5317..5a9af744 100644 --- a/api/property.js.html +++ b/api/property.js.html @@ -1,6 +1,6 @@ Source: property.js
On this page

property.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
property.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -408,4 +408,4 @@
   }
 }
 export default Property;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/recur.js.html b/api/recur.js.html index 0c52d1d7..1d325715 100644 --- a/api/recur.js.html +++ b/api/recur.js.html @@ -1,6 +1,6 @@ Source: recur.js
On this page

recur.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
recur.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -558,4 +558,4 @@
   BYMONTH: parseNumericValue.bind(undefined, 'BYMONTH', 1, 12),
   BYSETPOS: parseNumericValue.bind(undefined, 'BYSETPOS', -366, 366)
 };
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/recur_expansion.js.html b/api/recur_expansion.js.html index 56675a07..c47e67fb 100644 --- a/api/recur_expansion.js.html +++ b/api/recur_expansion.js.html @@ -1,6 +1,6 @@ Source: recur_expansion.js
On this page

recur_expansion.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
recur_expansion.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -475,4 +475,4 @@
   }
 }
 export default RecurExpansion;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/recur_iterator.js.html b/api/recur_iterator.js.html index 6e3a2ed2..0f90c090 100644 --- a/api/recur_iterator.js.html +++ b/api/recur_iterator.js.html @@ -1,6 +1,6 @@ Source: recur_iterator.js
On this page

recur_iterator.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
recur_iterator.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -181,7 +181,19 @@
     this.initialized = options.initialized || false;
 
     if (!this.initialized) {
-      this.init();
+      try {
+        this.init();
+      } catch (e) {
+        if (e instanceof InvalidRecurrenceRuleError) {
+          // Init may error if there are no possible recurrence instances from
+          // the rule, but we don't want to bubble this error up. Instead, we
+          // create an empty iterator.
+          this.completed = true;
+        } else {
+          // Propagate other errors to consumers.
+          throw e;
+        }
+      }
     }
   }
 
@@ -253,7 +265,17 @@
     }
 
     if (this.rule.freq == "YEARLY") {
-      for (;;) {
+      // Some yearly recurrence rules may be specific enough to not actually
+      // occur on a yearly basis, e.g. the 29th day of February or the fifth
+      // Monday of a given month. The standard isn't clear on the intended
+      // behavior in these cases, but `libical` at least will iterate until it
+      // finds a matching year.
+      // CAREFUL: Some rules may specify an occurrence that can never happen,
+      // e.g. the first Monday of April so long as it falls on the 15th
+      // through the 21st. Detecting these is non-trivial, so ensure that we
+      // stop iterating at some point.
+      const untilYear = this.rule.until ? this.rule.until.year : 20000;
+      while (this.last.year <= untilYear) {
         this.expand_year_days(this.last.year);
         if (this.days.length > 0) {
           break;
@@ -261,6 +283,10 @@
         this.increment_year(this.rule.interval);
       }
 
+      if (this.days.length == 0) {
+        throw new InvalidRecurrenceRuleError();
+      }
+
       this._nextByYearDay();
     }
 
@@ -350,11 +376,10 @@
 
     if ((this.rule.count && this.occurrence_number >= this.rule.count) ||
         (this.rule.until && this.last.compare(this.rule.until) > 0)) {
-
-      //XXX: right now this is just a flag and has no impact
-      //     we can simplify the above case to check for completed later.
       this.completed = true;
+    }
 
+    if (this.completed) {
       return null;
     }
 
@@ -364,7 +389,6 @@
       return this.last;
     }
 
-
     let valid;
     do {
       valid = 1;
@@ -1393,5 +1417,19 @@
     return result;
   }
 }
+
+/**
+ * An error indicating that a recurrence rule is invalid and produces no
+ * occurrences.
+ *
+ * @extends {Error}
+ * @class
+ */
+class InvalidRecurrenceRuleError extends Error {
+  constructor() {
+    super("Recurrence rule has no valid occurrences");
+  }
+}
+
 export default RecurIterator;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/stringify.js.html b/api/stringify.js.html index 59f61baf..69781175 100644 --- a/api/stringify.js.html +++ b/api/stringify.js.html @@ -1,6 +1,6 @@ Source: stringify.js
On this page

stringify.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
stringify.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -292,4 +292,4 @@
     return RFC6868_REPLACE_MAP[x];
   });
 };
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/time.js.html b/api/time.js.html index d8c48eb0..f7e62cc0 100644 --- a/api/time.js.html +++ b/api/time.js.html @@ -1,6 +1,6 @@ Source: time.js
On this page

time.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
time.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -1331,4 +1331,4 @@
     defineAttr("second");
     defineAttr("isDate");
 })();
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/timezone.js.html b/api/timezone.js.html index 410f18bd..233fc1d6 100644 --- a/api/timezone.js.html +++ b/api/timezone.js.html @@ -1,6 +1,6 @@ Source: timezone.js
On this page

timezone.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
timezone.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -527,4 +527,4 @@
   }
 }
 export default Timezone;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/timezone_service.js.html b/api/timezone_service.js.html index 9c461905..4c6b3775 100644 --- a/api/timezone_service.js.html +++ b/api/timezone_service.js.html @@ -1,6 +1,6 @@ Source: timezone_service.js
On this page

timezone_service.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
timezone_service.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -109,4 +109,4 @@
 };
 
 export default TimezoneService;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/utc_offset.js.html b/api/utc_offset.js.html index 6b00aa50..901d79aa 100644 --- a/api/utc_offset.js.html +++ b/api/utc_offset.js.html @@ -1,6 +1,6 @@ Source: utc_offset.js
On this page

utc_offset.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
utc_offset.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -185,4 +185,4 @@
   }
 }
 export default UtcOffset;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file diff --git a/api/vcard_time.js.html b/api/vcard_time.js.html index e7fcbef8..94d14b07 100644 --- a/api/vcard_time.js.html +++ b/api/vcard_time.js.html @@ -1,6 +1,6 @@ Source: vcard_time.js
On this page

vcard_time.js

/* This Source Code Form is subject to the terms of the Mozilla Public
+    
On this page
vcard_time.js
/* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  * Portions Copyright (C) Philipp Kewisch */
@@ -184,4 +184,4 @@
   }
 }
 export default VCardTime;
-

\ No newline at end of file
+
Home
TimezoneService
design
design
helpers
Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime
ParserError
InvalidRecurrenceRuleError
ICAL
\ No newline at end of file