gws.plugin.qfieldcloud.core

QField project configuration and object.

Source code: gws.plugin.qfieldcloud.core

Module Contents

class gws.plugin.qfieldcloud.core.DeltaApplyError

Bases: gws.Error

Raised when a delta payload cannot be applied.

class gws.plugin.qfieldcloud.core.DeltaStatus

Bases: gws.Data

Status of a delta, as returned to QField.

content: gws.plugin.qfieldcloud.api.Delta

Delta as sent by QField.

created_at: str

Creation time.

created_by: str

Login name of the user who sent the delta.

deltafile_id: str

Id of the delta payload.

id: str

Delta id.

output: str

Error message, if the delta could not be applied.

status: gws.plugin.qfieldcloud.api.DeltaStatusType

Delta status.

updated_at: str

Last update time.

class gws.plugin.qfieldcloud.core.ProjectConfig

Bases: gws.ConfigWithAccess

Project offered to QField, packaged from a QGIS project.

mapCacheLifeTime: gws.Duration = '0'

How long rendered offline base maps are reused.

models: list[gws.ext.config.model] | None

Data models for editable layers, matched by table name.

provider: gws.plugin.qgis.provider.Config

QGIS project the QField package is built from.

thumbnail: gws.FilePath | None

Thumbnail image shown in the project details. (added in 8.5)

title: str = ''

Project title shown in QField.

class gws.plugin.qfieldcloud.core.QfcProject

Bases: gws.Node

Project offered to QField.

Holds the QGIS provider of the source project, the models for editable layers and the base map settings used when the project is packaged.

mapCacheLifeTime: int

How long rendered base maps are reused, in seconds. 0 disables the cache.

models: list[gws.DatabaseModel]

Configured models for editable layers.

qgisProvider: gws.plugin.qgis.provider.Object

QGIS provider for the source project.

thumbnail: str

Path to the thumbnail image, or an empty string.

title: str

Project title, the uid if no title is configured.

configure()