io.cozy.calendar.md

Table of contents

Cozy Calendar doctype

io.cozy.calendar

The io.cozy.calendar doctype is loosely based on the iCalendar RFC, in that some of the attributes have been renamed for clarity. The attributes with a ? are optional.

• start? : {date} Start of event
• end? : {date} End of event
• timezone? : {sting} TZID identifier for a specific time zone
• rrule : {dict} Recurrency rule
  • frequency? : {number} Frequency of recurrence
  • until? : {date} Date of end of reccurence specified with frequency
• label? : {string} Event description
• description? : {string} Event comment
• location? : {string} Event location
• organizer? : {string} Event organizer
• status? : {string} CONFIRMED|CANCELLED Event status
• attendee? : {array} Array of string with event attendees

Example

{
  "_id": "62e5d66d6e11d19992b7efce794263f0",
  "start": "2018-01-02T20:38:04Z",
  "end": "2018-01-02T20:38:04Z",
  "timezone": "Europe/Paris",
  "rrule": {
    "frequency": "weekly",
    "until": "2018-01-02T20:38:04Z",
  }
  "label": "history-geography"
  "location": "B209 BIS",
  "organizer": "Mme. Dubois",
  "status": "CONFIRMED",
  "attendee": ["TG3", "1G4"],
  "description": "Apportez vos manuels !"
}

io.cozy.calendar.events

Used to save calendar event data, to be shown in a timetable or to save past time related activities.

• start? : {date} Start of event
• end? : {date} End of event
• label? : {string} Event description

io.cozy.calendar.todos

Used to save and retrieve to-do items

• dueDate : {date} Todo due date
• summary : {string} Todo summary
• completed : {boolean} Completion status

io.cozy.calendar.presence

Used to track attendance and presence related events

• start? : {date} Start of event
• end? : {date} End of event
• label? : {string} Event description(https://www.kanzaki.com/docs/ical/description.html)
• justified? : {boolean}
• type : {string} delay | absence | observation