CalendarArguments

The CalendarArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Calendar application.


Supported Platform(s)

- BlackBerry OS 5.0+
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
blackberry.invoke.CalendarArguments Y Y Y      Y
blackberry.invoke.CalendarArguments Y Y Y      Y
appointment Y Y Y      Y
date Y Y Y      Y
view Y Y Y      Y
VIEW_NEW Y Y Y      Y
VIEW_VIEW Y Y Y      Y
VIEW_AGENDA Y Y Y      Y
VIEW_DAY Y Y Y      Y
VIEW_DEFAULT Y Y Y      Y
VIEW_MONTH Y Y Y      Y
VIEW_WEEK Y Y Y      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.invoke" /> Y Y Y      Y
<feature id="blackberry.invoke.CalendarArguments" /> Y Y Y      Y
<feature id="blackberry.pim.Appointment" /> Y Y Y      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

Appointment appointment
Date date
Number view

Constants

Number VIEW_NEW
Number VIEW_VIEW
Number VIEW_AGENDA
Number VIEW_DAY
Number VIEW_DEFAULT
Number VIEW_MONTH
Number VIEW_WEEK

Constructors

blackberry.invoke.CalendarArguments (appointment : blackberry.pim.Appointment)

The CalendarArguments object must be created as an instance using the new keyword.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
appointment The appointment to be passed into the Calendar application.

Code Example:
<script type="text/javascript">  
  var appt = new blackberry.pim.Appointment();
  appt.summary = 'Get Together For lunch';
    
  var args = new blackberry.invoke.CalendarArguments(appt);
  args.view = 0;
   
  blackberry.invoke.invoke(blackberry.invoke.APP_CALENDAR, args);
<script>

blackberry.invoke.CalendarArguments (date : Date)


Create a new CalendarArguments object.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator


Parameters
date The date to be passed into the Calendar application.

Properties

readonly Appointment appointment


Value specifying which view to show in the Calendar application.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

readonly Date date


Date to open into the Calendar View.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Number view


Appointment to view in Calendar application. NOTE: appointment is only available in the Browser when used in a new view mode.


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Constants

static Number VIEW_NEW


New/Compose View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_VIEW


Read Only View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_AGENDA


Agenda View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_DAY


Single Day View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_DEFAULT


User's Default View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_MONTH


Month View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

static Number VIEW_WEEK


Week View


Supported Platforms
 - BlackBerry OS 5.0+
 - Ripple Emulator

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:03 GMT-0500 (EST)