Collection of Task enumerations. More...
| Header: | #include <TaskTypes.h> |
Types
| enum class | AttachmentSyncDirection { None, Upload, Bidirectional } |
| enum class | GenerateLayerQueryOption { All, None, UseFilter } |
| enum class | JobMessageSeverity { Info, Warning, Error, Unknown } |
| enum class | JobMessageSource { Client, Service } |
| enum class | JobStatus { NotStarted, Started, Paused, Succeeded, Failed, Canceling } |
| enum class | JobType { Unknown, GenerateGeodatabaseJob, SyncGeodatabaseJob, ExportTileCacheJob, EstimateTileCacheSizeJob, …, UtilityNetworkValidationJob } |
| enum class | SyncDirection { None, Download, Upload, Bidirectional } |
| enum class | SyncModel { None, Geodatabase, Layer } |
| enum class | UtilityNetworkSyncMode { None, SyncSystemTables, SyncSystemAndTopologyTables } |
Detailed Description
Type Documentation
[since Esri::ArcGISRuntime 100.0] enum class AttachmentSyncDirection
Enumerates sync direction for attachments.
AttachmentSyncDirection indicates the direction that attachment changes are sent between the mobile geodatabase and the service. AttachmentSyncDirection can be one of:
| Constant | Value | Description |
|---|---|---|
AttachmentSyncDirection::None | 0 | No sync direction specified. |
AttachmentSyncDirection::Upload | 1 | Upload changes to the service. |
AttachmentSyncDirection::Bidirectional | 2 | Upload and download changes. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.1] enum class GenerateLayerQueryOption
Enumerates generate layer query options.
GenerateLayerQueryOption determines which features are copied from the server when generating a geodatabase. GenerateLayerQueryOption can be one of:
| Constant | Value | Description |
|---|---|---|
GenerateLayerQueryOption::All | 0 | All features are copied from the server when creating a geodatabase. |
GenerateLayerQueryOption::None | 1 | When combined with Esri::ArcGISRuntime::GenerateLayerOption::isIncludeRelated, if false, no features are copied from the server when creating a geodatabase. When true, only features that are in a relationship are copied. When used in conjunction with upload-only synchronization, this enables a faster upload scenario where new features are only sent to the server and none are downloaded. |
GenerateLayerQueryOption::UseFilter | 2 | Features satisfying the criteria imposed by the Esri::ArcGISRuntime::GenerateLayerOption::whereClause and Esri::ArcGISRuntime::GenerateLayerOption::isUseGeometry properties are copied from the server when creating a geodatabase. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.1.
[since Esri::ArcGISRuntime 100.4] enum class JobMessageSeverity
Enumerates the different levels of severity of a job message.
JobMessageSeverity can be one of:
| Constant | Value | Description |
|---|---|---|
JobMessageSeverity::Info | 0 | An informative message is generated during the job's execution, such as a job uploading data, job progressing on a server or job results. This message type never indicates a problem. |
JobMessageSeverity::Warning | 1 | A warning message is generated when a job experiences a situation that may cause a problem during its execution or when the result may not be what you expect. For example, when the job has failed to take a layer offline from an online map. Generally the job will run to successful completion even if there are one or more warnings. |
JobMessageSeverity::Error | 2 | An error message indicates a critical event that caused the job to fail. The error instance is also available from the job's error property. |
JobMessageSeverity::Unknown | -1 | A message of unknown severity. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.4.
[since Esri::ArcGISRuntime 100.4] enum class JobMessageSource
Enumerates the origin of a job message.
JobMessageSource can be one of:
| Constant | Value | Description |
|---|---|---|
JobMessageSource::Client | 0 | A job message generated by this API. |
JobMessageSource::Service | 1 | A job message generated by a service. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.4.
[since Esri::ArcGISRuntime 100.0] enum class JobStatus
Enumerates the status of an instance of a Job.
JobStatus can be one of:
| Constant | Value | Description |
|---|---|---|
JobStatus::NotStarted | 0 | Not started |
JobStatus::Started | 1 | Started |
JobStatus::Paused | 2 | Paused |
JobStatus::Succeeded | 3 | Succeeded |
JobStatus::Failed | 4 | Failed |
JobStatus::Canceling | 5 | In the process of being canceled. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class JobType
Enumerates the type of an instance of a Job.
JobType can be one of:
| Constant | Value | Description |
|---|---|---|
JobType::Unknown | -1 | Unknown job type. |
JobType::GenerateGeodatabaseJob | 0 | Generate geodatabase Job |
JobType::SyncGeodatabaseJob | 1 | Sync geodatabase Job. |
JobType::ExportTileCacheJob | 2 | Export tile cache Job. |
JobType::EstimateTileCacheSizeJob | 3 | Estimate tile cache size Job. |
JobType::GeoprocessingJob | 4 | Geoprocessing Job. |
JobType::GenerateOfflineMapJob | 5 | Generate offline map Job. |
JobType::ExportVectorTilesJob | 6 | Export vector tiles Job. |
JobType::OfflineMapSyncJob | 7 | Offline map sync Job. |
JobType::DownloadPreplannedOfflineMapJob | 8 | Download preplanned map areas Job. |
JobType::UtilityNetworkValidationJob | 9 | Validate network topology Job. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class SyncDirection
Enumerates sync direction of features.
SyncDirection indicates the direction that feature changes are sent between the mobile geodatabase and the service. SyncDirection can be one of:
| Constant | Value | Description |
|---|---|---|
SyncDirection::None | 0 | No sync direction specified. |
SyncDirection::Download | 1 | Download changes from the service. |
SyncDirection::Upload | 2 | Upload changes to the service. |
SyncDirection::Bidirectional | 3 | Upload and download changes. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.0] enum class SyncModel
Enumerates sync model.
SyncModel indicates whether sync options are applied for the whole mobile geodatabase or for each layer or table that is synced. SyncModel can be one of:
| Constant | Value | Description |
|---|---|---|
SyncModel::None | 0 | No sync model is defined. |
SyncModel::Geodatabase | 1 | Layers within a geodatabase cannot be synchronized independently; the whole geodatabase must be synced. The sync operation and sync direction applies to all the layers in the geodatabase. |
SyncModel::Layer | 2 | Layers within a geodatabase can be synchronized independently of one another. Any subset of the layers can be synchronized when running the sync operation. Also, each layer's sync direction can be set independently. See Esri::ArcGISRuntime::GenerateGeodatabaseParameters::setLayerOptions and Esri::ArcGISRuntime::GenerateLayerOption. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.0.
[since Esri::ArcGISRuntime 100.11] enum class UtilityNetworkSyncMode
The different modes for generation and synchronization of utility networks as part of a geodatabase sync task.
The UtilityNetworkSyncMode can be one of:
| Constant | Value | Description |
|---|---|---|
UtilityNetworkSyncMode::None | 0 | No utility network resource will be synced. |
UtilityNetworkSyncMode::SyncSystemTables | 1 | Utility Network system tables will be synced. The service must return true for SyncCapabilities::isSupportsUtilityNetworkSystem to support taking Utility Network System data offline. |
UtilityNetworkSyncMode::SyncSystemAndTopologyTables | 2 | Utility network topology and system tables will be synced. The utility network topology enables offline trace capability. The service must return true for SyncCapabilities::isSupportsUtilityNetworkTopology to support taking utility network topology offline. Selecting this enum value will also sync the utility network system tables. |
This enum was introduced or modified in Esri::ArcGISRuntime 100.11.