Skip to content

Class QfCloudProject

ClassList > QfCloudProject

Inherits the following classes: QObject

Classes

Type Name
struct FileTransfer

Public Types

Type Name
enum DeltaFileStatus
The status of the running server job for applying deltas on a project.
enum JobStatus
The status of the running server job.
enum JobType
The status of the running server job.
enum PackagingStatus
The status of the running server job for packaging a project.
enum ProjectCheckout
Whether the project has been available locally and/or remotely.
enum ProjectErrorStatus
Whether the project has experienced an error.
enum ProjectModification
Whether the project has no or local and/or remote modification. Indicates wheter can be synced.
enum ProjectRefreshReason
The reason why projectRefreshData was called.
enum ProjectStatus
Whether the project is busy or idle.
enum ProjectType
The type of the cloud project, as reported by the REST endpoint.

Public Properties

Type Name
property bool attachmentsOnDemandEnabled
property bool autoPushEnabled
property int autoPushIntervalMins
property QDateTime createdAt
property QDateTime dataLastUpdatedAt
property DeltaFileStatus deltaFilePushStatus
property QfDeltaFileWrapper * deltaFileWrapper
property int deltasCount
property QString description
property qint64 downloadBytesReceived
property qint64 downloadBytesTotal
property double downloadProgress
property bool forceAutoPush
property QString id
property bool isFeatured
property bool isOutdated
property bool isProjectOutdated
property bool isPublic
property QDateTime lastLocalExportedAt
property QDateTime lastLocalPushDeltas
property QString localPath
property QString name
property QString owner
property QStringList packagedLayerErrors
property PackagingStatus packagingStatus
property double pushDeltaProgress
property qint64 remoteSizeBytes
property ProjectStatus status
property QString thumbnailPath
property ProjectType type
property QDateTime updatedAt
property qint64 uploadBytesSent
property qint64 uploadBytesTotal
property double uploadProgress
property QString userRole
property QString userRoleOrigin

Public Signals

Type Name
signal void attachmentsOnDemandEnabledChanged
signal void autoPushEnabledChanged
signal void autoPushIntervalMinsChanged
signal void canRepackageChanged
signal void checkoutChanged
signal void createdAtChanged
signal void dataLastUpdatedAtChanged
signal void dataRefreshed (ProjectRefreshReason reason, const QString & error=QString())
signal void deltaFileIdChanged
signal void deltaFilePushStatusChanged
signal void deltaFilePushStatusStringChanged
signal void deltaFileWrapperChanged
signal void deltaLayersToDownloadChanged
signal void deltasCountChanged
signal void descriptionChanged
signal void downloadAttachmentFinished (const QString & fileName, const QString & error=QString())
signal void downloadBytesReceivedChanged
signal void downloadBytesTotalChanged
signal void downloadFinished (const QString & error=QString())
signal void downloadProgressChanged
signal void downloaded (const QString & error=QString())
signal void errorStatusChanged
signal void forceAutoPushChanged
signal void idChanged
signal void isFeaturedChanged
signal void isOutdatedChanged
signal void isPackagingActiveChanged
signal void isPackagingFailedChanged
signal void isProjectOutdatedChanged
signal void isPublicChanged
signal void jobFinished (JobType type, const QString & error=QString())
signal void lastDataLastUpdatedAtChanged
signal void lastLocalDataLastUpdatedAtChanged
signal void lastLocalExportIdChanged
signal void lastLocalExportedAtChanged
signal void lastLocalPushDeltasChanged
signal void lastLocalRestrictedDataLastUpdatedAtChanged
signal void lastRefreshedAtChanged
signal void localPathChanged
signal void modificationChanged
signal void nameChanged
signal void needsRepackagingChanged
signal void networkDeltaPushed
signal void networkDeltaStatusChecked
signal void ownerChanged
signal void packagedLayerErrorsChanged
signal void packagingStatusChanged
signal void packagingStatusStringChanged
signal void pushDeltaProgressChanged
signal void pushFinished (bool isDownloading, const QString & error=QString())
signal void remoteSizeBytesChanged
signal void restrictedDataLastUpdatedAtChanged
signal void sharedDatasetsProjectIdChanged
signal void statusChanged
signal void thumbnailPathChanged
signal void typeChanged
signal void updatedAtChanged
signal void uploadBytesSentChanged
signal void uploadBytesTotalChanged
signal void uploadFinished (const QString & error=QString())
signal void uploadProgressChanged
signal void userRoleChanged
signal void userRoleOriginChanged

