An OGC API - Features service. More...
| Header: | #include <OgcFeatureService.h> |
| Since: | Esri::ArcGISRuntime 100.9 |
| Inherits: | Esri::ArcGISRuntime::Object, Esri::ArcGISRuntime::Loadable, and Esri::ArcGISRuntime::RemoteResource |
Public Functions
| OgcFeatureService(const QUrl &url, QObject *parent = nullptr) | |
| OgcFeatureService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr) | |
| virtual | ~OgcFeatureService() override |
| QMap<QString, QString> | customParameters() const |
| Esri::ArcGISRuntime::OgcFeatureServiceInfo * | serviceInfo() const |
| void | setCustomParameters(const QMap<QString, QString> &customParameters) |
Reimplemented Public Functions
| virtual void | cancelLoad() override |
| virtual Esri::ArcGISRuntime::Credential * | credential() const override |
| virtual void | load() override |
| virtual Esri::ArcGISRuntime::Error | loadError() const override |
| virtual Esri::ArcGISRuntime::LoadStatus | loadStatus() const override |
| virtual Esri::ArcGISRuntime::RequestConfiguration | requestConfiguration() const override |
| virtual void | retryLoad() override |
| virtual void | setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override |
| virtual QUrl | url() const override |
Signals
| void | doneLoading(const Esri::ArcGISRuntime::Error &loadError) |
| void | loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus) |
Detailed Description
Use OgcFeatureServiceInfo as an entry point to explore the OGC API - Features service metadata.
Relevant samples:
- Browse OGC API Feature Service: Browse an OGC API feature service for layers and add them to the map.
Member Function Documentation
[explicit] OgcFeatureService::OgcFeatureService (const QUrl &url, QObject *parent = nullptr)
Creates an OgcFeatureService, taking a URL to the service landing page.
- url - The URL of the OGC API - Features service landing page.
- parent - The optional parent QObject.
[since Esri::ArcGISRuntime 100.11] OgcFeatureService::OgcFeatureService (const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
Creates an OgcFeatureService, taking a URL to the service landing page.
- url - The URL of the OGC API - Features service landing page.
- credential - The Credential used to access this service.
- parent - The optional parent QObject.
This function was introduced in Esri::ArcGISRuntime 100.11.
[override virtual] OgcFeatureService::~OgcFeatureService ()
Destructor.
[override virtual] void OgcFeatureService::cancelLoad ()
Reimplements: Loadable::cancelLoad().
Cancels loading metadata for the object.
Cancels loading the metadata if the object is loading.
See Loadable.
[override virtual] Esri::ArcGISRuntime::Credential *OgcFeatureService::credential() const
Reimplements: RemoteResource::credential() const.
Returns the security credential used to access this OgcFeatureService.
Only applicable if the service is secured.
QMap<QString, QString> OgcFeatureService::customParameters () const
Returns the vendor-specific parameters that are appended to all OGC API - Features HTTP requests. If the OGC API - Features service is loaded, an error will be thrown.
See also setCustomParameters().
[signal] void OgcFeatureService::doneLoading (const Esri::ArcGISRuntime::Error &loadError )
Signal emitted when this object is done loading.
- loadError - Details about any error that may have occurred.
Note: If there is a load error it will also be emitted on the errorOccurred signal.
[override virtual] void OgcFeatureService::load()
Reimplements: Loadable::load().
Loads the metadata for the object asynchronously.
Loads the metadata if the object is not loaded.
See Loadable.
[override virtual] Esri::ArcGISRuntime::Error OgcFeatureService::loadError () const
Reimplements: Loadable::loadError() const.
Returns the load error.
See Loadable.
See also Error.
[override virtual] Esri::ArcGISRuntime::LoadStatus OgcFeatureService::loadStatus () const
Reimplements: Loadable::loadStatus() const.
Returns the load status.
See Loadable.
See also LoadStatus.
[signal] void OgcFeatureService::loadStatusChanged (Esri::ArcGISRuntime::LoadStatus loadStatus )
Signal emitted when the load status changes for this object.
- loadStatus - The LoadStatus.
See also Loadable.
[override virtual] Esri::ArcGISRuntime::RequestConfiguration OgcFeatureService::requestConfiguration () const
Reimplements: RemoteResource::requestConfiguration() const.
Returns the RequestConfiguration in use by this task.
See also setRequestConfiguration().
[override virtual] void OgcFeatureService::retryLoad ()
Reimplements: Loadable::retryLoad().
Loads or retries loading metadata for the object asynchronously.
Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.
See Loadable.
Esri::ArcGISRuntime::OgcFeatureServiceInfo *OgcFeatureService::serviceInfo () const
Returns the OgcFeatureServiceInfo that describes the OGC API - Features service.
void OgcFeatureService::setCustomParameters (const QMap<QString, QString> &customParameters )
Sets the customParameters to customParameters.
Note: this property can only be set before the OGC API - Features service is loaded.
See also customParameters.
[override virtual] void OgcFeatureService::setRequestConfiguration (const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration )
Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).
Sets configuration parameters used for network requests sent by this task to requestConfiguration.
See also requestConfiguration().
[override virtual] QUrl OgcFeatureService::url() const
Reimplements: RemoteResource::url() const.
Returns the service's landing page URL.
If the OGC API - Features service is loaded, an error is thrown.