JtxICalObject

Types

Link copied to clipboard

This enum class defines the possible values for the attribute classification of an JtxICalObject Use its name when the string representation is required, e.g. Classification.PUBLIC.name.

Link copied to clipboard

This enum class defines the possible values for the attribute component of an JtxICalObject Use its name when the string representation is required, e.g. Component.VJOURNAL.name.

Link copied to clipboard

This enum class defines the possible values for the attribute module of an JtxICalObject Use its name when the string representation is required, e.g. Module.JOURNAL.name.

Link copied to clipboard

This enum class defines the possible values for the attribute status of an JtxICalObject for Journals/Notes Use its name when the string representation is required, e.g. StatusJournal.DRAFT.name.

Link copied to clipboard

This enum class defines the possible values for the attribute status of an JtxICalObject for Todos Use its name when the string representation is required, e.g. StatusTodo.NEEDS-ACTION.name.

Properties

Link copied to clipboard

Purpose: This property defines the access classification for a calendar component. The possible values of a status are defined in the enum Classification. Use e.g. Classification.PUBLIC.name to put a correct String value in this field. If no valid Classification is used, the value is taken and will be shown as-is. Also null-value is allowed. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.11] Type: String

Link copied to clipboard
const val COLOR: String

Purpose: This property specifies a color used for displaying the calendar, event, t0do, or journal data. See https://tools.ietf.org/html/rfc7986#section-5.9. The color is represented as Int-value as described in [https://developer.android.com/reference/android/graphics/Color#color-ints] Type: Int

Link copied to clipboard
const val COMPLETED: String

