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

View Supported Platform Table

API	BB5.0	BB6.0	BB7.0	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	BB5.0	BB6.0	BB7.0	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 and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Constructors

blackberry.invoke.AddressBookArguments

Properties

Number

view

Constants

Number	VIEW_NEW
Number	VIEW_COMPOSE
Number	VIEW_DISPLAY

Constructors

blackberry.invoke.AddressBookArguments ([contact : blackberry.pim.Contact])

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

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Parameters
contact	Contact to view in Contacts application.

Code Example:

<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

Number view

Value that specifies what kind of view you want to view the contact.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Constants

static Number VIEW_NEW

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.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

static Number VIEW_COMPOSE

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.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

static Number VIEW_DISPLAY

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.

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

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