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

AndroidCalendar

class AndroidCalendar(val provider: AndroidCalendarProvider, val values: ContentValues)

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

Parameters

client

calendar provider

values

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

Throws

IllegalArgumentException

when android.provider.BaseColumns._ID is not set

Constructors

AndroidCalendar

constructor(provider: AndroidCalendarProvider, values: ContentValues)

Properties

accessLevel

val accessLevel: Int

see Calendars.CALENDAR_ACCESS_LEVEL

account

val account: Account

client

val client: ContentProviderClient

displayName

val displayName: String?

see Calendars.CALENDAR_DISPLAY_NAME

eventsUri

val eventsUri: Uri

val id: Long

see Calendars._ID

name

val name: String?

see Calendars.NAME

ownerAccount

val ownerAccount: String?

see Calendars.OWNER_ACCOUNT

provider

val provider: AndroidCalendarProvider

syncId

val syncId: String?

see Calendars._SYNC_ID

values

val values: ContentValues

Functions

delete

fun delete(): Int

Calls AndroidCalendarProvider.deleteCalendar for this calendar.

eventUri

fun eventUri(id: Long): Uri

findEvents

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

Queries events from this calendar.

getEvent

fun getEvent(id: Long): AndroidEvent?

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

getEventValues

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

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

iterateEvents

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

Iterates events from this calendar.

numDirectInstances

fun numDirectInstances(eventId: Long): Int?

Finds the amount of direct instances this event has (without exceptions); used by numInstances to find the number of instances of exceptions.

numInstances

fun numInstances(eventId: Long): Int?

Finds the total number of instances this event has (including instances of exceptions)

readSyncState

fun readSyncState(): String?

Calls AndroidCalendarProvider.readCalendarSyncState for this calendar.

update

fun update(values: ContentValues): Int

Calls AndroidCalendarProvider.updateCalendar for this calendar.

updateEvent

fun updateEvent(id: Long, values: ContentValues)

Updates a specific event's main row with the given values.

updateEvents

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

Updates events in this calendar.

writeSyncState

fun writeSyncState(newState: String?)

Calls AndroidCalendarProvider.writeCalendarSyncState for this calendar.