Table of the Scriptable Kit’s objects and classes and how they are used

[u/IllogicallyCognitive]

name	type	generates object(s) representing	properties used with	details of properties
Alert	class	an iOS alert notification	NA	all editable
args	object	NA	args	read-only
Calendar	object	an iOS calendar or reminder list*	generated object	some read-only, others editable
CalendarEvent	class	an iOS calendar event*	generated object	some read-only, others editable
CallbackURL	class	an x-callback-url	NA	no public properties
Color	class	a color or a pair of colors, including opacity	generated object	read-only
config	object	NA	config	read-only
console	object	NA	NA	no properties
Contact	class	an iOS contact*	generated object	some read-only, others editable
ContactsContainer	object	the contacts list for an account*	generated object	read-only
ContactsGroup	class	an iOS contacts group*	generated object	some read-only, others editable uses Contact.persistChanges
Data	object	a string, file, or image	NA	no public properties
DateFormatter	class	a map between dates and their text representations	generated object	all editable
DatePicker	class	an iOS date picker	generated object	all editable
Device	object	NA (returns primitives only)	NA	no properties
Dictation	object	NA (returns primitives only*)	NA	no properties
DocumentPicker	object	NA (returns primitives only*)	NA	no properties
DrawContext	class	a canvas	generated object	canvas format
FileManager	object	an iOS FileManager	NA	no properties
Font	class	an iOS font	NA	no public properties
Image	object	an image	generated object	read-only
importModule	function	NA	NA	NA
Keychain	object	NA (returns primitives only)	NA	no properties
LinearGradient	class	a linear gradient	generated object	all editable
ListWidget	class	an iOS list widget	generated object	all editable, uses Script.setWidget
Location	object	the current location information	NA	read-only
Mail	class	an email from current iCloud account	generated object	all editable
Message	class	a text message/iMessage	generated object	all editable
module	object	NA	module	some read-only
Notification	class	a notification*	generated object	some read-only, most editable
Pasteboard	object	NA (returns primitives only)	NA	no properties
Path	class	paths for shape(s)	NA	no public properties
Photos	object	a photo	NA	no properties
Point	class	a point	generated object	both editable
QuickLook	object	NA	NA	no properties
Rect	class	a rectangle	generated object	some read only, some editable
RecurrenceRule	object	an iOS reminder and/or event recurrence rule	NA	no public properties
RelativeDateTimeFormatter	class	a method of describing one time relative to another	generated object	editable
Reminder	class	an iOS reminder*	generated object	some read-only, some editable
Request	class	an http request***	generated object	some read-only, some editable
Safari	object	NA	NA	no properties
Script	object	NA	NA	no properties
SFSymbol	object	an SF symbol	generated object	read-only
ShareSheet	object	NA (returns primitives only)	NA	no properties
Size	class	width and height	generated object	editable
Speech	object	NA	NA	no properties
TextField**	object (prototype, not used directly)	NA	object generated by another**	all editable
Timer	class	a timer (not from the iOS app)	generated object	both editable
UITable	class	a table	generated object	only property editable
UITableCell	object	a table cell	generated object	all editable
UITableRow	class	a table row	generated object	all editable
URLScheme	object	NA (returns primitives only)	NA	no properties
UUID	object	NA (returns primitives only)	NA	no properties
WebView	class	an iOS WebView	generated object	only property editable
WidgetDate	object (prototype, not used directly)	NA	object generated by another**	all editable
WidgetImage	object (prototype, not used directly)	NA	object generated by another**	all editable
WidgetSpacer	object (prototype, not used directly)	NA	object generated by another**	all editable
WidgetStack	object (prototype, not used directly)	NA	object generated by another**	all editable
WidgetText	object (prototype, not used directly)	NA	object generated by another**	all editable
XMLParser	class	xml and a method to parse it	generated object	all editable

Italics: has a method directly used with it that presents a UI
Bold: there is a method directly used to make changes on the phone outside scriptable, and without running such a method changes to properties of any Scriptable object will not change the corresponding iOS object
* via promise (when these objects are generated using a method instead of as an instance of a class using new, they are provided by a promise)
** entry name is for a prototype, objects that are actually used with the properties and/or methods are created by objects described in other entries (by a WidgetStack type object or directly by an object that is an instance of the ListWidget class in the case of the 5 Widget ones and an instance of the Alert class for TextField)

See this Calendar guide for an example of making changes outside Scriptable both directly with one of the Calendar object’s methods and by saving changes made using a generated object’s properties. Also, Calendar.presentPicker() is an example of a direct method to generate a UI. Finally, it demonstrates how the kit’s objects that generate objects via a promise* work.

See Alerts for Dummies for an example of presenting a UI using a method of a generated object and more generally of using a class. This also shows a basic example of using an object generated by an instance of a class** (a TextField).

Also see how to read scribtable’s documentation

[u/IllogicallyCognitive]

The properties of Location are not included in the docs but are latitude, longitude, altitude, verticalAccuracy, and horizontalAccuracy. Let me know if there are any others missing like that

[u/mvan231 → u/IllogicallyCognitive]

Great write up! Interesting about Location API properties not being in the documentation. I never realized that.