Public Functions

Type Name
QfCloudProject (const QString & id=QString(), QfCloudConnection * connection=nullptr, QgsGpkgFlusher * gpkgFlusher=nullptr)
bool attachmentsOnDemandEnabled () const
bool autoPushEnabled () const
int autoPushIntervalMins () const
bool canRepackage () const
void cancelDownload ()
void cancelPush ()
ProjectCheckouts checkout () const
QDateTime createdAt () const
QDateTime dataLastUpdatedAt () const
QString deltaFileId () const
DeltaFileStatus deltaFilePushStatus () const
QString deltaFilePushStatusString () const
QfDeltaFileWrapper * deltaFileWrapper () const
QStringList deltaLayersToDownload () const
int deltasCount () const
QString description () const
Q_INVOKABLE void downloadAttachment (const QString & fileName)
qint64 downloadBytesReceived () const
qint64 downloadBytesTotal () const
double downloadProgress () const
Q_INVOKABLE void downloadThumbnail ()
void ensureProjectCreated ()
ProjectErrorStatus errorStatus () const
bool forceAutoPush () const
QString id () const
bool isFeatured () const
bool isOutdated () const
bool isPackagingActive () const
bool isPackagingFailed () const
bool isProjectOutdated () const
bool isPublic () const
QDateTime lastLocalDataLastUpdatedAt () const
QString lastLocalExportId () const
QDateTime lastLocalExportedAt () const
QDateTime lastLocalPushDeltas () const
QDateTime lastLocalRestrictedDataLastUpdatedAt () const
QDateTime lastRefreshedAt () const
QString localPath () const
ProjectModifications modification () const
QString name () const
bool needsRepackaging () const
QString owner () const
Q_INVOKABLE void packageAndDownload ()
QStringList packagedLayerErrors () const
PackagingStatus packagingStatus () const
QString packagingStatusString () const
Q_INVOKABLE void push (bool shouldDownloadUpdates)
double pushDeltaProgress () const
void refreshDeltaList ()
void refreshModification ()
qint64 remoteSizeBytes () const
void removeLocally ()
QDateTime restrictedDataLastUpdatedAt () const
void setAttachmentsOnDemandEnabled (bool enabled)
void setAutoPushEnabled (bool enabled)
void setAutoPushIntervalMins (int minutes)
void setCanRepackage (bool canRepackage)
void setCheckout (ProjectCheckouts checkout)
void setCreatedAt (const QDateTime & createdAt)
void setDataLastUpdatedAt (const QDateTime & dataLastUpdatedAt)
void setDeltaFileId (const QString & deltaFileId)
void setDeltaFilePushStatus (DeltaFileStatus deltaFilePushStatus)
void setDeltaFilePushStatusString (const QString & deltaFilePushStatusString)
void setDeltaLayersToDownload (const QStringList & deltaLayersToDownload)
void setDescription (const QString & description)
void setErrorStatus (ProjectErrorStatus errorStatus)
void setForceAutoPush (bool force)
void setIsFeatured (bool isFeatured)
void setIsOutdated (bool isOutdated)
void setIsPackagingActive (bool isPackagingActive)
void setIsPackagingFailed (bool isPackagingFailed)
void setIsProjectOutdated (bool isProjectOutdated)
void setIsPublic (bool isPublic)
void setLastLocalDataLastUpdatedAt (const QDateTime & lastLocalDataLastUpdatedAt)
void setLastLocalExportId (const QString & lastLocalExportId)
void setLastLocalExportedAt (const QDateTime & lastLocalExportedAt)
void setLastLocalPushDeltas (const QDateTime & lastLocalPushDeltas)
void setLastLocalRestrictedDataLastUpdatedAt (const QDateTime & lastLocalRestrictedDataLastUpdatedAt)
void setLastRefreshedAt (const QDateTime & lastRefreshedAt)
void setLocalPath (const QString & localPath)
void setModification (ProjectModification modification)
void setName (const QString & name)
void setNeedsRepackaging (bool needsRepackaging)
void setOwner (const QString & owner)
void setPackagedLayerErrors (const QStringList & packagedLayerErrors)
void setPackagingStatus (PackagingStatus packagingStatus)
void setPackagingStatusString (const QString & packagingStatusString)
void setRemoteSizeBytes (qint64 remoteSizeBytes)
void setRestrictedDataLastUpdatedAt (const QDateTime & restrictedDataLastUpdatedAt)
void setSharedDatasetsProjectId (const QString & id)
void setStatus (ProjectStatus status)
void setThumbnailPath (const QString & thumbnailPath)
void setType (ProjectType projectType)
void setUpdatedAt (const QDateTime & updatedAt)
void setUserRole (const QString & userRole)
void setUserRoleOrigin (const QString & userRoleOrigin)
QString sharedDatasetsProjectId () const
ProjectStatus status () const
QString thumbnailPath () const
ProjectType type () const
QDateTime updatedAt () const
qint64 uploadBytesSent () const
qint64 uploadBytesTotal () const
Q_INVOKABLE void uploadLocalPath (QString localPath, bool deleteAfterSuccessfulUpload=false)
double uploadProgress () const
QString userRole () const
QString userRoleOrigin () const
~QfCloudProject () = default

