CalendarAccount

The CalendarAccount object contains the calendar account information.


Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
enterprise           Y 
folders           Y 
id           Y 
name           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

Boolean enterprise
blackberry.pim.calendar.CalendarFolder[] folders
String id
String name

Properties

Boolean enterprise


True when this calendar account is an enterprise account.


Supported Platforms
 - BlackBerry 10

blackberry.pim.calendar.CalendarFolder[] folders


Return all the folders of the calendar account.


Supported Platforms
 - BlackBerry 10


Code Example: 
function getCalendarAccountsForGmail() {
   var calendar = blackberry.pim.calendar,
       accounts = calendar.getCalendarAccounts();

   // gets all calendar accounts that contains "gmail" in its name
   return accounts.filter(function (acct) {
      return /gmail/i.test(acct.name);
   });
}

String id


Contains the unique identifier of the calendar account.


Supported Platforms
 - BlackBerry 10

String name


Name of the calendar account.


Supported Platforms
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:32 GMT-0500 (EST)