Note that in the iCalendar format, the property name is separated from its parameter(s) by a semi-colon. Multiple parameters are also semi-colon separated.
Calendar-level custom properties | ||
The following custom properties are used within a VCALENDAR element. | ||
Property | Parameter | Description |
---|---|---|
X-KDE-KALARM-VERSION | Mandatory. The single parameter contains the KAlarm calendar format version used to write this calendar. Note that this version may be older than the actual KAlarm application version; the calendar format version is only updated when the calendar format changes. | |
version | KAlarm calendar format version, in the format n.n.n . E.g. 2.3.10 | |
Event-level custom properties | ||
The following custom properties are used within a VEVENT element. | ||
Property | Parameter | Description |
X-KDE-KALARM-TYPE | Mandatory. Multiple parameters hold the alarm's type. The first two parameters are always in the following order: | |
type | The event's type, one of ACTIVE, ARCHIVED, TEMPLATE, DISPLAYING | |
resource | The saved Akonadi collection ID, or KResources resource ID. Note that this is not the collection/resource which the event is in. | |
DEFER | For an event in the displaying calendar, indicates that the Defer button should be shown in the alarm window. Optional. | |
EDIT | For an event in the displaying calendar, indicates that the Edit button should be shown in the alarm window. Optional. | |
X-KDE-KALARM-FLAGS | Multiple parameters specify various properties of the event | |
DATE | The event time is date-only, i.e. its time is ignored and it triggers at the first opportunity on the specified date (after the start-of-day time configured by the user). Note that this is used instead of specifying a start date (DTSTART) without a time. | |
ACKCONF | For a display alarm, when the user acknowledges the alarm (i.e. closes the alarm window), a confirmation prompt will be output | |
KORG | The event was copied as an alarm to KOrganizer | |
EXHOLIDAYS | The alarm will not trigger on holidays (as defined for the holiday region configured by the user) | |
WORKTIME | The alarm will not trigger during working hours on working days (as configured by the user) | |
DEFER;interval | Records the default deferral parameters for the alarm, used when the Defer dialogue is displayed. interval holds the deferral interval in minutes, with an optional D suffix to specify a date-only deferral. E.g. DEFER;1440D = 1 day, date-only | |
LATECANCEL;interval | How late the alarm can trigger (in minutes) before it will be cancelled; default = 1 minute | |
LATECLOSE;interval | For a display alarm, how long after the trigger time (in minutes) until the alarm window is automatically closed; default = 1 minute. It will also be cancelled if it triggers after this time. | |
TMPLAFTTIME;interval | For a template alarm, holds the value (in minutes) of the "After time" option | |
KMAIL;sernum | The KMail serial number of the email whose text forms the alarm message | |
BCC | For an email alarm, the email will be blind copied to the user | |
X-KDE-KALARM-NEXTRECUR | The single parameter records the next due recurrence date/time of the main alarm | |
date-time | The date and optional time, in the format YYYYMMDDTHHMMSS for a date/time alarm, or YYYYMMDD for a date-only alarm. E.g. 19990131T120000 | |
X-KDE-KALARM-REPEAT | Used for an active alarm when its main alarm has expired, holds the alarm's sub-repetition information. (Normally, this is held in the main alarm.) | |
interval:count | Sub-repetition interval (in minutes) and count | |
X-KDE-KALARM-LOG | The single parameter specifies where command alarm output should go; default = discard | |
xterm: | Display command output in a terminal window | |
display: | Display command output in an alarm window | |
filename | Store command output in the specified file | |
X-KDE-KALARM-ARCHIVE | Multiple parameters record archiving information for an active alarm. Its presence indicates that the alarm has triggered at least once and should be archived when it expires or is deleted. | |
LOGIN | When the main alarm has expired, records that the original alarm was repeat-at-login | |
ONCE | Used when no reminder is currently pending, to indicate that the reminder should be shown only for the first recurrence | |
interval | Used when no reminder is currently pending, to hold the reminder interval. The suffix indicates the time units: M = minutes, H = hours, D = days. E.g. 12M | |
0 | Dummy parameter used when no other parameter is present, because iCalendar requires every property to have a parameter | |
Alarm-level custom properties | ||
The following custom properties are used within a VALARM element. | ||
Property | Parameter | Description |
X-KDE-KALARM-TYPE | Multiple parameters hold information about the alarm's type. If this property is missing, the alarm is the "main" alarm for the event. | |
LOGIN | The alarm should be triggered each time KAlarm starts up (normally at each login) | |
FILE | For a display alarm, indicates that the alarm text holds the name of a file whose contents should form the alarm message | |
REMINDER | The alarm is a subsidiary reminder alarm | |
REMINDER_ONCE | The alarm is a subsidiary reminder alarm, to be triggered only on the first recurrence | |
DEFERRAL | The alarm is a subsidiary timed deferral alarm | |
DATE_DEFERRAL | The alarm is a subsidiary date-only deferral alarm | |
DISPLAYING | The alarm is currently being displayed, i.e. in the displaying calendar | |
PRE | The alarm is a subsidiary pre-alarm action command, which is executed immediately before the main alarm | |
POST | The alarm is a subsidiary post-alarm action command, which is executed immediately after the user acknowledges the main display alarm | |
SOUNDREPEAT | For an audio alarm, indicates that the sound file should be repeated indefinitely | |
X-KDE-KALARM-NEXTREPEAT | The single parameter holds the repetition count of the next due sub-repetition | |
count | Repetition number | |
X-KDE-KALARM-FONTCOLOR | For a display alarm, holds the colours to use in the alarm message window | |
[background][;foreground] | The optional background colour (default = white) and optional foreground colour (default = black) | |
X-KDE-KALARM-EMAILID | For an email alarm, holds the email ID to use in the 'From' field | |
uoid | KDE email identity uoid | |
X-KDE-KALARM-VOLUME | Holds volume settings for an audio alarm | |
[volume][;fadevolume;fadeinterval] | Contains the optional volume (floating point, range 0 - 1), and optionally the fade volume (floating point, range 0 - 1) and fade interval in seconds. E.g. 0.75 to set volume with no fade, ;0.3;10 for default volume with fade, 0.75;0.3;10 to specify volume and fade | |
X-KDE-KALARM-SPEAK | For an audio alarm in an event whose main alarm is a display or command alarm, specifies that the alarm text should be spoken | |
Y | Non-null string | |
X-KDE-KALARM-ERRCANCEL | For a command alarm containing a pre-alarm action, indicates that the alarm should be cancelled if the pre-alarm action fails | |
Y | Non-null string | |
X-KDE-KALARM-ERRNOSHOW | For a command alarm containing a pre-alarm action, indicates that there should be no error notification if the pre-alarm action fails | |
Y | Non-null string |