Public Static Functions

Type Name
QfCloudProject * fromDetails (const QVariantHash & details, QfCloudConnection * connection, QgsGpkgFlusher * gpkgFlusher=nullptr)
QfCloudProject * fromLocalSettings (const QString & id, QfCloudConnection * connection, QgsGpkgFlusher * gpkgFlusher=nullptr)
QfCloudProject::JobStatus getJobStatusFromString (const QString & status)
QString getJobTypeAsString (QfCloudProject::JobType jobType)
void restoreLocalSettings (QfCloudProject * project, const QDir & localPath)
QfCloudProject::ProjectType typeFromString (const QString & type)
Returns the ProjectType matching the given type string; unknown or empty values return ProjectType::Regular.

Public Types Documentation

enum DeltaFileStatus

The status of the running server job for applying deltas on a project.

enum QfCloudProject::DeltaFileStatus {
    DeltaErrorStatus,
    DeltaLocalStatus,
    DeltaPendingStatus,
    DeltaBusyStatus,
    DeltaConflictStatus,
    DeltaNotAppliedStatus,
    DeltaAppliedStatus
};


enum JobStatus

The status of the running server job.

enum QfCloudProject::JobStatus {
    JobPendingStatus,
    JobQueuedStatus,
    JobStartedStatus,
    JobFinishedStatus,
    JobStoppedStatus,
    JobFailedStatus
};


enum JobType

The status of the running server job.

enum QfCloudProject::JobType {
    Package
};


enum PackagingStatus

The status of the running server job for packaging a project.

enum QfCloudProject::PackagingStatus {
    PackagingUnstartedStatus,
    PackagingErrorStatus,
    PackagingBusyStatus,
    PackagingFinishedStatus,
    PackagingAbortStatus
};


enum ProjectCheckout

Whether the project has been available locally and/or remotely.

enum QfCloudProject::ProjectCheckout {
    RemoteCheckout = 2 << 0,
    LocalCheckout = 2 << 1,
    LocalAndRemoteCheckout = RemoteCheckout | LocalCheckout
};


enum ProjectErrorStatus

Whether the project has experienced an error.

enum QfCloudProject::ProjectErrorStatus {
    NoErrorStatus,
    DownloadErrorStatus,
    PushErrorStatus
};


enum ProjectModification

Whether the project has no or local and/or remote modification. Indicates wheter can be synced.

enum QfCloudProject::ProjectModification {
    NoModification = 0,
    LocalModification = 2 << 0,
    RemoteModification = 2 << 1,
    LocalAndRemoteModification = RemoteModification | LocalModification
};


enum ProjectRefreshReason

The reason why projectRefreshData was called.

enum QfCloudProject::ProjectRefreshReason {
    Package,
    DeltaPushed
};


enum ProjectStatus

Whether the project is busy or idle.

enum QfCloudProject::ProjectStatus {
    Idle,
    Creating,
    Downloading,
    Pushing,
    Uploading,
    Failing
};


enum ProjectType

The type of the cloud project, as reported by the REST endpoint.

