Description
A long running job on a remote server.
Instances of this class represent a long running job on a remote server.
A job is initiated when it is submitted to the server. When the server accepts the job, it assigns a unique ID to the job which is avialable in serverJobID. The client then periodically polls for the status of the job on the server. If the job completes successfully, the result of the job is downloaded, otherwise an error is provided when the job fails.
You should always cancel jobs that are no longer needed. This can send a cancel request to the server and helps reduce unnecessary server load.
- Since
- 100
Instance Methods | |
| (BOOL) | - cancel |
| (id< AGSCancelable >) | - cancelWithCompletion: |
| (id< AGSCancelable >) | - checkStatusWithCompletion: |
| (BOOL) | - pause |
| (void) | - startWithStatusHandler:completion: |
| (nullable id) | - toJSON: |
Class Methods | |
| (nullable id< AGSJSONSerializable >) | + fromJSON:error: |
Properties | |
| AGSCredential * | credential |
| NSError * | error |
| AGSJobType | jobType |
| NSArray< AGSJobMessage * > * | messages |
| NSProgress * | progress |
| AGSRequestConfiguration * | requestConfiguration |
| id | result |
| NSString * | serverJobID |
| AGSJobStatus | status |
| NSDictionary< NSString *, id > * | unknownJSON |
| NSDictionary< NSString *, id > * | unsupportedJSON |
| NSURL * | URL |
Method Documentation
◆ cancel
| - (BOOL) cancel |
Cancels the job. Returns a value indicating whether the job was successfully canceled.
- Since
- 100
- Deprecated:
- 100.1. Replaced by
cancelWithCompletion:.
Provided by category AGSJob(AGSDeprecated).
◆ cancelWithCompletion:
| - (id<AGSCancelable>) cancelWithCompletion: | (void(^)(NSError *_Nullable error)) | completion |
Cancels this AGSJob and waits for any asynchronous, server-side operations to be canceled.
The job is canceled and will result in an AGSJobStatusFailed status after all cancellation tasks have completed. For jobs running on a server, a cancel request is sent for the associated AGSJob::serverJobID. You should always cancel unneeded jobs (for example when exiting your app) to avoid placing unnecessary load on the server. Examples of server-side jobs include:
In addition, the AGSGenerateOfflineMapJob is composed of several server-side jobs, depending on the types of layers in your AGSMap. Canceling this high-level job will also send a cancel request to the underlying server jobs.
Upon calling this method, the AGSJob::status is immediately set to AGSJobStatusCanceling.
- Parameters
-
completion A block that is invoked when the operation completes successfully or encounters an error.
- Returns
- An operation which can be canceled.
- Since
- 100.14
◆ checkStatusWithCompletion:
| - (id<AGSCancelable>) checkStatusWithCompletion: | (void(^)(NSError *__nullable error)) | completion |
Force status check. This method can be called from UIApplication::application:performFetchWithCompletionHandler:.
- Since
- 100.0
◆ fromJSON:error:
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
- Parameters
-
JSONObject NSDictionaryorNSArraycontaining the JSON.error encountered during the operation, if any.
- Since
- 100
◆ pause
| - (BOOL) pause |
Pauses the job. Returns a value indicating whether the job was successfully paused.
- Since
- 100
- Deprecated:
- 100.1. Please use the
pausemethod through the NSProgress API (exposed viaNSProgressReportingthrough theprogressproperty).
Provided by category AGSJob(AGSDeprecated).
◆ startWithStatusHandler:completion:
| - (void) startWithStatusHandler: | (nullable void(^)(AGSJobStatus status)) | statusHandler | |
| completion: | (void(^)(id __nullable result, NSError *__nullable error)) | completion | |
◆ toJSON:
|
requiredinherited |
Returns JSON representation for this object.
- Parameters
-
error encountered during the operation, if any.
- Returns
NSDictionaryorNSArraycontaining the JSON.
- Since
- 100
Reimplemented in AGSPortalItem.
Property Documentation
◆ credential
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
- Since
- 100
◆ error
|
readnonatomicstrong |
Error encountered during job execution, if any.
- Since
- 100
◆ jobType
|
readnonatomicassign |
The type of job
- Since
- 100
◆ messages
|
readnonatomiccopy |
Informational messages produced during execution of the job.
The messages can be monitored using Key-Value Observing (KVO).
- Since
- 100
◆ progress
|
readnonatomicstrong |
The progress for this job. As a consumer of this progress property, you can observe it's property changes and pause, cancel, resume. Do not, however, set the readwrite properties of this progress object. Those are reserved for internal use. Setting them externally will corrupt the state and lead to undefined behavior.
- Since
- 100.1
◆ requestConfiguration
|
readwritenonatomicstronginherited |
The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.
- Since
- 100
◆ result
|
readnonatomicstrong |
Result of the job.
- Since
- 100
◆ serverJobID
|
readnonatomiccopy |
Unique ID of the job on the server on which it is executing.
- Since
- 100
◆ status
|
readnonatomicassign |
Current status of the job.
The status can be monitored using Key-Value Observing (KVO).
- Since
- 100
◆ unknownJSON
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
- Returns
NSDictionarycontaining the unknown JSON.
- Since
- 100
◆ unsupportedJSON
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
- Returns
NSDictionarycontaining the unsupported JSON.
- Since
- 100
◆ URL
|
readrequirednonatomicstronginherited |
The URL of the remote resource.
- Since
- 100
