Skip To Content ArcGIS for Developers Sign In Dashboard

WfsService Class


An OGC Web Feature Service (WFS). More...

Header: #include <WfsService>
Since: Esri::ArcGISRuntime 100.5
Inherits: Object, Loadable, and RemoteResource

Public Functions

WfsService(const QUrl &url, QObject *parent = nullptr)
WfsService(const QUrl &url, Credential *credential, QObject *parent = nullptr)
QMap<QString, QString> customParameters() const
WfsServiceInfo serviceInfo() const
void setCustomParameters(const QMap<QString, QString> &customParameters)

Reimplemented Public Functions

virtual void cancelLoad()
virtual Credential *credential() const
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual RequestConfiguration requestConfiguration() const
virtual void retryLoad()
virtual void setRequestConfiguration(const RequestConfiguration &requestConfiguration)
virtual QUrl url() const


void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

An OGC Web Feature Service (WFS).

The WfsService is constructed using the URL of the service and once the load task completes (see Loadable) allows the user to browse for predefined content via the serviceInfo.

This provides an entry point to explore the WFS service metadata.

See also Loadable and WfsServiceInfo.

Member Function Documentation

WfsService::WfsService(const QUrl &url, QObject *parent = nullptr)

Constructor that accepts a URL (url) and an optional parent.

WfsService::WfsService(const QUrl &url, Credential *credential, QObject *parent = nullptr)

Constructor that accepts a URL, a Credential, and an optional parent object.

  • url - The URL of the WFS service.
  • credential - The credential.
  • parent - The parent object for this WfsService (optional).



[virtual] void WfsService::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

[virtual] Credential *WfsService::credential() const

Reimplemented from RemoteResource::credential().

Returns the security credential used to access this WfsService.

Only applicable if the service is secured.

QMap<QString, QString> WfsService::customParameters() const

Returns parameters that are appended to all WFS requests.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also setCustomParameters().

[signal] void WfsService::doneLoading(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.

See also Loadable and Object.

[virtual] void WfsService::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error WfsService::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus WfsService::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

[signal] void WfsService::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[virtual] RequestConfiguration WfsService::requestConfiguration() const

Reimplemented from RemoteResource::requestConfiguration().

Returns the RequestConfiguration in use by this task.

See also setRequestConfiguration().

[virtual] void WfsService::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.

WfsServiceInfo WfsService::serviceInfo() const

Returns the service info for this service.

A WfsServiceInfo provides the information for browsing and accessing the service contents.

void WfsService::setCustomParameters(const QMap<QString, QString> &customParameters)

Sets parameters that are appended to all WFS requests.

customParameters New value for custom parameters.

Note: this property can only be set before the WFS service is loaded.

This function was introduced in Esri::ArcGISRuntime 100.6.

See also customParameters().

[virtual] void WfsService::setRequestConfiguration(const RequestConfiguration &requestConfiguration)

Reimplemented from RemoteResource::setRequestConfiguration().

Sets configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().

[virtual] QUrl WfsService::url() const

Reimplemented from RemoteResource::url().

Returns the URL of this WfsService.

Feedback on this topic?