| Package | com.esri.bacore |
| Class | public class BATaskCompletedEvent |
| Inheritance | BATaskCompletedEvent  flash.events.Event |
See also
| Property | Defined By | ||
|---|---|---|---|
| messages : Array [read-only]
Array of TaskMessage items returned by the task. | BATaskCompletedEvent | ||
| requestUrl : String [read-only]
Human readable URL of the request completed or null. | BATaskCompletedEvent | ||
| result : * [read-only]
Task execution result. | BATaskCompletedEvent | ||
| taskName : String [read-only]
Task name. | BATaskCompletedEvent | ||
| Method | Defined By | ||
|---|---|---|---|
BATaskCompletedEvent(name:String, result:*, messages:Array = null, requestUrl:String = null)
Creates a new instance of the BATaskCompletedEvent class. | BATaskCompletedEvent | ||
clone():Event [override]
Creates a clone of the event. | BATaskCompletedEvent | ||
toString():String [override]
Gets the description of the event. | BATaskCompletedEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| COMPLETE : String = taskCompleted [static]
The BATaskCompletedEvent.COMPLETE constant defines the value of the
type property of the event object for a taskCompleted event. | BATaskCompletedEvent | ||
| messages | property |
messages:Array [read-only] Array of TaskMessage items returned by the task.
public function get messages():ArraySee also
| requestUrl | property |
requestUrl:String [read-only] Human readable URL of the request completed or null.
public function get requestUrl():String| result | property |
result:* [read-only] Task execution result.
public function get result():*| taskName | property |
taskName:String [read-only] Task name.
public function get taskName():String| BATaskCompletedEvent | () | Constructor |
public function BATaskCompletedEvent(name:String, result:*, messages:Array = null, requestUrl:String = null)Creates a new instance of the BATaskCompletedEvent class.
Parametersname:String — Task name.
| |
result:* — Task result.
| |
messages:Array (default = null) | |
requestUrl:String (default = null) |
| clone | () | method |
override public function clone():EventCreates a clone of the event.
ReturnsEvent — Shallow copy of the event.
|
| toString | () | method |
override public function toString():StringGets the description of the event.
ReturnsString — String representation of the event.
|
| COMPLETE | Constant |
public static const COMPLETE:String = taskCompleted
The BATaskCompletedEvent.COMPLETE constant defines the value of the
type property of the event object for a taskCompleted event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
babbles | false |
cancelable | false |
currentTarget | The Object that defines the event listener that handles the event. |
target | The BATask object that dispatched the event. This is an instance of a Community Analyst Task that was executed. |
taskName | Name of a Community Analyst Task that was executed. |
result | Task execution result object. |
messages | Optional array of TaskMessage objects received. |
The currentTarget and target properties are
specified after the event was dispatched. A responder object passed in parameters of
a Community Analyst Task execute method receives the event before it is dispatched.