enum QfCloudProject::ProjectType {
    Regular,
    SharedDatasets,
    Template
};


Public Properties Documentation

property attachmentsOnDemandEnabled [1/2]

bool QfCloudProject::attachmentsOnDemandEnabled;

property autoPushEnabled [1/2]

bool QfCloudProject::autoPushEnabled;

property autoPushIntervalMins [1/2]

int QfCloudProject::autoPushIntervalMins;

property createdAt [1/2]

QDateTime QfCloudProject::createdAt;

property dataLastUpdatedAt [1/2]

QDateTime QfCloudProject::dataLastUpdatedAt;

property deltaFilePushStatus [1/2]

DeltaFileStatus QfCloudProject::deltaFilePushStatus;

property deltaFileWrapper [1/2]

QfDeltaFileWrapper * QfCloudProject::deltaFileWrapper;

property deltasCount [1/2]

int QfCloudProject::deltasCount;

property description [1/2]

QString QfCloudProject::description;

property downloadBytesReceived [1/2]

qint64 QfCloudProject::downloadBytesReceived;

property downloadBytesTotal [1/2]

qint64 QfCloudProject::downloadBytesTotal;

property downloadProgress [1/2]

double QfCloudProject::downloadProgress;

property forceAutoPush [1/2]

bool QfCloudProject::forceAutoPush;

property id [1/2]

QString QfCloudProject::id;

property isFeatured [1/2]

bool QfCloudProject::isFeatured;

property isOutdated [1/2]

bool QfCloudProject::isOutdated;

property isProjectOutdated [1/2]

bool QfCloudProject::isProjectOutdated;

property isPublic [1/2]

bool QfCloudProject::isPublic;

property lastLocalExportedAt [1/2]

QDateTime QfCloudProject::lastLocalExportedAt;

property lastLocalPushDeltas [1/2]

QDateTime QfCloudProject::lastLocalPushDeltas;

property localPath [1/2]

QString QfCloudProject::localPath;

property name [1/2]

QString QfCloudProject::name;

property owner [1/2]

QString QfCloudProject::owner;

property packagedLayerErrors [1/2]

QStringList QfCloudProject::packagedLayerErrors;

property packagingStatus [1/2]

PackagingStatus QfCloudProject::packagingStatus;

property pushDeltaProgress [1/2]

double QfCloudProject::pushDeltaProgress;

property remoteSizeBytes [1/2]

qint64 QfCloudProject::remoteSizeBytes;

property status [1/2]

ProjectStatus QfCloudProject::status;

property thumbnailPath [1/2]

QString QfCloudProject::thumbnailPath;

property type [1/2]

ProjectType QfCloudProject::type;

property updatedAt [1/2]

QDateTime QfCloudProject::updatedAt;

property uploadBytesSent [1/2]

qint64 QfCloudProject::uploadBytesSent;

property uploadBytesTotal [1/2]

qint64 QfCloudProject::uploadBytesTotal;

property uploadProgress [1/2]

double QfCloudProject::uploadProgress;

property userRole [1/2]

QString QfCloudProject::userRole;

property userRoleOrigin [1/2]

QString QfCloudProject::userRoleOrigin;

Public Signals Documentation

signal attachmentsOnDemandEnabledChanged

void QfCloudProject::attachmentsOnDemandEnabledChanged;

signal autoPushEnabledChanged

void QfCloudProject::autoPushEnabledChanged;

signal autoPushIntervalMinsChanged

void QfCloudProject::autoPushIntervalMinsChanged;

signal canRepackageChanged

void QfCloudProject::canRepackageChanged;

signal checkoutChanged

void QfCloudProject::checkoutChanged;

signal createdAtChanged

void QfCloudProject::createdAtChanged;

signal dataLastUpdatedAtChanged

void QfCloudProject::dataLastUpdatedAtChanged;

signal dataRefreshed

void QfCloudProject::dataRefreshed;

signal deltaFileIdChanged

void QfCloudProject::deltaFileIdChanged;

signal deltaFilePushStatusChanged

void QfCloudProject::deltaFilePushStatusChanged;

signal deltaFilePushStatusStringChanged

void QfCloudProject::deltaFilePushStatusStringChanged;

signal deltaFileWrapperChanged

