| Package | com.esri.bao.tasks.geofence |
| Class | public final class GeofenceInfoTask |
| Inheritance | GeofenceInfoTask  BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
This task queries available features from a standard geography data layer according to the Business Analyst Online API user account geofence constraints.
When specifying the request with a Business Analyst Online API user account with geofence constraints,
the geofence criteria is applied before the output response is generated. The output response will contain
a list of feature IDs and names in a GeofenceInfoOutput.stdGeographiesFeatures array.
If no matching features were found by the query criteria or all of the features were rejected by
the geofence constraints, the array will be null.
Additionally, a map image and a feature class can be generated for resulting features and returned in the output results depending on the output options selected. If you only need feature IDs and names as the output, you can pass null as the OutputTypes parameter.
NOTE: A user account is identified by the authentication token parameter value.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAOnlineTask | |
| concurrency : String
Value that indicates how to handle multiple calls to the same task. | AbstractTask | |
| disableClientCaching : Boolean
If true, adds a timestamp parameter ("_ts") to the REST request to prevent the request from
being loaded from the browser's cache. | AbstractTask | |
| lastResult : GeofenceInfoOutput [read-only]
The last result of executing the Geofence Info task. | GeofenceInfoTask | ||
| proxyURL : String
The URL to proxy the request through. | AbstractTask | |
| requestTimeout : Number
The request timeout in seconds. | AbstractTask | |
| showBusyCursor : Boolean
If true, a busy cursor is displayed while a service is executing. | AbstractTask | |
| token : String
Token for accessing a secure task. | AbstractTask | |
| tokenProvider : ITokenProvider
Provider responsible for updating the security token if the last one expires. | BATask | |
| url : String
URL of the task. | AbstractTask | |
| Method | Defined By | ||
|---|---|---|---|
GeofenceInfoTask(urlOrClient:Object = null)
Creates a new instance of the GeofenceInfoTask class. | GeofenceInfoTask | ||
Creates a new command encapsulating this task and the given parameters. | GeofenceInfoTask | ||
execute(parameters:GeofenceInfoParameters, responder:IResponder = null):AsyncToken
Sends a request for executing a Geofence Info task to the Business Analyst Online HTTP (REST) Service. | GeofenceInfoTask | ||
| Constant | Defined By | ||
|---|---|---|---|
| name : String = report/GeofenceInfo [static] Task name. | GeofenceInfoTask | ||
| lastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertieslastResult:GeofenceInfoOutput [read-only] The last result of executing the Geofence Info task.
public function get lastResult():GeofenceInfoOutput| GeofenceInfoTask | () | Constructor |
public function GeofenceInfoTask(urlOrClient:Object = null)Creates a new instance of the GeofenceInfoTask class.
A new task can be constructed in two ways: as a task sharing a BAOnlineClient type instance
with other tasks (the urlOrClient parameter has the BAOnlineClient type) or
as a standalone task encapsulating its own client.
The base URL to the Business Analyst Online Web Services looks as follows:
http://{host}:{port}
The {host} and {port} parameters in this URL should be substituted with
valid Business Analyst Online host name and port, respectively.
If urlOrClient is null, the "http://baoapi.esri.com" value is assigned as the base URL.
urlOrClient:Object (default = null) |
See also
| createCommand | () | method |
public function createCommand(parameters:GeofenceInfoParameters, commandName:String = null):BACommandCreates a new command encapsulating this task and the given parameters.
Parameters
parameters:GeofenceInfoParameters — Parameters of a task to be executed.
| |
commandName:String (default = null) |
BACommand — A new command.
|
| execute | () | method |
public function execute(parameters:GeofenceInfoParameters, responder:IResponder = null):AsyncTokenSends a request for executing a Geofence Info task to the Business Analyst Online HTTP (REST) Service.
A response can be received in two ways—in an optional
responder object passed in parameters
of this method and/or in listeners of fault and taskCompleted
events registered for this task.
The responder is notified first when a response is received and parsed.
Its fault method receives a parameter of the FaultEvent type and its
result method receives a parameter of the BATaskCompletedEvent type
whose result property contains the result object.
After that the received event is dispatched to listeners of this task.
If a response is succesfully received and parsed, the result is assigned to the
lastResult property of this task.
Parameters
parameters:GeofenceInfoParameters — Parameters of the task.
| |
responder:IResponder (default = null) |
AsyncToken — Asynch token associated with the response.
|
| name | Constant |
public static const name:String = report/GeofenceInfoTask name.