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
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| 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 ID | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| <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 Only) |
|---|
| This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application. |
API Summary
Properties
blackberry.invoke.CalendarArguments
| blackberry.invoke.CalendarArguments (appointment : blackberry.pim.Appointment) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The CalendarArguments object must be created as an instance using the new keyword.
| Parameter | Type | Description |
|---|---|---|
| appointment | blackberry.pim.Appointment | The appointment to be passed into the Calendar application. |
Code Example(s)
<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
| blackberry.invoke.CalendarArguments (date : Date) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Create a new CalendarArguments object.
| Parameter | Type | Description |
|---|---|---|
| date | Date | The date to be passed into the Calendar application. |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| appointment |
Appointment
readonly |
Value specifying which view to show in the Calendar application.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| date |
Date
readonly |
Date to open into the Calendar View.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| view | Number |
Appointment to view in Calendar application. NOTE: appointment is only available in the Browser when used in a new view mode.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Constants:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| VIEW_NEW | Number |
New/Compose View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_VIEW | Number |
Read Only View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_AGENDA | Number |
Agenda View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_DAY | Number |
Single Day View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_DEFAULT | Number |
User's Default View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_MONTH | Number |
Month View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_WEEK | Number |
Week View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:15 GMT-0500 (EST)