void QfCloudProject::deltaFileWrapperChanged;

signal deltaLayersToDownloadChanged

void QfCloudProject::deltaLayersToDownloadChanged;

signal deltasCountChanged

void QfCloudProject::deltasCountChanged;

signal descriptionChanged

void QfCloudProject::descriptionChanged;

signal downloadAttachmentFinished

void QfCloudProject::downloadAttachmentFinished;

signal downloadBytesReceivedChanged

void QfCloudProject::downloadBytesReceivedChanged;

signal downloadBytesTotalChanged

void QfCloudProject::downloadBytesTotalChanged;

signal downloadFinished

void QfCloudProject::downloadFinished;

signal downloadProgressChanged

void QfCloudProject::downloadProgressChanged;

signal downloaded

void QfCloudProject::downloaded;

signal errorStatusChanged

void QfCloudProject::errorStatusChanged;

signal forceAutoPushChanged

void QfCloudProject::forceAutoPushChanged;

signal idChanged

void QfCloudProject::idChanged;

signal isFeaturedChanged

void QfCloudProject::isFeaturedChanged;

signal isOutdatedChanged

void QfCloudProject::isOutdatedChanged;

signal isPackagingActiveChanged

void QfCloudProject::isPackagingActiveChanged;

signal isPackagingFailedChanged

void QfCloudProject::isPackagingFailedChanged;

signal isProjectOutdatedChanged

void QfCloudProject::isProjectOutdatedChanged;

signal isPublicChanged

void QfCloudProject::isPublicChanged;

signal jobFinished

void QfCloudProject::jobFinished;

signal lastDataLastUpdatedAtChanged

void QfCloudProject::lastDataLastUpdatedAtChanged;

signal lastLocalDataLastUpdatedAtChanged

void QfCloudProject::lastLocalDataLastUpdatedAtChanged;

signal lastLocalExportIdChanged

void QfCloudProject::lastLocalExportIdChanged;

signal lastLocalExportedAtChanged

void QfCloudProject::lastLocalExportedAtChanged;

signal lastLocalPushDeltasChanged

void QfCloudProject::lastLocalPushDeltasChanged;

signal lastLocalRestrictedDataLastUpdatedAtChanged

void QfCloudProject::lastLocalRestrictedDataLastUpdatedAtChanged;

signal lastRefreshedAtChanged

void QfCloudProject::lastRefreshedAtChanged;

signal localPathChanged

void QfCloudProject::localPathChanged;

signal modificationChanged

void QfCloudProject::modificationChanged;

signal nameChanged

void QfCloudProject::nameChanged;

signal needsRepackagingChanged

void QfCloudProject::needsRepackagingChanged;

signal networkDeltaPushed

void QfCloudProject::networkDeltaPushed;

signal networkDeltaStatusChecked

void QfCloudProject::networkDeltaStatusChecked;

signal ownerChanged

void QfCloudProject::ownerChanged;

signal packagedLayerErrorsChanged

void QfCloudProject::packagedLayerErrorsChanged;

signal packagingStatusChanged

void QfCloudProject::packagingStatusChanged;

signal packagingStatusStringChanged

void QfCloudProject::packagingStatusStringChanged;

signal pushDeltaProgressChanged

void QfCloudProject::pushDeltaProgressChanged;

signal pushFinished

void QfCloudProject::pushFinished;

signal remoteSizeBytesChanged

void QfCloudProject::remoteSizeBytesChanged;

signal restrictedDataLastUpdatedAtChanged

void QfCloudProject::restrictedDataLastUpdatedAtChanged;

signal sharedDatasetsProjectIdChanged

void QfCloudProject::sharedDatasetsProjectIdChanged;

signal statusChanged

void QfCloudProject::statusChanged;

signal thumbnailPathChanged

void QfCloudProject::thumbnailPathChanged;

signal typeChanged

void QfCloudProject::typeChanged;

signal updatedAtChanged

void QfCloudProject::updatedAtChanged;

signal uploadBytesSentChanged

void QfCloudProject::uploadBytesSentChanged;

signal uploadBytesTotalChanged

void QfCloudProject::uploadBytesTotalChanged;

signal uploadFinished

void QfCloudProject::uploadFinished;

signal uploadProgressChanged

