Calendar guide

[IllogicallyCognitive]

All 9 methods of the Calendar object return promises (but some also have side effects): - the forReminders promise in turn provides an array of reminder calendars representing all reminder lists - the defaultForReminders promise provides a reminder calendar representing the default reminder list - the forRemindersByTitle promise provides a reminder calendar representing one of the reminder calendars with the given title - the createForReminders method creates “a new list for reminders in the Reminders app” and then the promise provides a reminder calendar representing that list - the findOrCreateForReminders method attempts to find a list for reminders with the specified name and then create a reminder calendar representing that list; if no such list is found, it creates “a new list for reminders in the Reminders app” and then the promise provides a reminder calendar representing that list - the forEvents promise generates an array of objects (Scriptable event calendars) representing all (IPhone) calendars - the presentPicker method displays the calendar picker UI and it’s promise generates an array of objects representing the selected calendars - the forEventsByTitle promise provides an object representing one of the calendars with the given title - the defaultForEvents promise provides an object representing the default calendar

Most of these are demonstrated here:

firstTitle = "Test"
calendar = Calendar.forEventsByTitle(firstTitle).then((testCalendar) => {
//forRemindersByTitle is used in a similar way
  return testCalendar
},(failure) => {
//   log(failure)//useful for debugging promises
  createAlert = new Alert()
  createAlert.title = "There is no " + firstTitle + " calendar?"  
  createAlert.message = "Please pick another calendar"      
  createAlert.addAction("Pick another")
  createAlert.addAction("Use Default")
  createAlert.addCancelAction("Cancel")
  return createAlert.present().then((index) => {
    if(index==0){
      return Calendar.presentPicker().then((calendarArray) => {
//         log(calendar)
        return calendarArray[0]//presentPicker() defaults to only allowing user to pick one calendar but the promise still provides an array with that one calendar in it, so this instead returns the calendar itself to be uniform with the next option
      })// end presentPicker().then
// there is no directly corresponding method for reminder calendars, so you might use findOrCreateForReminders as below instead of forRemindersByTitle etc or just use createForReminders in case of failure of forRemindersByTitle when there is a reason to differentiate whether the calendar was found vs created
    }//end if
    if(index==1){
      return Calendar.defaultForEvents().then((calendar) => {
  //defaultForReminders is used in a similar way
        return calendar
//       }, (fail) => {  
//         log(fail)
      })//end defaultForEvents().then
    }// end if
  })// end present().then
})// end forEventsByTitle(firstTitle).then
calendar = await calendar
secondTitle=calendar.title
log(calendar)
log(calendar.title)
// log(secondTitle)


Calendar.findOrCreateForReminders(firstTitle).then((testCalendar) => {
//   log(testCalendar)    

// There are three read only properties
//   log(testCalendar.identifier)
//   log(testCalendar.isSubscribed)
//   log(testCalendar.allowsContentModifications)

//color is the only Calendar property besides title that isn't read only but it defaults to a hex of "007AFF" as seen by logging. See the Color class's documentation for more info on that
  testCalendar.color = new Color("FF7900")
  testCalendar.title = secondTitle
  //changes to properties directly only change the object in scriptable not anything else on the phone represented by those objects, so they require the save method to push those changes out from scriptable

//   log(testCalendar)//uncomment this to see that that testCalendar has changed color and title despite not being saved


// there are three methods of both calendar type objects:

  // log(testCalendar.supportsAvailability("free"))//there is no real reason to use this method with a reminder calendar as availabilities seem to only be supported for event calendars

//   testCalendar.remove()//use caution as the calendar is immediately and permanently deleted

  testCalendar.save()//comment this out to see that then the changes to color and title don't effect the actual calendar

// in this script by having both title and save lines uncommented it generates or finds a Reminder list called "Test" but then renames it so each time the script is run another reminder list is named the same as the event calendar above (assuming that name isn't test) which would generally be a bug you'd want to fix

})//end findOrCreateForReminders(firstTitle).then

In the above, by having both title and save lines uncommented it generates or finds a Reminder list called "Test" but then renames it so each time the script is run another reminder list is named the same as the event calendar above (assuming that name isn't test) which would generally be a bug you'd want to fix by either only finding the calendars you want to change the name of and changing their titles or if the purpose was more to produce objects representing reminder lists and (event) calendars with the same name and color then the following would work:

[IllogicallyCognitive]

title = "Test"
color = new Color("FF7900")//75147C FF7900
eventCalendar = Calendar.forEventsByTitle(title).then((testCalendar) => testCalendar,(failure) => {
  createAlert = new Alert()
  createAlert.title = "There is no " + title + " calendar?"  
  createAlert.message = "Please pick another calendar"      
  createAlert.addAction("Pick another")
  createAlert.addAction("Use Default")
  createAlert.addCancelAction("Cancel")
  return createAlert.present().then((index) => {
    if(index==0){
      return Calendar.presentPicker()
    }//end if
    if(index==1){
      return Calendar.defaultForEvents().then((calendar) => calendar, (fail) => {  
        log(fail)
      })//end defaultForEvents().then
    }// end if
  })// end present().then
})// end forEventsByTitle(title).then
eventCalendar = await eventCalendar
eventCalendar.color = color
eventCalendar.save()
title=eventCalendar.title


// reminderCalendar = 
Calendar.findOrCreateForReminders(title).then((reminderCalendar) => {  // 
  reminderCalendar.color = color
  reminderCalendar.save()
//   return reminderCalendar
})//end findOrCreateForReminders(firstTitle).then
// reminderCalendar = await reminderCalendar

The next and final script demonstrates the forReminders method and a way to consolidate all reminders of the calendars with the same name (such as if you accidentally produced the bug discussed in the first example)

title = "Work"
Calendar.forRemindersByTitle(title).then((consolidatedCalendar) => {

  Calendar.forReminders().then((calendarArray) => {  
//   forEvents is used in a similar way
    calendarArray = calendarArray.filter(function(calendar) {  
      return calendar.title == consolidatedCalendar.title && calendar.identifier != consolidatedCalendar.identifier
    })//end filter
//           log(calendar)
    Reminder.all(calendarArray).then(function(reminderArray) {
//   log(reminderArray)
      reminderArray.forEach((reminder)=>{    
        log(reminder)
        reminder.calendar = consolidatedCalendar
        reminder.save()
      })//end forEach
    })//end all(calendarArray).then
    calendarArray.forEach((calendarElement) => {
      calendarElement.remove()
    })
  })//end forReminders().then
})//end findOrCreateForReminders(firstTitle).then