gws.plugin.qfieldcloud.core

QField project configuration and object.

Source code: gws.plugin.qfieldcloud.core

Module Contents

class gws.plugin.qfieldcloud.core.ProjectConfig(*args, **kwargs)

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

Configuration hook.

Called when the node is initialized. Raising an exception here aborts the creation of the node.