MessageArguments

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

Supported Platform(s)

- BlackBerry OS 5.0+

- Ripple Emulator

View Supported Platform Table

API	BB5.0	BB6.0	BB7.0	Ripple
blackberry.invoke.MessageArguments	Y	Y	Y	Y
blackberry.invoke.MessageArguments	Y	Y	Y	Y
blackberry.invoke.MessageArguments	Y	Y	Y	Y
view	Y	Y	Y	Y
VIEW_NEW	Y	Y	Y	Y
VIEW_DEFAULT	Y	Y	Y	Y
VIEW_SAVED	Y	Y	Y	Y
VIEW_SEARCH	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.MessageArguments" />	Y	Y	Y	Y
<feature id="blackberry.message" />	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.MessageArguments
	blackberry.invoke.MessageArguments
	blackberry.invoke.MessageArguments

Properties

Number

view

Constants

Number	VIEW_NEW
Number	VIEW_DEFAULT
Number	VIEW_SAVED
Number	VIEW_SEARCH

Constructors

blackberry.invoke.MessageArguments ()

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

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Code Example:

<script type="text/javascript">   
  var args = new blackberry.invoke.MessageArguments('foo@domain.com', 'hello', 'world');
  args.view = blackberry.invoke.MessageArguments.VIEW_NEW; // New
   
  blackberry.invoke.invoke(blackberry.invoke.APP_MESSAGES, args);  // New Message
</script>

blackberry.invoke.MessageArguments (to : String, subject : String, body : String)

Build a MessageArguments object from string arguments

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Parameters
to	The recipient's email address
subject	The message's subject line
body	The contents of the message

blackberry.invoke.MessageArguments (message : blackberry.message.Message)

Build a MessageArguments object from a {blackberry.message.Message} object

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

Parameters
message	The Message object used to construct the MessageArguments

Properties

Number view

Value that specifies what kind of view you want to view in Messages application. If MessageArguments object is created with a Message object or 'to','subject','body' values, the view is 'VIEW_NEW' regardless if any other value is assigned.

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_DEFAULT

Opens up the Inbox

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

static Number VIEW_SAVED

Saved Messages View

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

static Number VIEW_SEARCH

Search View

Supported Platforms
	- BlackBerry OS 5.0+
	- Ripple Emulator

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