CalendarFolder
A calendar in the calendar application is represented by a CalendarFolder object. Folders are containers for events.
Configuration Document Settings
|
To use all of the API described for this object, you must ensure the following settings are in your configuration document:
|
|
You must declare the feature element(s) below in your configuration document:
|
| Feature ID | BB5.0 | BB6.0 | BB7.0 | PB1.0 | PB2.0 | BB10 | Ripple |
|---|
|
<feature id="blackberry.pim.calendar" />
| |
|
|
|
|
Y | |
| Permission Elements (PlayBook and BlackBerry 10+) |
|
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.
|
Properties
String
accountId
The folder's account id.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
String
color
The folder's color in a hexadecimal string starts with #
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Boolean
default
True if this calendar folder is the default
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Boolean
enterprise
True if this calendar folder is an enterprise calendar folder
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
String
id
The identifier for the folder.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
String
name
Name of the calendar folder.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
String
ownerEmail
The email for the folder owner.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Boolean
readonly
True if the folder is read-only, false otherwise.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Number
type
The folder's type.
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Boolean
visible
True if the user has marked the folder as visible in the calendar application, false otherwise
|
Supported Platforms
|
|---|
|
- BlackBerry 10
|
Documentation generated by
JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:32 GMT-0500 (EST)