Package | com.esri.bao.tasks |
Class | public class BAOnlineTask |
Inheritance | BAOnlineTask BATask AbstractTask flash.events.EventDispatcher |
Implements | IBADatasetParameters |
Subclasses | BAOnlineBatchTask, BAOnlineGenericTask, BenchmarkReportTask, DriveTimeTask, GeofenceInfoTask, GetDatasetsTask, GetReportTemplatesTask, GetStandardGeographyLevelsTask, GetSummarizationsTask, ReturnStdGeographyTask, SimpleRingsTask, StdGeographiesByAttributesTask, StdGeographiesFromExtentTask, SummaryReportsTask |
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 | ||
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 | ||
---|---|---|---|
BAOnlineTask(urlOrClient:Object = null)
Creates a new instance of the BAOnlineTask class. | BAOnlineTask |
activeDatasetID | property |
activeDatasetID:String
Active dataset ID.
An active dataset ID could be applied to tasks whose parameters implement the
IBADatasetParameters
interface. The value of an active dataset ID
specified in this interface has a precedence on the value specified in the task class instance.
If both values are missing, the default Community Analyst dataset is used.
The default value is null
.
public function get activeDatasetID():String
public function set activeDatasetID(value:String):void
See also
BAOnlineTask | () | Constructor |
public function BAOnlineTask(urlOrClient:Object = null)
Creates a new instance of the BAOnlineTask 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 Community Analyst Web Services looks as follows:
http://{host}:{port}
The {host}
and {port}
parameters in this URL should be substituted with
valid Community Analyst 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 ) — A variable containing either Community Analyst HTTP Service URL string or an
instance of the BAOnlineClient class.
|
See also