Calendar Plugin

Stable Version 3.1.1 (O11)
Also available for 10
Published on 13 November 2019 by 
Created on 17 October 2016
Documentation


The Calendar plugin is a component that allows an app to interact with the calendar application of a mobile device. Main functionalities: open the calendar app, searching contacts and create/delete them.

CheckCalendarPlugin

Before you start using any other action of the calendar plugin, you should check if the plugin is working properly in your device. In order to do it, you should use the CheckCalendarPlugin action that will return you the success boolean with either true or false according to if the plugin is working or not. If the plugin is not working correctly, this action returns false and error with error code and message.




OpenCalendar 

The OpenCalendar action allows you to open the calendar app of your device. This action returns true or false based on the success (or not) of the operation, and the error code and message. 






FindEvent

The FindEvent action is used to find an event or several events that match your input restrictions. The mandatory inputs are the title that would be the title of the event you are searching for, and the range in time where you want to search for it, besides that you have also the possibility to define the location and notes of the event. Just as the actions before it will return the success and error outputs, but also the list of events that match your search criteria.






CreateEvent and CreateEventWithOptions

Both of these actions have the same objective. The difference between them is that the CreateEventWithOptions has more input parameters than the CreateEvent, so as long as you understand the CreateEventWithOptions the other one is covered.

As for the inputs.

  1. Title - It’s a text variable that basically defines the title of the event.

  2. Location - Text variable that defines the event location.

  3. Notes - Text variable that lets you add some notes to the event.

  4. StartDateTime - DateTime variable that defines the start date and time of the event.

  5. EndDateTime - DateTime variable that defines the end date and time of the event.

  6. Recurrence - It’s the Recurrence Identifier of the Recurrence static entity that comes with the component, this variable lets you choose the frequency in which the event will occur the options that the static entity proves you are daily, weekly, monthly, yearly or none. 

  7. RecurrenceInterval - Integer that in conjunction with the Recurrence creates a custom frequency for the event, this one is easier to explain with an example. Imagine that you set the Recurrence to weekly if you set the RecurrenceInterval to 2 the event will be created every two weeks, instead of weekly.

  8. RecurrenceEndDate - Date attribute that defines the date where the recurrence of the event should stop occurring.

  9. URL - Text variable that basically lets you associate a URL to the event.

  10. FirstReminderMinutes - It’s an integer that lets you set a reminder a given number of minutes before the event. 

  11. SecondReminderMinutes - An integer that lets you set a second reminder for the event. Should be a smaller value than the previous one.

  12. IsEditable - Boolean that if true will open the devices calendar app to let you make some final refinements to the event before you create it, it is set to false the event will just be created with the inputted parameters.



DeleteEvent

This action should be used to delete events but does it do it?

This action as several inputs that will try to match with the device’s events and will basically delete the ones the match with the inputted criteria. The inputs are the Title, Location, Notes,  StartDateTime, and EndDateTime, but only the ones that are mandatory are the Title and the DateTimes, just have in mind one thing, the DateTimes, in this case, is not the start and end of the events but the range of dates in which you want to delete the events.



Support Options
OutSystems Supported
Customers entitled to Support Services may obtain assistance through Support.
Dependencies
See all 1 dependencies