Skip To Content ArcGIS for Developers Sign In Dashboard

WfsService Class

class Esri::ArcGISRuntime::WfsService

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

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

This class was introduced in Esri::ArcGISRuntime 100.5.

Public Functions

WfsService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
WfsService(const QUrl &url, QObject *parent = nullptr)
virtual ~WfsService() override
QMap<QString, QString> customParameters() const
Esri::ArcGISRuntime::WfsServiceInfo 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(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

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, Esri::ArcGISRuntime::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).

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

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

[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.

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

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] WfsService::~WfsService()

Destructor.

[override virtual] void WfsService::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Credential *WfsService::credential() const

Reimplements: RemoteResource::credential() const.

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().

[override virtual] void WfsService::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error WfsService::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus WfsService::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration WfsService::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this task.

See also setRequestConfiguration().

[override virtual] void WfsService::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

Esri::ArcGISRuntime::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().

[override virtual] void WfsService::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 WfsService::url() const

Reimplements: RemoteResource::url() const.

Returns the URL of this WfsService.


Feedback on this topic?