A structure representing the Calendar
item. It enables creation of a new
calendar or modification of an existing one.
Use the launchbox.CalendarManager.Calendar
reference to obtain an instance of
this object.
Listed below are attributes of the Calendar
object:
Attribute | Description | Type | Use |
---|---|---|---|
id | A unique identifier of the calendar object. A read-only field. When set to "null", the
calendar does not exist on the device. For iOS, this parameted is a
string . |
number |
required |
typeLocal | Specifies if the calendar is local. A read-only field. By default this value is set to "true". | boolean |
optional |
name | A name of the calendar. | string |
optional |
color | A color that represents entries from this calendar in a combined calendar view, defined as an RGB string pattern "#xxxxxx", or an ARGB string pattern "#xxxxxxxx", where x: 0-9 A-F. | string |
optional |
Name | Return type | Description |
---|---|---|
getCalendarEvents | promise |
Provides access to a list of all event entries in the selected calendar. |
removeCalendarEvent | promise |
Removes a selected event from a selected calendar. |
save | promise |
Saves changes made to the |