lib/at.bitfire.synctools.storage.calendar/AndroidCalendar

AndroidCalendar

class AndroidCalendar(provider: AndroidCalendarProvider, values: ContentValues)

Represents a locally stored calendar containing events, each represented by an Entity. Communicates with the Android calendar provider which uses an SQLite database to store the events.

Methods that use ContentValues operate directly on rows of the Events table. Methods that use Entity operate on EventsEntity URIs to access the Events rows together with associated data rows (reminders, attendees etc.)

Parameters

client

calendar provider

values

content values as read from the calendar provider; android.provider.BaseColumns._ID must be set

Throws

IllegalArgumentException

when Calendars._ID is not set

Constructors

AndroidCalendar

constructor(provider: AndroidCalendarProvider, values: ContentValues)

Types

StatusUpdateWorkaround

enum StatusUpdateWorkaround : Enum<AndroidCalendar.StatusUpdateWorkaround>

Properties

val accessLevel: Int

see Calendars.CALENDAR_ACCESS_LEVEL

val account: Account

val client: ContentProviderClient

val displayName: String?

see Calendars.CALENDAR_DISPLAY_NAME

eventEntitiesUri

val eventEntitiesUri: Uri

val eventsUri: Uri

val id: Long

see Calendars._ID

val logger: Logger

val name: String?

see Calendars.NAME

val ownerAccount: String?

see Calendars.OWNER_ACCOUNT

val syncId: String?

see Calendars._SYNC_ID

Functions

fun addEvent(entity: Entity): Long

Inserts an event to the calendar provider.

fun addEvent(entity: Entity, batch: CalendarBatchOperation)

fun countEvents(where: String?, whereArgs: Array<String>?): Int

Counts the number of events in this calendar that match the given selection criteria.

fun delete(): Int

Calls AndroidCalendarProvider.deleteCalendar for this calendar.

deleteAllEvents

@TestOnly

fun deleteAllEvents()

Deletes all events of this calendar from the local storage.

deleteDirtyEventsWithoutInstances

fun deleteDirtyEventsWithoutInstances()

Marks dirty events

fun deleteEvent(id: Long)

Deletes an event row.

fun eventEntityUri(id: Long): Uri

fun eventUri(id: Long): Uri

fun findEvent(where: String?, whereArgs: Array<String>?, sortOrder: String? = null): Entity?

Gets the first event from this calendar that matches the given query.

fun findEventRow(projection: Array<String>?, where: String?, whereArgs: Array<String>?): ContentValues?

Gets the first event row that matches the given query.

fun findEvents(where: String?, whereArgs: Array<String>?): List<Entity>

Queries events from this calendar.

fun getEvent(id: Long, where: String? = null, whereArgs: Array<String>? = null): Entity?

Gets a specific event, identified by its ID, from this calendar.

fun getEventRow(id: Long, projection: Array<String>? = null, where: String? = null, whereArgs: Array<String>? = null): ContentValues?

Gets the event row of a specific event, identified by its ID, from this calendar.

iterateEventRows

fun iterateEventRows(projection: Array<String>?, where: String?, whereArgs: Array<String>?, body: (ContentValues) -> Unit)

Iterates event rows from this calendar.

fun iterateEvents(where: String?, whereArgs: Array<String>?, body: (Entity) -> Unit)

Iterates event entities from this calendar.

fun numInstances(eventId: Long, checkSyncEvents: Boolean = true): Int?

Queries the Instances.CONTENT_URI to finds the number of instances of the given event, excluding deleted and canceled exceptions.

fun readSyncState(): String?

Calls AndroidCalendarProvider.readCalendarSyncState for this calendar.

fun update(newValues: ContentValues)

Calls AndroidCalendarProvider.updateCalendar for this calendar and merges newValues into the cached values.

fun updateEvent(id: Long, entity: Entity): Long

Updates an event and applies the eventStatus=null workaround, if necessary.

fun updateEvent(id: Long, entity: Entity, batch: CalendarBatchOperation): Int?

Enqueues an update of an event and applies the eventStatus=null workaround, if necessary.

fun updateEventRow(id: Long, values: ContentValues)

fun updateEventRow(id: Long, values: ContentValues, batch: CalendarBatchOperation)

Updates a specific event's main row with the given values. Doesn't influence data rows.

updateEventRows

fun updateEventRows(values: ContentValues, where: String?, whereArgs: Array<String>?): Int

Updates event rows in this calendar.

fun writeSyncState(newState: String?)

Calls AndroidCalendarProvider.writeCalendarSyncState for this calendar.