net.rim.blackberry.api.invoke
Class AddressBookArguments

java.lang.Object
  net.rim.blackberry.api.invoke.ApplicationArguments
      net.rim.blackberry.api.invoke.AddressBookArguments

public final class AddressBookArguments
extends ApplicationArguments

Encapsulates arguments to pass to the Address Book application.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

Field Summary
	static String	ARG_COMPOSE Argument to open the address book in its compose window.
	static String	ARG_NEW Argument to open the address book and create a new address card.
	static String	ARG_VIEW Argument to open the address book and view a particular address card.

Constructor Summary
	AddressBookArguments() Creates a new AddressBookArguments instance with default arguments.
	AddressBookArguments(String arg) Creates a new AddressBookArguments instance with provided arguments.
	AddressBookArguments(String arg, Contact contact) Creates a new AddressBookArguments instance with the provided arguments

Method Summary
	protected Contact	getContactArg() Retrieves the contact reference passed in from constructor AddressBookArguments(String, Contact)

Methods inherited from class net.rim.blackberry.api.invoke.ApplicationArguments

getArgs

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARG_COMPOSE

public static final String ARG_COMPOSE

Argument to open the address book in its compose window.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

ARG_NEW

public static final String ARG_NEW

Argument to open the address book and create a new address card.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

ARG_VIEW

public static final String ARG_VIEW

Argument to open the address book and view a particular address card.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 5.0.0

Constructor Detail

AddressBookArguments

public AddressBookArguments()

Creates a new AddressBookArguments instance with default arguments.

The default arguments instruct the Address Book to open in the default (search list) view.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

AddressBookArguments

public AddressBookArguments(String arg)

Creates a new AddressBookArguments instance with provided arguments.

Parameters:

arg - Specify AddressBookArguments.ARG_COMPOSE to open the address book ready to compose a message. Specify AddressBookArguments.ARG_NEW to open the address book ready to create a new address.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.0.0

AddressBookArguments

public AddressBookArguments(String arg,
                            Contact contact)

Creates a new AddressBookArguments instance with the provided arguments

Parameters:

arg - Specify AddressBookArguments.ARG_NEW to open the address book to create a new address, or AddressBookArguments.ARG_VIEW with a valid reference for 'contact' in order to open a viewer for the contact.

contact - A javax.microedition.pim.Contact object used to populate information for the new address

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0

Method Detail

getContactArg

protected Contact getContactArg()

Retrieves the contact reference passed in from constructor AddressBookArguments(String, Contact)

Returns:

The contact that was passed in from constructor

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.1.0