SearchArguments
The SearchArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Search application.
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 | PB1.0 | PB2.0 | BB10 | Ripple |
<feature id="blackberry.invoke" />
| Y |
Y |
Y |
|
|
| Y |
<feature id="blackberry.invoke.SearchArguments" />
| 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.SearchArguments
([text : String], [name : String])
The SearchArguments object must be created as an instance using the new keyword.
Supported Platforms
|
|
- BlackBerry OS 5.0+
|
|
- Ripple Emulator
|
Parameters
|
text |
The text string to pass to the Search application.
|
name |
The name string to pass to the Search application.
|
Code Example:
<script type="text/javascript">
var args = new blackberry.invoke.SearchArguments('build', 'Tim');
blackberry.invoke.invoke(blackberry.invoke.APP_SEARCH, args); // Search
</script>
|
Documentation generated by
JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 18:15:43 GMT-0500 (EST)