Android Programming Press on the image to return to the main documentation page.

iEventKit

List of types:

CalendarAlarm
CalendarEvent
EventStore
Reminder

CalendarAlarm


Events:

None

Members:


  AbsoluteDate As Long

  InitializeAbsolute (Date As Long)

  InitializeRelative (Minutes As Double)

  IsInitialized As Boolean

  RelativeMinutes As Double

  Tag As Object

Members description:

AbsoluteDate As Long
Gets or sets the absolute time. Returns 0 if there is no absolute time.
InitializeAbsolute (Date As Long)
Initializes an alarm that fires at the specified absolute time.
InitializeRelative (Minutes As Double)
Initiaizes an alarm that fires X minutes before the event start time.
IsInitialized As Boolean
Tests whether this object was initialized.
RelativeMinutes As Double
Gets or sets the offset measured in minutes before the start time.
Tag As Object
Gets or sets the Tag object. This is a placeholder for any object you like to tie to this object.

CalendarEvent


Events:

None

Members:


  AddAlarm (Alarm As CalendarAlarm)

  Alarms As List [read only]

  AllDay As Boolean

  EndDate As Long

  Identifier As String [read only]

  IsInitialized As Boolean

  Location As String

  RemoveAlarm (Alarm As CalendarAlarm)

  StartDate As Long

  Tag As Object

  Title As String

Members description:

AddAlarm (Alarm As CalendarAlarm)
Adds an alarm to the item.
Alarms As List [read only]
Returns a list with the set alarms. Modifying the list will not have any effect on the alarms.
AllDay As Boolean
Gets or sets whether this is an all day event.
EndDate As Long
Identifier As String [read only]
IsInitialized As Boolean
Tests whether this object was initialized.
Location As String
Gets or sets the item's location.
RemoveAlarm (Alarm As CalendarAlarm)
Removes an alarm.
StartDate As Long
Tag As Object
Gets or sets the Tag object. This is a placeholder for any object you like to tie to this object.
Title As String
Gets or sets the item's title.

EventStore

Provides access to the device Calendar database. This includes calendar events and reminders.
You must add the following usage description for each of the features:
#PlistExtra:<key>NSCalendarsUsageDescription</key><string>description here...</string>
#PlistExtra:<key>NSRemindersUsageDescription</key><string>description here...</string>

Events:

AuthorizationGrantedEvents (Success As Boolean)
AuthorizationGrantedReminders (Success As Boolean)
EventsReady (Success As Boolean, Events As List)
RemindersReady (Success As Boolean, Reminders As List)

Members:


  AUTHORIZATION_AUTHORIZED As Int [read only]

  AUTHORIZATION_DENIED As Int [read only]

  AUTHORIZATION_NOT_DETERMINED As Int [read only]

  AUTHORIZATION_RESTRICTED As Int [read only]

  AuthorizationStatusEvents As Int

  AuthorizationStatusReminders As Int

  CreateEvent As CalendarEvent

  CreateReminder As Reminder

  FindEvents (StartDate As Long, EndDate As Long)

  FindReminders (StartDate As Long, EndDate As Long, Completed As Boolean)

  GetEvent (Identifier As String) As CalendarEvent

  GetReminder (Identifier As String) As Reminder

  Initialize (EventName As String)

  RemoveEvent (Event As Object, IncludeFutureEvents As Boolean)

  RemoveReminder (Reminder As Object)

  RequestAccessEvents

  RequestAccessReminders

  SaveEvent (Event As Object, IncludeFutureEvents As Boolean)

  SaveReminder (Reminder As Object)

Members description:

AUTHORIZATION_AUTHORIZED As Int [read only]
The user granted access.
AUTHORIZATION_DENIED As Int [read only]
The user denied access for this application.
AUTHORIZATION_NOT_DETERMINED As Int [read only]
The user has not yet denied or granted access. A dialog will be displayed when the RequestAccess method is called.
AUTHORIZATION_RESTRICTED As Int [read only]
Application is not authorized and user is restricted from changing its state (parental control for example).
AuthorizationStatusEvents As Int
Returns the current authorization status.
AuthorizationStatusReminders As Int
Returns the current authorization status.
CreateEvent As CalendarEvent
Creates a new event.
CreateReminder As Reminder
Creates a new reminder.
FindEvents (StartDate As Long, EndDate As Long)
Fetches all the calendar events between the specified dates. Note that the maximum date range is 4 years.
The EventsReady event will be raised.
FindReminders (StartDate As Long, EndDate As Long, Completed As Boolean)
Fetches all reminders based on the following criterions:
If Completed is true, it returns all completed reminders with completion date in the specified date range.
If Completed is false, it returns all uncompleted reminders with due date in the specified date range.
StartDate and EndDate are optional. Pass 0 for an open range.
GetEvent (Identifier As String) As CalendarEvent
Returns the calendar event with the given identifier.
GetReminder (Identifier As String) As Reminder
Returns the reminder with the given identifier.
Initialize (EventName As String)
RemoveEvent (Event As Object, IncludeFutureEvents As Boolean)
Removes the event.
IncludeFutureEvents - Whether to also remove all future events (for recurring events).
RemoveReminder (Reminder As Object)
Removes the reminder.
RequestAccessEvents
Requests access to calender events.
A dialog will be displayed on the first run.
The AuthorizationGrantedEvents event will be raised with the result.
RequestAccessReminders
Requests access to the reminders.
A dialog will be displayed on the first run.
The AuthorizationGrantedReminders event will be raised with the result.
SaveEvent (Event As Object, IncludeFutureEvents As Boolean)
Saves the event.
IncludeFutureEvents - Whether to also update all future events (for recurring events).
SaveReminder (Reminder As Object)
Saves the reminder.

Reminder


Events:

None

Members:


  AddAlarm (Alarm As CalendarAlarm)

  Alarms As List [read only]

  Completed As Boolean

  CompletedDate As Long [read only]

  DueDate As Long [read only]

  Identifier As String [read only]

  IsInitialized As Boolean

  Location As String

  Priority As Int

  RemoveAlarm (Alarm As CalendarAlarm)

  SetDueDate (Date As Long, AllDay As Boolean)

  SetStartDate (Date As Long, AllDay As Boolean)

  StartDate As Long [read only]

  Tag As Object

  Title As String

Members description:

AddAlarm (Alarm As CalendarAlarm)
Adds an alarm to the item.
Alarms As List [read only]
Returns a list with the set alarms. Modifying the list will not have any effect on the alarms.
Completed As Boolean
Gets or sets whether the reminder considered completed.
CompletedDate As Long [read only]
Returns the completed date. Returns 0 if not available.
DueDate As Long [read only]
Gets the due date. Returns 0 if there is no due date. Use SetDueDate to set this field.
Identifier As String [read only]
IsInitialized As Boolean
Tests whether this object was initialized.
Location As String
Gets or sets the item's location.
Priority As Int
Gets or sets the priority (0 - 9).
RemoveAlarm (Alarm As CalendarAlarm)
Removes an alarm.
SetDueDate (Date As Long, AllDay As Boolean)
Sets the due date.
SetStartDate (Date As Long, AllDay As Boolean)
Sets the start date.
StartDate As Long [read only]
Gets the start date. Returns 0 if there is no start date. Use SetStartDate to set this field.
Tag As Object
Gets or sets the Tag object. This is a placeholder for any object you like to tie to this object.
Title As String
Gets or sets the item's title.
Top