CalendarFolder

A calendar in the calendar application is represented by a CalendarFolder object. Folders are containers for events.


Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
accountId           Y 
color           Y 
default           Y 
enterprise           Y 
id           Y 
name           Y 
ownerEmail           Y 
readonly           Y 
type           Y 
visible           Y 

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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<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
String color
Boolean default
Boolean enterprise
String id
String name
String ownerEmail
Boolean readonly
Number type
Boolean visible

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 Mon Feb 11 2013 14:51:03 GMT-0500 (EST)