void QfCloudProject::uploadProgressChanged;

signal userRoleChanged

void QfCloudProject::userRoleChanged;

signal userRoleOriginChanged

void QfCloudProject::userRoleOriginChanged;

Public Functions Documentation

function QfCloudProject

QfCloudProject::QfCloudProject (
    const QString & id=QString(),
    QfCloudConnection * connection=nullptr,
    QgsGpkgFlusher * gpkgFlusher=nullptr
) 

function attachmentsOnDemandEnabled [2/2]

inline bool QfCloudProject::attachmentsOnDemandEnabled () const

function autoPushEnabled [2/2]

inline bool QfCloudProject::autoPushEnabled () const

function autoPushIntervalMins [2/2]

inline int QfCloudProject::autoPushIntervalMins () const

function canRepackage

inline bool QfCloudProject::canRepackage () const

function cancelDownload

void QfCloudProject::cancelDownload () 

function cancelPush

void QfCloudProject::cancelPush () 

function checkout

inline ProjectCheckouts QfCloudProject::checkout () const

function createdAt [2/2]

inline QDateTime QfCloudProject::createdAt () const

function dataLastUpdatedAt [2/2]

inline QDateTime QfCloudProject::dataLastUpdatedAt () const

function deltaFileId

inline QString QfCloudProject::deltaFileId () const

function deltaFilePushStatus [2/2]

inline DeltaFileStatus QfCloudProject::deltaFilePushStatus () const

function deltaFilePushStatusString

inline QString QfCloudProject::deltaFilePushStatusString () const

function deltaFileWrapper [2/2]

inline QfDeltaFileWrapper * QfCloudProject::deltaFileWrapper () const

function deltaLayersToDownload

inline QStringList QfCloudProject::deltaLayersToDownload () const

function deltasCount [2/2]

inline int QfCloudProject::deltasCount () const

function description [2/2]

inline QString QfCloudProject::description () const

function downloadAttachment

Q_INVOKABLE void QfCloudProject::downloadAttachment (
    const QString & fileName
) 

function downloadBytesReceived [2/2]

inline qint64 QfCloudProject::downloadBytesReceived () const

function downloadBytesTotal [2/2]

inline qint64 QfCloudProject::downloadBytesTotal () const

function downloadProgress [2/2]

inline double QfCloudProject::downloadProgress () const

function downloadThumbnail

Q_INVOKABLE void QfCloudProject::downloadThumbnail () 

function ensureProjectCreated

void QfCloudProject::ensureProjectCreated () 

function errorStatus

inline ProjectErrorStatus QfCloudProject::errorStatus () const

function forceAutoPush [2/2]

inline bool QfCloudProject::forceAutoPush () const

function id [2/2]

inline QString QfCloudProject::id () const

function isFeatured [2/2]

inline bool QfCloudProject::isFeatured () const

function isOutdated [2/2]

inline bool QfCloudProject::isOutdated () const

function isPackagingActive

inline bool QfCloudProject::isPackagingActive () const

function isPackagingFailed

inline bool QfCloudProject::isPackagingFailed () const

function isProjectOutdated [2/2]

inline bool QfCloudProject::isProjectOutdated () const

function isPublic [2/2]

inline bool QfCloudProject::isPublic () const

function lastLocalDataLastUpdatedAt

inline QDateTime QfCloudProject::lastLocalDataLastUpdatedAt () const

function lastLocalExportId

inline QString QfCloudProject::lastLocalExportId () const

function lastLocalExportedAt [2/2]

inline QDateTime QfCloudProject::lastLocalExportedAt () const

function lastLocalPushDeltas [2/2]

inline QDateTime QfCloudProject::lastLocalPushDeltas () const

function lastLocalRestrictedDataLastUpdatedAt

inline QDateTime QfCloudProject::lastLocalRestrictedDataLastUpdatedAt () const

function lastRefreshedAt

inline QDateTime QfCloudProject::lastRefreshedAt () const

function localPath [2/2]

inline QString QfCloudProject::localPath () const

function modification

inline ProjectModifications QfCloudProject::modification () const

function name [2/2]

inline QString QfCloudProject::name () const

function needsRepackaging

inline bool QfCloudProject::needsRepackaging () const

function owner [2/2]

