BrowserArguments

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


Supported Platform(s)

- BlackBerry OS 5.0+
- BlackBerry PlayBook 1.0+
- Ripple Emulator
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
blackberry.invoke.BrowserArguments Y Y 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 IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.invoke" /> Y Y Y Y Y  Y
<feature id="blackberry.invoke.BrowserArguments" /> Y Y Y Y Y   
<feature id="blackberry.identity" /> 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.BrowserArguments (url : String, [transport : blackberry.identity.Transport])

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


Supported Platforms
 - BlackBerry OS 5.0+
 - BlackBerry PlayBook 1.0+
 - Ripple Emulator


Parameters
url The desired url to bring up in the browser.
transport an optional parameter for BB5.0+ only representing the transport type that the browser should use. If no parameter is specified the default browser configured for the device will be used.

Code Example:
<script type="text/javascript">
  var args = new blackberry.invoke.BrowserArguments('http://www.blackberry.com');
  blackberry.invoke.invoke(blackberry.invoke.APP_BROWSER, args);
</script>
Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:02 GMT-0500 (EST)