ArcGIS Runtime SDK for iOS
100.15
|
An OGC-WMS service.
An instance of this class represents an OGC-WMS service.
Runtime supports WMS versions 1.3.0, 1.1.1, and 1.1.0. The latest supported WMS version is set as the default. To specify a preferred WMS version, set the VERSION
parameter in the GetCapabilities
URL for the service.
Instance Methods | |
(void) | - cancelLoad |
(void) | - doCancelLoading |
(void) | - doStartLoading: |
(instancetype) | - initWithURL: |
(void) | - loadDidFinishWithError: |
(void) | - loadWithCompletion: |
(void) | - onLoadStatusChanged |
(void) | - retryLoadWithCompletion: |
Class Methods | |
(instancetype) | + WMSServiceWithURL: |
Properties | |
AGSCredential * | credential |
NSDictionary< NSString *, NSString * > * | customParameters |
NSError * | loadError |
AGSLoadStatus | loadStatus |
AGSRequestConfiguration * | requestConfiguration |
AGSWMSServiceInfo * | serviceInfo |
NSURL * | URL |
AGSWMSVersion | version |
|
requiredinherited |
Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion:
or retryLoadWithCompletion:
to complete and this will call them all back with the error of NSUserCancelledError
- (void) doCancelLoading |
Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
at the end passing in an error representing NSUserCancelledError
.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (void) doStartLoading: | (BOOL) | retrying |
Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p)
or retryLoadWithCompletion: (AGSLoadable-p)
is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly))
upon completion, passing in the error if any.
retrying | flag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p) . |
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
- (instancetype) initWithURL: | (NSURL *) | URL |
Initialize this object with a URL to a WMS service. The URL can be the GetCapabilities
URL for the service, for example - https://sampleserver6.arcgisonline.com/arcgis/services/SampleWorldCities/MapServer/WMSServer?request=GetCapabilities&service=WMS , or it could be a URL that just points to the service endpoint where the GetCapabilities
request can be issued, such as - https://sampleserver6.arcgisonline.com/arcgis/services/SampleWorldCities/MapServer/WMSServer
Runtime supports WMS versions 1.3.0, 1.1.1, and 1.1.0. The latest supported WMS version is set as the default. To specify a preferred WMS version, set the VERSION
parameter in the GetCapabilities
URL for the service.
URL | to WMS service |
- (void) loadDidFinishWithError: | (nullable NSError *) | error |
Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly))
and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly))
when done loading or failed to load.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Loads data for the object asynchronously. The completion block is invoked upon completion.
You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
- cancelLoad
to cancel loading - retryLoadWithCompletion:
to force reload - (void) onLoadStatusChanged |
Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus
changes is called. Subclasses can optionally implement this to know when their loading status has changed.
Provided by category AGSLoadableBase(ForSubclassEyesOnly).
|
requiredinherited |
Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:
cancelLoad
and then this methodIf the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.
completion | block that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load. |
+ (instancetype) WMSServiceWithURL: | (NSURL *) | URL |
Initialize this object with a URL to a WMS service. The URL can be the GetCapabilities
URL for the service, for example - https://sampleserver6.arcgisonline.com/arcgis/services/SampleWorldCities/MapServer/WMSServer?request=GetCapabilities&service=WMS , or it could be a URL that just points to the service endpoint where the GetCapabilities
request can be issued, such as - https://sampleserver6.arcgisonline.com/arcgis/services/SampleWorldCities/MapServer/WMSServer
Runtime supports WMS versions 1.3.0, 1.1.1, and 1.1.0. The latest supported WMS version is set as the default. To specify a preferred WMS version, set the VERSION
parameter in the GetCapabilities
URL for the service.
URL | to WMS service |
|
readwritenonatomicstronginherited |
Security credentials to access the remote resource. Only applicable if the resource is secured.
|
readwritenonatomiccopy |
These parameters are appended to GetCapabilities
, GetMap
, and GetFeatureInfo
requests issued to the WMS service. If a parameter with the same name is defined in the service's custom parameters, then layer-specific values take precedence over service-wide values. Parameters intended for GetCapabilities
requests should be set before the service is loaded
|
readnonatomicstronginherited |
The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.
|
readrequirednonatomicassigninherited |
Status of the load operation.
|
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.
|
readnonatomicstrong |
Metadata of the WMS service
|
readrequirednonatomicstronginherited |
The URL of the remote resource.
|
readnonatomicassign |
The version of the WMS service. Runtime supports WMS versions 1.3.0, 1.1.1, and 1.1.0. The latest supported WMS version is set as the default. To specify a preferred WMS version, set the VERSION
parameter in the GetCapabilities
URL for the service.