inline QString QfCloudProject::owner () const

function packageAndDownload

Q_INVOKABLE void QfCloudProject::packageAndDownload () 

function packagedLayerErrors [2/2]

inline QStringList QfCloudProject::packagedLayerErrors () const

function packagingStatus [2/2]

inline PackagingStatus QfCloudProject::packagingStatus () const

function packagingStatusString

inline QString QfCloudProject::packagingStatusString () const

function push

Q_INVOKABLE void QfCloudProject::push (
    bool shouldDownloadUpdates
) 

function pushDeltaProgress [2/2]

inline double QfCloudProject::pushDeltaProgress () const

function refreshDeltaList

void QfCloudProject::refreshDeltaList () 

function refreshModification

void QfCloudProject::refreshModification () 

function remoteSizeBytes [2/2]

inline qint64 QfCloudProject::remoteSizeBytes () const

function removeLocally

void QfCloudProject::removeLocally () 

function restrictedDataLastUpdatedAt

inline QDateTime QfCloudProject::restrictedDataLastUpdatedAt () const

function setAttachmentsOnDemandEnabled

void QfCloudProject::setAttachmentsOnDemandEnabled (
    bool enabled
) 

function setAutoPushEnabled

void QfCloudProject::setAutoPushEnabled (
    bool enabled
) 

function setAutoPushIntervalMins

void QfCloudProject::setAutoPushIntervalMins (
    int minutes
) 

function setCanRepackage

void QfCloudProject::setCanRepackage (
    bool canRepackage
) 

function setCheckout

void QfCloudProject::setCheckout (
    ProjectCheckouts checkout
) 

function setCreatedAt

void QfCloudProject::setCreatedAt (
    const QDateTime & createdAt
) 

function setDataLastUpdatedAt

void QfCloudProject::setDataLastUpdatedAt (
    const QDateTime & dataLastUpdatedAt
) 

function setDeltaFileId

void QfCloudProject::setDeltaFileId (
    const QString & deltaFileId
) 

function setDeltaFilePushStatus

void QfCloudProject::setDeltaFilePushStatus (
    DeltaFileStatus deltaFilePushStatus
) 

function setDeltaFilePushStatusString

void QfCloudProject::setDeltaFilePushStatusString (
    const QString & deltaFilePushStatusString
) 

function setDeltaLayersToDownload

void QfCloudProject::setDeltaLayersToDownload (
    const QStringList & deltaLayersToDownload
) 

function setDescription

void QfCloudProject::setDescription (
    const QString & description
) 

function setErrorStatus

void QfCloudProject::setErrorStatus (
    ProjectErrorStatus errorStatus
) 

function setForceAutoPush

void QfCloudProject::setForceAutoPush (
    bool force
) 

function setIsFeatured

void QfCloudProject::setIsFeatured (
    bool isFeatured
) 

function setIsOutdated

void QfCloudProject::setIsOutdated (
    bool isOutdated
) 

function setIsPackagingActive

void QfCloudProject::setIsPackagingActive (
    bool isPackagingActive
) 

function setIsPackagingFailed

void QfCloudProject::setIsPackagingFailed (
    bool isPackagingFailed
) 

function setIsProjectOutdated

void QfCloudProject::setIsProjectOutdated (
    bool isProjectOutdated
) 

function setIsPublic

void QfCloudProject::setIsPublic (
    bool isPublic
) 

function setLastLocalDataLastUpdatedAt

void QfCloudProject::setLastLocalDataLastUpdatedAt (
    const QDateTime & lastLocalDataLastUpdatedAt
) 

function setLastLocalExportId

void QfCloudProject::setLastLocalExportId (
    const QString & lastLocalExportId
) 

function setLastLocalExportedAt

void QfCloudProject::setLastLocalExportedAt (
    const QDateTime & lastLocalExportedAt
) 

function setLastLocalPushDeltas

void QfCloudProject::setLastLocalPushDeltas (
    const QDateTime & lastLocalPushDeltas
) 

function setLastLocalRestrictedDataLastUpdatedAt

void QfCloudProject::setLastLocalRestrictedDataLastUpdatedAt (
    const QDateTime & lastLocalRestrictedDataLastUpdatedAt
) 

function setLastRefreshedAt

