gws.plugin.qfieldcloud.action

QField Cloud API action.

Source code: gws.plugin.qfieldcloud.action

Module Contents

class gws.plugin.qfieldcloud.action.Config

Bases: gws.ConfigWithAccess

Endpoint for QField clients that emulates the QFieldCloud API.

auth: gws.base.auth.method.Config | None

Token authentication method for QField clients.

deltaLifeTime: gws.Duration = '30d'

How long uploaded changes are kept on the server for status requests. (added in 8.5)

projects: list[gws.plugin.qfieldcloud.core.ProjectConfig]

Projects offered to QField clients.

class gws.plugin.qfieldcloud.action.Object

Bases: gws.plugin.qfieldcloud.action_base.BaseAction

QField Cloud API action.

Emulates the QFieldCloud API for the QField app: authenticates clients by token, lists the configured QField projects, creates packages in background jobs and applies deltas and file uploads from the devices.

get_handler() → gws.plugin.qfieldcloud.action_handler.Handler

Return a new request handler. Override to use a custom handler.

Returns:

Request handler.

raw_request(req: gws.WebRequester, p: gws.Request) → gws.ContentResponse

Handle a QFieldCloud API request.

class gws.plugin.qfieldcloud.action.Props

Bases: gws.base.action.Props