Class QFieldCloudStatus

ClassList > QFieldCloudStatus

More...

• #include <qfieldcloudstatus.h>

Inherits the following classes: QObject

Public Types

Type	Name
enum	StatusType

Public Properties

Type	Name
property QString	detailsMessage
property bool	hasProblem
property QString	statusMessage
property QString	statusPageUrl
property StatusType	statusType
property QString	url

Public Signals

Type	Name
signal void	statusUpdated
signal void	urlChanged

Public Functions

Type	Name
	QFieldCloudStatus (QObject * parent=nullptr)
QString	detailsMessage () const
bool	hasProblem () const
Q_INVOKABLE void	refresh ()
void	setUrl (const QString & url)
QString	statusMessage () const
QString	statusPageUrl () const
StatusType	statusType () const
QString	url () const

Detailed Description

QFieldCloudStatus fetches the QFieldCloud service status endpoint and exposes the health state of the service to QML.

It fetches the /api/v1/status/ endpoint once per session and provides properties to determine whether the service is degraded, has ongoing incidents, or is under maintenance.

Public Types Documentation

enum StatusType

enum QFieldCloudStatus::StatusType {
    Ok,
    Maintenance,
    Degraded,
    Incident
};

---

Public Properties Documentation

property detailsMessage [1/2]

QString QFieldCloudStatus::detailsMessage;

---

property hasProblem [1/2]

bool QFieldCloudStatus::hasProblem;

---

property statusMessage [1/2]

QString QFieldCloudStatus::statusMessage;

---

property statusPageUrl [1/2]

QString QFieldCloudStatus::statusPageUrl;

---

property statusType [1/2]

StatusType QFieldCloudStatus::statusType;

---

property url [1/2]

QString QFieldCloudStatus::url;

---

Public Signals Documentation

signal statusUpdated

void QFieldCloudStatus::statusUpdated;

---

signal urlChanged

void QFieldCloudStatus::urlChanged;

---

Public Functions Documentation

function QFieldCloudStatus

explicit QFieldCloudStatus::QFieldCloudStatus (
    QObject * parent=nullptr
) 

---

function detailsMessage [2/2]

QString QFieldCloudStatus::detailsMessage () const

Returns additional details (incident/maintenance message) if available.

---

function hasProblem [2/2]

bool QFieldCloudStatus::hasProblem () const

Returns true if the service has any problem (degraded, incident, or maintenance).

---

function refresh

Q_INVOKABLE void QFieldCloudStatus::refresh () 

Manually triggers a status fetch.

---

function setUrl

void QFieldCloudStatus::setUrl (
    const QString & url
) 

Sets the base URL of the QFieldCloud server and triggers a status fetch.

---

function statusMessage [2/2]

QString QFieldCloudStatus::statusMessage () const

Returns a short user-facing message summarizing the service status.

---

function statusPageUrl [2/2]

QString QFieldCloudStatus::statusPageUrl () const

Returns the URL to the status page (e.g. https://status.qfield.cloud/).

---

function statusType [2/2]

StatusType QFieldCloudStatus::statusType () const

Returns the current status type of the QFieldCloud service.

---

function url [2/2]

QString QFieldCloudStatus::url () const

Returns the base URL of the QFieldCloud server.

---

---

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