TaskArguments
The TaskArguments object is an instance object, and is used as a parameter to the invoke() method when invoking the Tasks application.
Supported Platform(s)
- BlackBerry OS 5.0+
- Ripple Emulator
| API | OS 5.0 | OS 6.0 | OS 7.0 | PlayBook | Ripple | 
|---|---|---|---|---|---|
| blackberry.invoke.TaskArguments | Y | Y | Y | Y | |
| view | Y | Y | Y | Y | |
| VIEW_NEW | Y | Y | Y | Y | |
| VIEW_EDIT | 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.TaskArguments" /> | Y | Y | Y | Y | |
| <feature id="blackberry.pim.Task" /> | 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
blackberry.invoke.TaskArguments
| blackberry.invoke.TaskArguments ([task: blackberry.pim.Task]) | 
Supported Platform(s)
- BlackBerry OS 5.0+- Ripple Emulator
Description
The TaskArguments object must be created as an instance using the new keyword.
| Parameter | Type | Description | 
|---|---|---|
| task | 
                                    
                                        blackberry.pim.Task
                                    
                                     Optional  | 
                                Task to view in Tasks application. | 
Code Example(s)
<script type="text/javascript"> var task= new blackberry.pim.Task(); task.summary = 'Pick it up'; var args = new blackberry.invoke.TaskArguments(task); args.view = 0; blackberry.invoke.invoke(blackberry.invoke.APP_TASKS, args); </script>
Properties:
| Property | Type | Description | Supported Platform(s) | 
|---|---|---|---|
| view | Number | 
                            Value that specifies what kind of view you want to view the task in Tasks application.
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - Ripple Emulator  | 
                    
Constants:
| Property | Type | Description | Supported Platform(s) | 
|---|---|---|---|
| VIEW_NEW | Number | 
                            New View
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - Ripple Emulator  | 
                    
| VIEW_EDIT | Number | 
                            Edit View
                            
                                 | 
                        
                        
                            
                                
                                     - BlackBerry OS 5.0+
                                     - Ripple Emulator  | 
                    
            
            Documentation generated by JsDoc Toolkit 2.4.0 on Sun Dec 30 2012 13:31:20 GMT-0500 (EST)