ical4android/at.bitfire.ical4android

Package-level declarations

Types

abstract class AndroidCalendar<out T : AndroidEvent>(val account: Account, val provider: ContentProviderClient, val eventFactory: AndroidEventFactory<T>, val id: Long)

Represents a locally stored calendar, containing AndroidEvents (whose data objects are Events). Communicates with the Android Contacts Provider which uses an SQLite database to store the events.

AndroidCalendarFactory

interface AndroidCalendarFactory<out T : AndroidCalendar<AndroidEvent>>

AndroidCompatTimeZoneRegistry

class AndroidCompatTimeZoneRegistry(base: TimeZoneRegistry) : TimeZoneRegistry

Wrapper around default TimeZoneRegistry that uses the Android name if a time zone has a different name in ical4j and Android.

AndroidEvent

abstract class AndroidEvent(val calendar: AndroidCalendar<AndroidEvent>)

Stores and retrieves VEVENT iCalendar objects (represented as Events) to/from the Android Calendar provider.

AndroidEventFactory

interface AndroidEventFactory<out T : AndroidEvent>

AttendeeMappings

object AttendeeMappings

Defines mappings between Android CalendarContract.Attendees and iCalendar parameters.

BatchOperation

class BatchOperation(providerClient: ContentProviderClient, maxOperationsPerYieldPoint: Int? = null)

CalendarStorageException

class CalendarStorageException : Exception

Indicates a problem with a calendar storage operation, like when a row can't be inserted or updated.

Css3Color

enum Css3Color : Enum<Css3Color>

Represents an RGBA COLOR value, as specified in https://tools.ietf.org/html/rfc7986#section-5.9

DmfsTask

abstract class DmfsTask(val taskList: DmfsTaskList<DmfsTask>)

Stores and retrieves VTODO iCalendar objects (represented as Tasks) to/from the tasks.org-content provider (currently tasks.org and OpenTasks).

DmfsTaskFactory

interface DmfsTaskFactory<out T : DmfsTask>

DmfsTaskList

abstract class DmfsTaskList<out T : DmfsTask>(val account: Account, val provider: ContentProviderClient, val providerName: TaskProvider.ProviderName, val taskFactory: DmfsTaskFactory<T>, val id: Long)

Represents a locally stored task list, containing DmfsTasks (tasks). Communicates with tasks.org-compatible content providers (currently tasks.org and OpenTasks) to store the tasks.

DmfsTaskListFactory

interface DmfsTaskListFactory<out T : DmfsTaskList<DmfsTask>>

Event

data class Event(var uid: String? = null, var sequence: Int? = null, var userAgents: LinkedList<String> = LinkedList(), var recurrenceId: RecurrenceId? = null, var summary: String? = null, var location: String? = null, var url: URI? = null, var description: String? = null, var color: Css3Color? = null, var dtStart: DtStart? = null, var dtEnd: DtEnd? = null, var duration: Duration? = null, val rRules: LinkedList<RRule> = LinkedList(), val exRules: LinkedList<ExRule> = LinkedList(), val rDates: LinkedList<RDate> = LinkedList(), val exDates: LinkedList<ExDate> = LinkedList(), val exceptions: LinkedList<Event> = LinkedList(), var classification: Clazz? = null, var status: Status? = null, var opaque: Boolean = true, var organizer: Organizer? = null, val attendees: LinkedList<Attendee> = LinkedList(), val alarms: LinkedList<VAlarm> = LinkedList(), var lastModified: LastModified? = null, val categories: LinkedList<String> = LinkedList(), val unknownProperties: LinkedList<Property> = LinkedList()) : ICalendar

ICalendar

open class ICalendar

InvalidCalendarException

class InvalidCalendarException : Exception

JtxCollection

open class JtxCollection<out T : JtxICalObject>(val account: Account, val client: ContentProviderClient, iCalObjectFactory: JtxICalObjectFactory<JtxICalObject>, val id: Long)

JtxCollectionFactory

interface JtxCollectionFactory<out T : JtxCollection<JtxICalObject>>

JtxICalObject

open class JtxICalObject(val collection: JtxCollection<JtxICalObject>)

JtxICalObjectFactory

interface JtxICalObjectFactory<out T : JtxICalObject>

Task

data class Task(var createdAt: Long? = null, var lastModified: Long? = null, var summary: String? = null, var location: String? = null, var geoPosition: Geo? = null, var description: String? = null, var color: Int? = null, var url: String? = null, var organizer: Organizer? = null, @IntRange(from = 0, to = 9) var priority: Int = Priority.UNDEFINED.level, var classification: Clazz? = null, var status: Status? = null, var dtStart: DtStart? = null, var due: Due? = null, var duration: Duration? = null, var completedAt: Completed? = null, @IntRange(from = 0, to = 100) var percentComplete: Int? = null, var rRule: RRule? = null, val rDates: LinkedList<RDate> = LinkedList(), val exDates: LinkedList<ExDate> = LinkedList(), val categories: LinkedList<String> = LinkedList(), var comment: String? = null, var relatedTo: LinkedList<RelatedTo> = LinkedList(), val unknownProperties: LinkedList<Property> = LinkedList(), val alarms: LinkedList<VAlarm> = LinkedList()) : ICalendar

TaskProvider

class TaskProvider : Closeable

UnknownProperty

object UnknownProperty

Helpers to (de)serialize unknown properties as JSON to store it in an Android ExtendedProperty row.

Properties

ical4jVersion

const val ical4jVersion: <Error class: unknown class>

The used version of ical4j.