4d-plugin-ical

4D plugin to access Calendar.app data.

Platform

carbon	cocoa	win32	win64

A new command iCal Request permisson has been added. You must call this once before you use other commands.

You must codesign your app with the following entitlements:

• com.apple.security.automation.apple-events
• com.apple.security.personal-information.calendars

The app must also have the following property list keys:

• NSCalendarsUsageDescription
• NSAppleEventsUsageDescription

See build-application

---

calendars:=iCal Get calendars

Parameter	Type	Description
calendars	TEXT	JSON Is collection. each item represents a calendar

timezones:=iCal Get timezones 

Parameter	Type	Description
timezones	TEXT	JSON Is collection. each item represents a timezone

error:=iCal Add event(event)

Parameter	Type	Description
event	TEXT	JSON Is object. startDate and endDate and calendar are mandatory
uid	TEXT

error:=iCal Modify event(event{;date})

Parameter	Type	Description
event	TEXT	JSON Is object. uid is mandatory
date	TEXT	speficy a single occurance of a recurring event
error	LONGINT	0 on success

event:=iCal Find event(event{;date})

Parameter	Type	Description
event	TEXT	JSON Is object. uid is mandatory
date	TEXT	speficy a single occurance of a recurring event
event	TEXT	JSON Is object

Changed syntax

iCal SET NOTIFICATION METHOD (method)
method:=iCal Get notification method 

Parameter	Type	Description
method	TEXT

Warning: Old syntax will crash instantly!

• callback signature

param	type	description
event	TEXT	event ID
type	LONGINT	0:created, 1:updated, 2:deleted

---

Deprecated commands

Not thread safe => thread safe

• iCal Get event property => iCal Find event

• iCal Get task property => deprecated

• iCal Get calendar property => iCal Get calendars

• iCal Get alarm property => iCal Find event

• iCal Count event alarms => iCal Find event

• iCal Count task alarms => deprecated

• iCal Get task alarm => deprecated

• iCal Get event alarm => iCal Find event

• iCal QUERY EVENT

• iCal QUERY TASK => deprecated

• iCal TIMEZONE LIST => iCal Get timezones

• iCal GET CALENDAR LIST => iCal Get calendars

• iCal Create event => iCal Add event

• iCal Set event properties => iCal Modify event

• iCal app Get task property => deprecated

• iCal app Get event property => iCal Find event

---

TODO

support recurrence with

• iCal Find event done
• iCal Modify event
• iCal Add event

create replacement for deprecated

• iCal QUERY EVENT

---

Recurrence (deprecated)

success:=iCal Set event recurrence (event;kind;interval;endDate;daysOfWeek;weeksOfMonth;monthOfYear)

Parameter	Type	Description
event	TEXT
kind	TEXT	Daily, Weekly, Monthly, Yearly
interval	LONGINT	1 = every, 2 = every other, etc
endDate	TEXT	"" = no end
daysOfWeek	TEXT	csv
weeksOfMonth	TEXT	csv
monthOfYear	TEXT	csv

iCal Set event property + Event recurrence does nothing; use dedicated command instead

success:=iCal Set event property (event;property;value)
success:=iCal Get event property (event;property;value)

Parameter	Type	Description
event	TEXT
property	TEXT
property	TEXT

when Event recurrence is passed to iCal Get event property, value is returned in JSON.

{
recurrenceInterval:number,
firstDayOfTheWeek:"" or "Monday" or "Tuesday" or...,
recurrenceType:"" or "Daily" or "Weekly" or "Monthly" or "Yearly",
recurrenceEnd:{occurrenceCount:number, endDate:"" or GMT},
daysOfTheWeek:[array or numbers],
daysOfTheMonth:[array or numbers],
nthWeekDaysOfTheMonth:[array or numbers],
monthsOfTheYear:[array or numbers]
}

---

App control (updated)

These commands internally use NSAppleScript NSTask

iCal SHOW TASK iCal SHOW EVENT

These commands internally use NSAppleScript SBApplication

iCal SET VIEW iCal SHOW DATE

This command internally uses NSRunningApplication

iCal TERMINATE

This command internally uses NSWorkspace

iCal LAUNCH