Task Information Widget - Close Event (Handled)
The widget closes the tabs for the referenced tasks.
Event Name
com.ibm.widget.Close
General purpose: Closes the requested resources.
Payload
Type: JSON
{ "type" : "object",
"description" : "Reference single or multiple items.",
"properties" : {
"id" : { "type": "string", "optional": "true" },
"type" : { "type": "string", "optional": "true", "requires": "id" },
"name" : { "type": "string", "optional":"true" },
"items" : { "type":"array", "optional":"true", "items": { "properties": {
"id" : { "type": "string" },
"type" : { "type": "string" },
"name" : { "type": "string", "optional":"true" }
} } }
} }
Single item can be specified directly with the id and type property.
Multiple items are specified in the items array property.
When both are omitted, all open items are closed. Otherwise only referenced items
are closed.
The type property identifies the type of the identified object.
The widget only considers entries with the type property being
one of the following object types
- com.ibm.task.Task
Closes the tab if the referenced task is currently open in a tab.
If the type is not one of these, the item is disregarded and no action is
performed.
If the user changed a task, he is prompted whether to save
these changes or not.
Handled Since
6.2.0.1
Parent Topic: Task Information Widget