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
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | 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 | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | 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 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.MessageArguments
| blackberry.invoke.MessageArguments () |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The MessageArguements object must be created as an instance using the new keyword.
Code Example(s)
<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
| blackberry.invoke.MessageArguments (to : String, subject : String, body : String) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Build a MessageArguments object from string arguments
| Parameter | Type | Description |
|---|---|---|
| to | String | The recipient's email address |
| subject | String | The message's subject line |
| body | String | The contents of the message |
blackberry.invoke.MessageArguments
| blackberry.invoke.MessageArguments (message : blackberry.message.Message) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Build a MessageArguments object from a {blackberry.message.Message} object
| Parameter | Type | Description |
|---|---|---|
| message | blackberry.message.Message | The Message object used to construct the MessageArguments |
Properties:
| Property | Type | Description | Supported Platform(s) |
|---|---|---|---|
| view | Number |
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.
|
- 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_DEFAULT | Number |
Opens up the Inbox
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_SAVED | Number |
Saved Messages View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
| VIEW_SEARCH | Number |
Search View
|
- BlackBerry OS 5.0+
- Ripple Emulator |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:18 GMT-0500 (EST)