JBoss.orgCommunity Documentation

calendars

The Calendars node of the nt:unstructured type contains the child nodes of the exo:calendar type. When a calendar is created by users or the default ones in the system, it is stored under the calendars node: CalendarApplication/calendars/%calendar_id%. Its node type is exo:calendar that has the following properties:

Property name Required type Multiple Description
exo:id String false The Id of the calendar.
exo:name String false The name of the calendar.
exo:description String false The brief description of the calendar.
exo:viewPermissions String true The list of users/groups having the view permissions.
exo:editPermissions String true The list of users/groups having the edit permissions.
exo:groups String true The list of user groups to which the calendar belongs.
exo:categoryId String false The Id of the category containing the calendar.
exo:calendarColor String false The color name of the calendar that is defined in the org.exoplatform.web ui.form.ext.UIFormColorPicker class (such as Sky blue, Powder blue).
exo:calendarOwner String false The name of the user creating the calendar.
exo:locale String false Location where the calendar is set in format of the uppercase ISO 3166 3-letter country code.
exo:timeZone String false The Id of the time zone that is set by the user in compliance with the Java class: java.util.TimeZone.
exo:publicUrl String false The public ICAL link of the calendar.
exo:privateUrl String false The private ICAL link of the calendar.

When a user shares his own calendar with other users, the Id of the calendar node is referred to the node under the sharedCalendar node: CalendarApplication/sharedCalendars/%user_id% following the JCR reference mechanism.

In case of users' private calendar, two mixin node types exo:remoteCalendar and exo:calendarShared can be added to the exo:calendar node type.

Property name Required type Multiple Description
exo:remoteUrl String falseThe URL of the remote calendar.
exo:remoteType String falseThe type of the remote calendar, including ICalendar (.ics) and CalDav.
exo:username String falseThe username used to access the remote calendar.
exo:password String falseThe password used to access the remote calendar.
exo:syncPeriod String falseThe period the remote calendar is synchronized. auto, 5 minutes, 10 minutes, 15 minutes, 1 hour, 1 day, 1 year
exo:lastUpdated Date falseThe last update of the remote calendar.
exo:beforeDate String falseThe period before the current date in which the calendar is checked out, including the values: None (the unlimited time), 1 week, 2 weeks, 1month, 2 months, 3 months, 6 months and 1 year.
exo:afterDate String falseThe period after the current date in which the calendar is checked out, including the values: Forever (the unlimited time), 1 week, 2 weeks, 1month, 2 months, 3 months, 6 months and 1 year.
Property name Required type Multiple Description
exo:sharedIdReferencetrueThe user Ids who are shared the calendars.

An event can have many attachments which are stored under the attachment node of the exo:eventAttachmenttype: CalendarApplication/calendars/%calendar_id%/%event_id%/attachment/%attachment_id%. The exo:eventAttachment node type has the following properties:

Property name Required type Multiple Description
exo:fileName String false The name of the attached file.