arcgis-maps-kotlin/com.arcgismaps.tasks.networkanalysis/ServiceAreaTask

ServiceAreaTask

class ServiceAreaTask : ApiKeyResource, Loadable, Resourceable

Instances of this class represent tasks that can compute service areas. A Service Area task allows you to calculate areas that can be serviced (reached) from a given location. A service area is a region that encompasses all accessible streets, that is, streets that lie within a specified impedance. For instance, the 10-minute service area for a facility includes all the streets that can be reached within 10 minutes from that facility.

Since

200.1.0

Constructors

ServiceAreaTask

constructor(pathToDatabase: String, networkName: String)

Creates a service area task with path to geodatabase.

constructor(dataset: TransportationNetworkDataset)

Creates a service area task with transportation network dataset.

constructor(url: String)

Creates a service area task with URL. Creates a service area task.

Properties

serviceAreaTaskInfo

val serviceAreaTaskInfo: ServiceAreaTaskInfo?

Service area task info. Information about this service area task. For a service area task using an online service, this will involve a network call.

transportationNetworkDataset

val transportationNetworkDataset: TransportationNetworkDataset?

Transportation network dataset.

url

val url: String?

The URL of online service. The URL that will be used when the service area task is loaded.

Inherited properties

apiKey

open override var apiKey: ApiKey?

The API key allows your app to access ArcGIS location services and private portal items. An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

loadStatus

open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

createDefaultParameters

suspend fun createDefaultParameters(): Result<ServiceAreaParameters>

Creates default parameters. Retrieves the default parameters as defined by the service.

solveServiceArea

suspend fun solveServiceArea(serviceAreaParameters: ServiceAreaParameters): Result<ServiceAreaResult>

Solve a service area passing in a parameters object. Executes the ServiceAreaParameters defined for this ServiceAreaTask and returns a ServiceAreaResult containing the results.

Inherited functions

cancelLoad

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

load

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

retryLoad

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.