AddressBookArguments
The AddressBookArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Address Book application.
Supported Platform(s)
- BlackBerry OS 5.0+
- Ripple Emulator
API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
---|---|---|---|---|---|
blackberry.invoke.AddressBookArguments | Y | Y | Y | Y | |
view | Y | Y | Y | Y | |
VIEW_NEW | Y | Y | Y | Y | |
VIEW_COMPOSE | Y | Y | Y | Y | |
VIEW_DISPLAY | 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.AddressBookArguments" /> | Y | Y | Y | Y | |
<feature id="blackberry.pim.Contact" /> | 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
Constructors
Properties
Constants
blackberry.invoke.AddressBookArguments
blackberry.invoke.AddressBookArguments ([contact: blackberry.pim.Contact]) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The AddressBookArguments object must be created as an instance using the new keyword.
Parameter | Type | Description |
---|---|---|
contact |
blackberry.pim.Contact
Optional |
Contact to view in Contacts application. |
Code Example(s)
<script type="text/javascript"> var contact = new blackberry.pim.Contact(); contact.firstName = 'Nick'; contact.lastName = 'Scott'; var args = new blackberry.invoke.AddressBookArguments(contact); args.view = 0; blackberry.invoke.invoke(blackberry.invoke.APP_ADDRESSBOOK, args); </script>
Properties:
Property | Type | Description | Supported Platform(s) |
---|---|---|---|
view | Number |
Value that specifies what kind of view you want to view the contact.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Constants:
Property | Type | Description | Supported Platform(s) |
---|---|---|---|
VIEW_NEW | Number |
VIEW_NEW will launch the address book with the 'add contact' window; if a contact object is specified, it will open that contact in the 'edit contact' window of the address book.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
VIEW_COMPOSE | Number |
VIEW_COMPOSE will launch the address book with the 'message composing' window. It's not allowed to specify a contact with VIEW_COMPOSE; if a contact object is specified, it will throw an exception.
|
- BlackBerry OS 5.0+
- Ripple Emulator |
VIEW_DISPLAY | Number |
VIEW_DISPLAY will launch the address book with the 'view contact' window displaying the specified contact; if a contact object is not specified, it will throw an exception.
|
- 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)