SearchArguments
The SearchArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Search application.
Supported Platform(s)
- BlackBerry OS 5.0+
- Ripple Emulator
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple |
|---|---|---|---|---|---|
| blackberry.invoke.SearchArguments | Y | Y | Y | Y | |
| blackberry.invoke.SearchArguments | 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.SearchArguments" /> | 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. |
blackberry.invoke.SearchArguments
| blackberry.invoke.SearchArguments () |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The SearchArguments object must be created as an instance using the new keyword.
Code Example(s)
<script type="text/javascript">
var args = new blackberry.invoke.SearchArguments('build', 'Tim');
blackberry.invoke.invoke(blackberry.invoke.APP_SEARCH, args); // Search
</script>
blackberry.invoke.SearchArguments
| blackberry.invoke.SearchArguments (text : String, name : String) |
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
Build a SearchArguments object from string arguments
| Parameter | Type | Description |
|---|---|---|
| text | String | The text string to pass to the Search application |
| name | String | The name string to pass to the Search application |
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:19 GMT-0500 (EST)