WfsService Class

  • WfsService
  • class Esri::ArcGISRuntime::WfsService

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

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

    Public Functions

    WfsService(const QUrl &url, QObject *parent = nullptr)
    WfsService(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, 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


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

    Detailed Description

    Provides an entry point to explore the WFS service metadata via WfsServiceInfo. See the OGC Web Feature Service standard for more information..

    See also Loadable and WfsServiceInfo.

    Member Function Documentation

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

    Creates a WfsService, taking a URL to the service.

    • url - of the WFS service.
    • parent - The optional parent QObject.

    The URL is the 'GetCapabilities' URL for the WFS service. Web Feature Service (WFS) is an OGC standard. This API supports WFS versions 2.0.0 and 2.0.2.

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

    [override virtual] WfsService::~WfsService()


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

    Reimplements: RemoteResource::credential() const.

    Returns the security credential used to access this WfsService.

    Only applicable if the service is secured.

    [since Esri::ArcGISRuntime 100.6] QMap<QString, QString> WfsService::customParameters() const

    Returns these parameters are appended to all WFS requests e.g. GetCapabilities, GetFeature, and DescribeFeatureType.

    Will throw ErrorType::CommonIllegalState if the WFS service is loaded.

    This function was introduced in Esri::ArcGISRuntime 100.6.

    See also setCustomParameters().

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

    See also Loadable and Object.

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

    Reimplements: Loadable::loadError() const.

    Returns the load error.

    See Loadable.

    See also Error.

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

    Reimplements: Loadable::loadStatus() const.

    Returns the load status.

    See Loadable.

    See also LoadStatus.

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

    Signal emitted when the load status changes for this object.

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

    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::WfsServiceInfo WfsService::serviceInfo() const

    Returns the WfsServiceInfo, which describes the WFS service metadata.

    The WFS service info is returned as WfsServiceInfo type.

    [since Esri::ArcGISRuntime 100.6] void WfsService::setCustomParameters(const QMap<QString, QString> &customParameters)

    Sets the customParameters to customParameters.

    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 service's URL.

    Will throw ErrorType::CommonIllegalState if the WFS service is loaded.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.