void QfCloudProject::setLastRefreshedAt (
    const QDateTime & lastRefreshedAt
) 

function setLocalPath

void QfCloudProject::setLocalPath (
    const QString & localPath
) 

function setModification

void QfCloudProject::setModification (
    ProjectModification modification
) 

function setName

void QfCloudProject::setName (
    const QString & name
) 

function setNeedsRepackaging

void QfCloudProject::setNeedsRepackaging (
    bool needsRepackaging
) 

function setOwner

void QfCloudProject::setOwner (
    const QString & owner
) 

function setPackagedLayerErrors

void QfCloudProject::setPackagedLayerErrors (
    const QStringList & packagedLayerErrors
) 

function setPackagingStatus

void QfCloudProject::setPackagingStatus (
    PackagingStatus packagingStatus
) 

function setPackagingStatusString

void QfCloudProject::setPackagingStatusString (
    const QString & packagingStatusString
) 

function setRemoteSizeBytes

void QfCloudProject::setRemoteSizeBytes (
    qint64 remoteSizeBytes
) 

function setRestrictedDataLastUpdatedAt

void QfCloudProject::setRestrictedDataLastUpdatedAt (
    const QDateTime & restrictedDataLastUpdatedAt
) 

function setSharedDatasetsProjectId

void QfCloudProject::setSharedDatasetsProjectId (
    const QString & id
) 

function setStatus

void QfCloudProject::setStatus (
    ProjectStatus status
) 

function setThumbnailPath

void QfCloudProject::setThumbnailPath (
    const QString & thumbnailPath
) 

function setType

void QfCloudProject::setType (
    ProjectType projectType
) 

function setUpdatedAt

void QfCloudProject::setUpdatedAt (
    const QDateTime & updatedAt
) 

function setUserRole

void QfCloudProject::setUserRole (
    const QString & userRole
) 

function setUserRoleOrigin

void QfCloudProject::setUserRoleOrigin (
    const QString & userRoleOrigin
) 

function sharedDatasetsProjectId

inline QString QfCloudProject::sharedDatasetsProjectId () const

function status [2/2]

inline ProjectStatus QfCloudProject::status () const

function thumbnailPath [2/2]

inline QString QfCloudProject::thumbnailPath () const

function type [2/2]

inline ProjectType QfCloudProject::type () const

function updatedAt [2/2]

inline QDateTime QfCloudProject::updatedAt () const

function uploadBytesSent [2/2]

inline qint64 QfCloudProject::uploadBytesSent () const

function uploadBytesTotal [2/2]

inline qint64 QfCloudProject::uploadBytesTotal () const

function uploadLocalPath

Q_INVOKABLE void QfCloudProject::uploadLocalPath (
    QString localPath,
    bool deleteAfterSuccessfulUpload=false
) 

function uploadProgress [2/2]

inline double QfCloudProject::uploadProgress () const

function userRole [2/2]

inline QString QfCloudProject::userRole () const

function userRoleOrigin [2/2]

inline QString QfCloudProject::userRoleOrigin () const

function ~QfCloudProject

QfCloudProject::~QfCloudProject () = default

Public Static Functions Documentation

function fromDetails

static QfCloudProject * QfCloudProject::fromDetails (
    const QVariantHash & details,
    QfCloudConnection * connection,
    QgsGpkgFlusher * gpkgFlusher=nullptr
) 

function fromLocalSettings

static QfCloudProject * QfCloudProject::fromLocalSettings (
    const QString & id,
    QfCloudConnection * connection,
    QgsGpkgFlusher * gpkgFlusher=nullptr
) 

function getJobStatusFromString

static QfCloudProject::JobStatus QfCloudProject::getJobStatusFromString (
    const QString & status
) 

function getJobTypeAsString

static QString QfCloudProject::getJobTypeAsString (
    QfCloudProject::JobType jobType
) 

function restoreLocalSettings

static void QfCloudProject::restoreLocalSettings (
    QfCloudProject * project,
    const QDir & localPath
) 

function typeFromString

Returns the ProjectType matching the given type string; unknown or empty values return ProjectType::Regular.

static QfCloudProject::ProjectType QfCloudProject::typeFromString (
    const QString & type
) 



The documentation for this class was generated from the following file src/core/qfieldcloud/qfcloudproject.h