JtxAlarm

object JtxAlarm

Types

Link copied to clipboard

This enum class defines the possible values for the attribute ACTION for the Component VALARM

Link copied to clipboard

This enum class defines the possible values for the attribute TRIGGER_RELATIVE_TO for the Component VALARM

Properties

Link copied to clipboard
const val ACTION: String

Each "VALARM" calendar component has a particular type of action with which it is associated. This property specifies the type of action. Applications MUST ignore alarms with x-name and iana-token values they don't recognize. Currently only "DISPLAY" is supported, all other values can be stored but are ignored Type: String

Link copied to clipboard
const val ATTACH: String

Contains the uri of an attachment Type: String

Link copied to clipboard
const val ATTENDEE: String

This property contains a CSV-list of attendees as Uris e.g. "mailto:contact@techbee.at,mailto:jtx@techbee.at"

Link copied to clipboard

The content uri of the resources table

Link copied to clipboard
const val DESCRIPTION: String

This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Type: String

Link copied to clipboard
const val DURATION: String

The alarm can be defined such that it triggers repeatedly. A definition of an alarm with a repeating trigger MUST include both the "DURATION" and "REPEAT" properties. The "DURATION" property specifies the delay period, after which the alarm will repeat. Type: String

Link copied to clipboard

The name of the Foreign Key Column for IcalObjects. Type: Long, references JtxICalObject.ID

Link copied to clipboard
const val ID: String

The name of the ID column for attachments. This is the unique identifier of an Attachment Type: Long, references JtxICalObject.ID

Link copied to clipboard
const val OTHER: String

Purpose: To specify other properties for the alarm. see [https://tools.ietf.org/html/rfc5545#section-3.8.4.3] Type: String

Link copied to clipboard
const val REPEAT: String

The "REPEAT" property specifies the number of additional repetitions that the alarm will be triggered. This repetition count is in addition to the initial triggering of the alarm. Both of these properties MUST be present in order to specify a repeating alarm. If one of these two properties is absent, then the alarm will not repeat beyond the initial trigger. Type: String

Link copied to clipboard
const val SUMMARY: String

This property defines a short summary or subject for the calendar component. Type: String

Link copied to clipboard

Purpose: Specifying a relative time for the trigger of the alarm. The default duration is relative to the start of an event or to-do with which the alarm is associated. The duration can be explicitly set to trigger from either the end or the start of the associated event or to-do with the TRIGGER_RELATIVE_TO parameter. A value of START will set the alarm to trigger off the start of the associated event or to-do. A value of END will set the alarm to trigger off the end of the associated event or to-do. Either a positive or negative duration may be specified for the "TRIGGER" property. An alarm with a positive duration is triggered after the associated start or end of the event or to-do. An alarm with a negative duration is triggered before the associated start or end of the event or to-do. Type: String

Link copied to clipboard

Purpose: This property defines the field to which the duration is relatiive to. The possible values of a status are defined in the enum AlarmRelativeTo. Use e.g. AlarmRelativeTo.START.name to put a correct String value in this field. AlarmRelativeTo.START would make the duration relative to DTSTART. AlarmRelativeTo.END would make the duration relative to DUE (only VTODO is supported!). If no valid AlarmRelativeTo is provided, the default value is AlarmRelativeTo.START. Type: String

Link copied to clipboard
const val TRIGGER_TIME: String

Stores a timestamp with the absolute time when the alarm should be triggered. This value is stored as UNIX timestamp (milliseconds). Either a Alarm Trigger Time OR a Alarm Relative Duration must be provided, but not both! Type: Long

Link copied to clipboard

Purpose: This column/property specifies the timezone of the absolute trigger time. The corresponding datetime is stored in TRIGGER_TIME. The value of a timezone can be: