mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-24 00:47:57 -05:00
1c615c15cc
Use Qt style "returns .." tense instead of "return ..", and lock this in with a documentation compliance unit test
74 lines
2.0 KiB
Plaintext
74 lines
2.0 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/server/qgsservice.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsService
|
|
{
|
|
%Docstring
|
|
QgsService
|
|
Class defining interfaces for QGIS server services
|
|
|
|
This class provides methods for executing server requests
|
|
They are registered at runtime for a given service name.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsservice.h"
|
|
#include "qgsserverrequest.h"
|
|
#include "qgsserverresponse.h"
|
|
%End
|
|
public:
|
|
|
|
QgsService();
|
|
%Docstring
|
|
Constructor
|
|
%End
|
|
|
|
virtual ~QgsService();
|
|
|
|
virtual QString name() const = 0;
|
|
%Docstring
|
|
|
|
:return: the name of the service
|
|
%End
|
|
|
|
virtual QString version() const = 0;
|
|
%Docstring
|
|
|
|
:return: the version of the service
|
|
%End
|
|
|
|
virtual bool allowMethod( QgsServerRequest::Method ) const = 0;
|
|
%Docstring
|
|
Returns true if the given method is supported for that
|
|
service.
|
|
%End
|
|
|
|
virtual void executeRequest( const QgsServerRequest &request,
|
|
QgsServerResponse &response,
|
|
const QgsProject *project ) = 0;
|
|
%Docstring
|
|
Execute the requests and set result in :py:class:`QgsServerRequest`
|
|
%End
|
|
};
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/server/qgsservice.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|