Skip to content

Calendar ​

Events and reminders.

import Calendar;

editCalendarEvent ​

editCalendarEvent(property: Enum, value: Any, durationUnit: Enum) -> CalendarEvent
ParameterTypeDefault
propertyDuration—
valueAny—
durationUnitminutes | hours | days—
editCalendarEvent(property: Enum, value: Any) -> CalendarEvent
ParameterTypeDefault
propertyTitle | Location | Start Date | End Date | Calendar | Is All Day | Notes | URL | Has Alarms | Attendees | Organizer | Creation Date | Last Modified Date | Time Zone—
valueAny—

Shortcuts action: is.workflow.actions.setters.calendarevents

editReminder ​

editReminder(property: Enum, value: Any, priorityLevel: Enum) -> Reminder
ParameterTypeDefault
propertyPriority—
valueAny—
priorityLevelNone | Low | Medium | High—
editReminder(property: Enum, value: Any) -> Reminder
ParameterTypeDefault
propertyTitle | Is Completed | Completion Date | Due Date | Reminder List | Has Alarms | Notes | Creation Date | Last Modified Date—
valueAny—

Shortcuts action: is.workflow.actions.setters.reminders

findCalendarEvents ​

findCalendarEvents(sortBy: Enum, order: Enum, WFContentItemLimit: Boolean, WFContentItemLimitNumber: Number) -> CalendarEvent
ParameterTypeDefault
sortByTitle | Location | Start Date | End Date | Calendar | Is All Day | Notes | URL | Has Alarms | Duration | Attendees | Organizer | Creation Date | Last Modified Date | Time Zone—
orderLatest First | Oldest First—
WFContentItemLimitBooleanfalse
WFContentItemLimitNumberNumber5

Shortcuts action: is.workflow.actions.filter.calendarevents

findEventAttendees ​

findEventAttendees(sortBy: Enum, order: Enum, WFContentItemLimit: Boolean, WFContentItemLimitNumber: Number) -> EventAttendee
ParameterTypeDefault
sortByName | Email Address | Is Me | Role | Status—
orderLatest First | Oldest First—
WFContentItemLimitBooleanfalse
WFContentItemLimitNumberNumber5

Shortcuts action: is.workflow.actions.filter.eventattendees

findReminders ​

findReminders(sortBy: Enum, order: Enum, WFContentItemLimit: Boolean, WFContentItemLimitNumber: Number) -> Reminder
ParameterTypeDefault
sortByTitle | Is Completed | Completion Date | Due Date | Reminder List | Has Alarms | Priority | Notes | Creation Date | Last Modified Date—
orderLatest First | Oldest First—
WFContentItemLimitBooleanfalse
WFContentItemLimitNumberNumber5

Shortcuts action: is.workflow.actions.filter.reminders

getDetailsOfCalendarEvents ​

getDetailsOfCalendarEvents(get: Enum) -> Any
ParameterTypeDefault
getTitle | Location | Start Date | End Date | Calendar | Is All Day | Notes | URL | Has Alarms | Duration | Attendees | Organizer | Creation Date | Last Modified Date | Time Zone—

Shortcuts action: is.workflow.actions.properties.calendarevents

getDetailsOfEventAttendees ​

getDetailsOfEventAttendees(get: Enum) -> Any
ParameterTypeDefault
getName | Email Address | Is Me | Role | Status—

Shortcuts action: is.workflow.actions.properties.eventattendees

getDetailsOfReminders ​

getDetailsOfReminders(get: Enum) -> Any
ParameterTypeDefault
getTitle | Is Completed | Completion Date | Due Date | Reminder List | Has Alarms | Priority | Notes | Creation Date | Last Modified Date—

Shortcuts action: is.workflow.actions.properties.reminders

getUpcomingEvents ​

Gets upcoming calendar events, ordered from nearest to farthest away in time.

getUpcomingEvents(calendar: Text, WFGetUpcomingItemCount: Number, day: Enum, specifiedDay: Text) -> CalendarEvent
ParameterTypeDefault
calendarText—
WFGetUpcomingItemCountNumber1
dayAny Day | Today | Tomorrow | Specified Day"Any Day"
specifiedDayText—

Shortcuts action: is.workflow.actions.getupcomingevents

getUpcomingReminders ​

Gets upcoming reminders, ordered from nearest to farthest away due date.

getUpcomingReminders(list: Text, WFGetUpcomingItemCount: Number) -> Reminder
ParameterTypeDefault
listText—
WFGetUpcomingItemCountNumber1

Shortcuts action: is.workflow.actions.getupcomingreminders

newCalendar ​

Creates a new calendar.

newCalendar(calendarName: Text) -> Text
ParameterTypeDefault
calendarNameText—

Shortcuts action: is.workflow.actions.addnewcalendar

newEvent ​

Creates a new event and adds it to the selected calendar.

newEvent(title: Text, location: Text, calendar: Text, startDate: Text, endDate: Text, allDay: Boolean, alert: Enum, alertTime: Text, notes: Text) -> CalendarEvent
ParameterTypeDefault
titleText—
locationText—
calendarText—
startDateText—
endDateText—
allDayBoolean—
alertNone | At time of event | 5 minutes before | 15 minutes before | 30 minutes before | 1 hour before | 2 hours before | 1 day before | 2 days before | 1 week before | Custom—
alertTimeText—
notesText—

Shortcuts action: is.workflow.actions.addnewevent

newReminder ​

Creates a new reminder and adds it to the selected list of reminders.

newReminder(reminder: Text, list: Text, alert: Enum, trigger: Enum, location: Text, person: Text, radius: Number, time: Text, priority: Enum, urgent: Boolean, flag: Boolean, url: Text, images: Image, parentReminder: Reminder, tags: Text, notes: Text) -> Reminder
ParameterTypeDefault
reminderText—
listText—
alertNo Alert | Alert"No Alert"
triggerAt Time | When I Arrive | When I Leave | When Messaging"At Time"
locationText—
personText—
radiusNumber1000
timeText—
priorityNone | Low | Medium | High"None"
urgentBoolean—
flagBoolean—
urlText—
imagesImage—
parentReminderReminder—
tagsText—
notesText—

Shortcuts action: is.workflow.actions.addnewreminder

openInCalendar ​

Shows the date or calendar event passed as input in the Calendar app.

openInCalendar(event: CalendarEvent)
ParameterTypeDefault
eventCalendarEvent—

Shortcuts action: is.workflow.actions.showincalendar

openRemindersList ​

Shows the specified list in the Reminders app.

openRemindersList(list: Text)
ParameterTypeDefault
listText—

Shortcuts action: is.workflow.actions.reminders.showlist

removeEvents ​

Removes all events passed into the action from the calendars they are contained in.

removeEvents(includeFutureEvents: Boolean, events: CalendarEvent)
ParameterTypeDefault
includeFutureEventsBooleanfalse
eventsCalendarEvent—

This is a destructive and permanent action. You will be asked to confirm before events are removed.

Shortcuts action: is.workflow.actions.removeevents

removeReminders ​

Removes all reminders passed into the action from the lists they are contained in.

removeReminders(reminders: Reminder)
ParameterTypeDefault
remindersReminder—

This is a destructive and permanent action. You will be asked to confirm before reminders are removed.

Shortcuts action: is.workflow.actions.removereminders

showQuickReminder ​

Opens the Quick Reminder view.

showQuickReminder()

Shortcuts action: is.workflow.actions.addquickreminder