ICalUtilSNC - Global

The ICalUtilSNC API provides functions to generate iCalendar compliant events.

ICalUtilSNC - formatICalComponent(Array arrEvents)

Generates a formatted VCALENDAR component.

Table 1. Parameters
Name Type Description
arrEvents Array Contains the properties that make up a VCALENDAR component.
Table 2. Returns
Type Description
Array Contains properties needed to form a VCALENDAR.

ICalUtilSNC - formatICalEvent(Array arrEvent, Boolean useAlarm)

Generates a formatted VEVENT.

Additional information about the method that does not belong in the short description.

Table 3. Parameters
Name Type Description
arrEvent Array Contains the individual properties that make up a VEVENT.
useAlarm Boolean If true, adds a VALARM to the VEVENT.
Table 4. Returns
Type Description
String The formatted VEVENT.

ICalUtilSNC - formatRecurringRule (Object ruleObj)

Formats the RRULE property for a VEVENT.

Table 5. Parameters
Name Type Description
ruleObj Object Contains the properties for the RRULE property.
Table 6. Returns
Type Description
String The formatted RRULE property.

ICalUtilSNC - getDateFromScheduleDateTime (GlideScheduleDateTime scheduleDateTime)

Returns the date from the GlideScheduleDateTime.

Table 7. Parameters
Name Type Description
scheduleDateTime GlideScheduleDateTime A GlideScheduleDateTime representation of the date and time.
Table 8. Returns
Type Description
String Formatted date.

ICalUtilSNC - getSDT(String sdtStr, String timeZone)

If provided with a formatted date time string, it returns a GlideScheduleDateTime object.

Table 9. Parameters
Name Type Description
sdtStr String Formatted ScheduleDateTime.
timeZone String If provided, will be used for the generated GlideScheduleDateTime.
Table 10. Returns
Type Description
GlideScheduleDateTime A GlideScheduleDateTime representation of the sdtStr.

ICalUtilSNC - getTimeFromScheduleDateTime (GlideScheduleDateTime scheduleDateTime)

Returns the time from the GlideScheduleDateTime.

Table 11. Parameters
Name Type Description
scheduleDateTime GlideScheduleDateTime A GlideScheduleDateTime representation of the date and time.
Table 12. Returns
Type Description
String Formatted time.