DataStandardizer.File.iCal API reference

The public types of DataStandardizer.File.iCal. All types are in the DataStandardizer.File.iCal namespace.

Classes

Type Description
IcalAlarm An alarm (VALARM): typed access to a reminder’s action, trigger and repeat properties.
IcalCalendar An iCalendar object (VCALENDAR): calendar properties, including RFC 7986’s, and its events, to-dos, journals, free/busy and time zones.
IcalComponent The base component: a name, ordered properties and nested components, with property lookup and validation.
IcalContentLine A content line (RFC 5545 §3.1): property name, parameters and value.
IcalContentLineParameter A parameter of a content line, with its decoded values.
IcalContentLineReader Reads the unfolded content lines of iCalendar data, with zero-copy and async options.
IcalContentLineWriter Writes content lines, folded and with RFC 6868 parameter encoding.
IcalDiagnostic A conformance problem found by IcalComponent.Validate.
IcalEvent An event (VEVENT): typed properties and expansion of its recurrence set into occurrences.
IcalFreeBusy Free or busy time information (VFREEBUSY): typed properties and its FREEBUSY periods.
IcalJournal A journal entry (VJOURNAL): typed properties and expansion of its recurrence set into occurrences.
IcalOccurrence One instance of a recurrence set: its local and UTC start and end, and the component (possibly an override) that describes it.
IcalOptions Options for readers, writers and recurrence expansion; RFC 5545 defaults.
IcalReader Reads .ics data into the component object model.
IcalTimeZone The VTIMEZONE component; FromTzData builds one from the TZ Database over a period you choose.
IcalTimeZoneObservance The STANDARD or DAYLIGHT observance of a VTIMEZONE.
IcalTimeZoneRules The resolved rules of a time zone: offsets, transitions, and local-to-UTC conversion per RFC 5545 §3.3.5.
IcalTodo A to-do (VTODO): typed properties and expansion of its recurrence set into occurrences.
IcalWriter Writes the component object model as .ics data.
JcalReader Reads jCal (RFC 7265, JSON) data into the component object model.
JcalWriter Writes the component object model as jCal (RFC 7265, JSON) data.
XcalReader Reads xCal (RFC 6321, XML) data into the component object model.
XcalWriter Writes the component object model as xCal (RFC 6321, XML) data.

Static classes

Type Description
IcalComponentNames The names of the components that RFC 5545 defines.
IcalParameterNames The names of the property parameters that RFC 5545 and RFC 7986 define.
IcalPropertyNames The names of the properties that RFC 5545 and RFC 7986 define.
IcalTimeZoneResolver The Calendar, TzData and System resolvers, Chain, and the Resolve and ToUtc extension methods.
IcalValue Parses and formats the BINARY, BOOLEAN, CAL-ADDRESS, FLOAT, INTEGER, TEXT and URI value types.
IcalValueTypeRegistry Gives the value type of each known property, honouring a VALUE parameter.

Structs

Type Description
IcalContentLineView A zero-allocation view of the line an IcalContentLineReader has just read.
IcalDate A DATE value (RFC 5545 §3.3.4): a calendar date with no time of day.
IcalDateOrDateTime A property value that is either a DATE or a DATE-TIME, such as DTSTART.
IcalDateTime A DATE-TIME value (RFC 5545 §3.3.5): floating, in UTC, or in a named time zone.
IcalDuration A DURATION value (RFC 5545 §3.3.6): nominal weeks or days and an exact time.
IcalPeriod A PERIOD value (RFC 5545 §3.3.9): a start and an end or a positive duration.
IcalRecurrenceDay A BYDAY value: a day of the week with an optional ordinal, such as -1FR.
IcalRecurrenceRule A RECUR value (RFC 5545 §3.3.10): parses, builds, formats and expands a recurrence rule.
IcalTextListEnumerator Enumerates the items of a list of TEXT values without allocating.
IcalTime A TIME value (RFC 5545 §3.3.12): a time of day, floating or in UTC.
IcalTimeZoneTransition A change in a time zone’s UTC offset: the onset of an observance.
IcalUtcOffset A UTC-OFFSET value (RFC 5545 §3.3.14): the difference of a local time from UTC.
IcalWriteProgress The cumulative progress a writer reports from its bulk write methods.

Exceptions

Type Description
IcalFileException Thrown for iCalendar data that cannot be read or written; details in Data.

Interfaces

Type Description
IIcalTimeZoneResolver Resolves a TZID to the rules of the time zone.

Enumerations

Type Description
IcalDateTimeKind The forms of a DATE-TIME value: floating, UTC or zoned.
IcalDiagnosticKind The kinds of conformance problem, and which options accept them.
IcalRecurrenceFrequency The FREQ rule part of a recurrence rule, from SECONDLY to YEARLY.
IcalTimeZoneObservanceKind Standard or daylight saving time (STANDARD or DAYLIGHT).
IcalValueFormat The lexical form a value is parsed or formatted in: .ics text, jCal or xCal.
IcalValueType The value types of RFC 5545 §3.3, named by the VALUE parameter.

This site uses Just the Docs, a documentation theme for Jekyll.