Purpose: This property defines the date and time that a to-do was actually completed. This value is stored as UNIX timestamp (milliseconds). The corresponding timezone is stored in COMPLETED_TIMEZONE. See [https://tools.ietf.org/html/rfc5545#section-3.8.2.1] Type: Long

Link copied to clipboard

Purpose: This column/property specifies the timezone of when a to-do was actually completed. The corresponding datetime is stored in COMPLETED. See DTSTART_TIMEZONE for information about the timezone handling See [https://tools.ietf.org/html/rfc5545#section-3.8.2.1] Type: String

Link copied to clipboard
const val COMPONENT: String

The column for the component based on the values provided in the enum Component. Use e.g. Component.VTODO.name for a correct String value in this field. If no Component is provided on Insert, an IllegalArgumentException is thrown Type: String

Link copied to clipboard
const val CONTACT: String

Purpose: This property is used to represent contact information or alternately a reference to contact information associated with the calendar component. See [https://tools.ietf.org/html/rfc5545#section-3.8.4.2] Type: String

Link copied to clipboard

The content uri of the ICalObject table

Link copied to clipboard
const val CREATED: String

Purpose: This property specifies the date and time that the calendar information was created by the calendar user agent in the calendar store and is stored as UNIX timestamp (milliseconds). See [https://tools.ietf.org/html/rfc5545#section-3.8.7.1] Type: Long

Link copied to clipboard
const val DELETED: String

Purpose: This column defines if a collection that is supposed to be synchonized was locally marked as deleted. Type: Boolean

Link copied to clipboard
const val DESCRIPTION: String

Purpose: This column/property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.5] Type: String

Link copied to clipboard
const val DIRTY: String

Purpose: This column defines if the local ICalObject was changed and that it is supposed to be synchronised. Type: Boolean

Link copied to clipboard
const val DTEND: String

Purpose: This column/property specifies when the calendar component ends. This value is stored as UNIX timestamp (milliseconds). The corresponding timezone is stored in DTEND_TIMEZONE. See [https://tools.ietf.org/html/rfc5545#section-3.8.2.4] Type: Long

Link copied to clipboard

Purpose: This column/property specifies the timezone of when the calendar component ends. The corresponding datetime is stored in DTEND. See DTSTART_TIMEZONE for information about the timezone handling See [https://tools.ietf.org/html/rfc5545#section-3.8.2.2] Type: String

Link copied to clipboard
const val DTSTAMP: String

Purpose: In the case of an iCalendar object that specifies a "METHOD" property, this property specifies the date and time that the instance of the iCalendar object was created. In the case of an iCalendar object that doesn't specify a "METHOD" property, this property specifies the date and time that the information associated with the calendar component was last revised in the calendar store. It is saved as UNIX timestamp (milliseconds). See [https://tools.ietf.org/html/rfc5545#section-3.8.7.2] Type: Long

Link copied to clipboard
const val DTSTART: String

Purpose: This column/property specifies when the calendar component begins. This value is stored as UNIX timestamp (milliseconds). The corresponding timezone is stored in DTSTART_TIMEZONE. See [https://tools.ietf.org/html/rfc5545#section-3.8.2.4] Type: Long

Link copied to clipboard

Purpose: This column/property specifies the timezone of when the calendar component begins. The corresponding datetime is stored in DTSTART. The value of a timezone can be:

Link copied to clipboard
const val DUE: String

Purpose: This property defines the date and time that a to-do is expected to be completed. This value is stored as UNIX timestamp (milliseconds). The corresponding timezone is stored in DUE_TIMEZONE. See [https://tools.ietf.org/html/rfc5545#section-3.8.2.3] Type: Long

Link copied to clipboard
const val DUE_TIMEZONE: String

Purpose: This column/property specifies the timezone of when a to-do is expected to be completed. The corresponding datetime is stored in DUE. See DTSTART_TIMEZONE for information about the timezone handling See [https://tools.ietf.org/html/rfc5545#section-3.8.2.2] Type: String

Link copied to clipboard
const val DURATION: String

Purpose: This property specifies a positive duration of time. See DTSTART_TIMEZONE for information about the timezone handling The string representation follows the notation as given in RFC-5545 for the value type duration: [https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.6] Exampe: "P15DT5H0M20S". This field is currently not in use. If present, the user would see a notification that a duration cannot be processed and will be overwritten if the entry is changed. See [https://tools.ietf.org/html/rfc5545#section-3.8.2.5] Type: String

Link copied to clipboard
const val ETAG: String

Purpose: eTag for SyncAdapter, only relevant for synched entries through sync-adapter Type: String

Link copied to clipboard
const val EXDATE: String

Purpose: This property defines the list of DATE-TIME exceptions for recurring events, to-dos, journal entries, or time zone definitions. Type: String, contains a list of comma-separated date values as UNIX timestamps (milliseconds) e.g. "1636751475000,1636837875000". Invalid values that cannot be transformed to Long are ignored.

Link copied to clipboard

Purpose: To specify the filename of the attachment. This is an X-PROPERTY that should be addressed as "X-LABEL" Type: String

Link copied to clipboard
const val FILENAME: String

Purpose: The remote file name of the synchronized entry (*.ics), only relevant for synchronized entries through the sync-adapter Type: String

Link copied to clipboard
const val FLAGS: String

Purpose: flags for SyncAdapter, only relevant for synched entries through sync-adapter Type: Int

Link copied to clipboard
const val GEO_LAT: String

Purpose: This property specifies information related to the global position for the activity specified by a calendar component. This property is split in the fields GEO_LAT for the latitude and GEO_LONG for the longitude coordinates using the WGS84 ellipsoid. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.6] Type: Float

Link copied to clipboard
const val GEO_LONG: String

Purpose: This property specifies information related to the global position for the activity specified by a calendar component. This property is split in the fields GEO_LAT for the latitude and GEO_LONG for the longitude coordinates using the WGS84 ellipsoid. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.6] Type: Double

Link copied to clipboard

Purpose: Defines the radius for a geofence in meters This is put into an extended property in the iCalendar-file Type: String

Link copied to clipboard

Purpose: This column is the foreign key to the JtxCollection. Type: Long, references JtxCollection.ID

Link copied to clipboard
const val ID: String

The name of the ID column. This is the unique identifier of an ICalObject. Type: Long

Link copied to clipboard

Purpose: This property specifies the date and time that the information associated with the calendar component was last revised in the calendar store. It is saved as UNIX timestamp (milliseconds). See [https://tools.ietf.org/html/rfc5545#section-3.8.7.3] Type: Long

Link copied to clipboard
const val LOCATION: String

Purpose: This property defines the intended venue for the activity defined by a calendar component. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.7] Type: Double

Link copied to clipboard

Purpose: This property defines the alternative representation of the intended venue for the activity defined by a calendar component. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.7] Type: String

Link copied to clipboard
const val MODULE: String

The column for the module. This is an internal differentiation for JOURNAL, NOTE and T0DO as provided in the enum Module. The Module does not need to be set. On import it will be derived from the component from the Component (T0do or Journal/Note) and if a dtstart is present or not (Journal or Note). If the module was set, it might be overwritten on import. In this sense also unknown values are overwritten. Use e.g. Module.JOURNAL.name for a correct String value in this field. Type: String

Link copied to clipboard
const val OTHER: String

Purpose: To specify other properties for the ICalObject. This is especially used for additional properties that cannot be put into another field, especially relevant for the synchronization The Properties are stored as JSON. There are two helper functions provided: getJsonStringFromXProperties(PropertyList<*> that returns a Json String from the property list to be stored in this other field. The counterpart to this function is getXPropertyListFromJson(String) that returns a PropertyList from a Json that was created with getJsonStringFromXProperties() Type: String

Link copied to clipboard
const val PERCENT: String

Purpose: This property is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the "Organizer". The value must either be null or between 0 and 100. The value 0 is interpreted as null. If a value outside of the boundaries (0-100) is passed, the value is reset to null. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.8] Type: Int

Link copied to clipboard
const val PRIORITY: String

Purpose: This property defines the relative priority for a calendar component. See https://tools.ietf.org/html/rfc5545#section-3.8.1.9. The priority can be null or between 0 and 9. Values outside of these boundaries are accepted but internally not mapped to a string resource. Type: Int

Link copied to clipboard
const val RDATE: String

Purpose: This property defines the list of DATE-TIME values for recurring events, to-dos, journal entries, or time zone definitions. Type: String, contains a list of comma-separated date values as UNIX timestamps (milliseconds) e.g. "1636751475000,1636837875000". Invalid values that cannot be transformed to Long are ignored.

Link copied to clipboard

Stores the reference to the original event from which the recurring event was derived. This value is NULL for the orignal event or if the event is not recurring Type: Long, References JtxICalObject.ID

Link copied to clipboard
const val RECURID: String

Purpose: This property is used in conjunction with the "UID" and "SEQUENCE" properties to identify a specific instance of a recurring "VEVENT", "VTODO", or "VJOURNAL" calendar component. The property value is the original value of the "DTSTART" property of the recurrence instance, ie. a DATE or DATETIME value e.g. "20211101T160000". Must be null for non-recurring and original events from which recurring events are derived. Type: String

Link copied to clipboard

Purpose: This property is used in conjunction with the "UID" and "SEQUENCE" properties to identify a specific instance of a recurring "VEVENT", "VTODO", or "VJOURNAL" calendar component. The property value is the original value of the "DTSTART" property of the recurrence instance, ie. a DATE or DATETIME value e.g. "20211101T160000". Must be null for non-recurring and original events from which recurring events are derived. Type: String?

Link copied to clipboard
const val RRULE: String

Purpose: This property defines a rule or repeating pattern for recurring events, to-dos, journal entries, or time zone definitions. The representation of the RRULE follows the value type RECUR of RFC-5545 as given in [https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10] For example: "FREQ=DAILY;COUNT=10" See also https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.5.3. Type: String

Link copied to clipboard
const val SCHEDULETAG: String

Purpose: scheduleTag for SyncAdapter, only relevant for synched entries through sync-adapter Type: String

Link copied to clipboard
const val SEQUENCE: String

Purpose: This property defines the revision sequence number of the calendar component within a sequence of revisions. If no sequence is present, it is automatically initialized with 0 See [https://tools.ietf.org/html/rfc5545#section-3.8.7.4] Type: Int

Link copied to clipboard
const val STATUS: String

Purpose: This property defines the overall status or confirmation for the calendar component. The possible values of a status are defined in StatusTodo for To-Dos and in StatusJournal for Notes and Journals If no valid Status is used, the value is taken and will be shown as-is. Also null-value is allowed. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.11] Type: String

Link copied to clipboard
const val SUMMARY: String

Purpose: This column/property defines a short summary or subject for the calendar component. See [https://tools.ietf.org/html/rfc5545#section-3.8.1.12] Type: String

Link copied to clipboard
const val TZ_ALLDAY: String

Constant to define all day values (for dtstart, due, completed timezone fields

Link copied to clipboard
const val UID: String

Purpose: This property defines the persistent, globally unique identifier for the calendar component. See [https://tools.ietf.org/html/rfc5545#section-3.8.4.7] Type: String

Link copied to clipboard
const val URL: String

Purpose: This property defines a Uniform Resource Locator (URL) associated with the iCalendar object. See [https://tools.ietf.org/html/rfc5545#section-3.8.4.6] Type: String