Class QFieldCloudConnection

ClassList > QFieldCloudConnection

Inherits the following classes: QObject

Classes

Type	Name
class	CloudError

Public Types

Type	Name
enum	ConnectionState
enum	ConnectionStatus

Public Static Attributes

Type	Name
QMap< QString, QString >	sErrors = /* multi line expression */ Contains a map of error codes and translated messages.

Public Properties

Type	Name
property QList< AuthenticationProvider >	availableProviders
property QString	avatarUrl
property QString	defaultUrl
property bool	hasProviderConfiguration
property bool	hasToken
property bool	isFetchingAvailableProviders
property QString	password
property QString	provider
property ConnectionState	state
property ConnectionStatus	status
property QString	url
property QStringList	urls
property CloudUserInformation	userInformation
property QString	username

Public Signals

Type	Name
signal void	availableProvidersChanged
signal void	avatarUrlChanged
signal void	error
signal void	isFetchingAvailableProvidersChanged
signal void	loginFailed (const QString & reason)
signal void	passwordChanged
signal void	pendingAttachmentsAdded
signal void	pendingAttachmentsUploadFinished (const QString & error=QString())
signal void	pendingAttachmentsUploadStatus (const QString & fileName, double fileProgress, qsizetype uploadPending)
signal void	providerChanged
signal void	providerConfigurationChanged
signal void	stateChanged
signal void	statusChanged
signal void	tokenChanged
signal void	urlChanged
signal void	urlsChanged
signal void	userInformationChanged
signal void	usernameChanged

Public Functions

Type	Name
	QFieldCloudConnection ()
QList< AuthenticationProvider >	availableProviders () const
QString	avatarUrl () const
NetworkReply *	get (const QString & endpoint, const QVariantMap & params=QVariantMap())
NetworkReply *	get (QNetworkRequest & request, const QString & endpoint, const QVariantMap & params=QVariantMap())
NetworkReply *	get (QNetworkRequest & request, const QUrl & url, const QVariantMap & params=QVariantMap())
Q_INVOKABLE void	getAuthenticationProviders ()
bool	hasProviderConfiguration ()
bool	hasToken ()
bool	isFetchingAvailableProviders () const
Q_INVOKABLE void	login (const QString & password=QString())
Q_INVOKABLE void	logout ()
QString	password () const
NetworkReply *	post (const QString & endpoint, const QVariantMap & params=QVariantMap(), const QStringList & fileNames=QStringList())
NetworkReply *	post (QNetworkRequest & request, const QString & endpoint, const QVariantMap & params=QVariantMap(), const QStringList & fileNames=QStringList())
QString	provider () const
void	setAuthenticationDetails (QNetworkRequest & request)
void	setPassword (const QString & password)
void	setProvider (const QString & provider)
void	setUrl (const QString & url)
void	setUsername (const QString & username)
ConnectionState	state () const
ConnectionStatus	status () const
QString	token () const
qsizetype	uploadPendingAttachments ()
QString	url () const
QStringList	urls () const
CloudUserInformation	userInformation () const
QString	username () const

Public Static Functions

Type	Name
QString	defaultUrl ()
QString	errorString (QNetworkReply * reply) Returns an error string to be shown to the user if reply has an error.

Public Types Documentation

enum ConnectionState

enum QFieldCloudConnection::ConnectionState {
    Idle,
    Busy
};

---

enum ConnectionStatus

enum QFieldCloudConnection::ConnectionStatus {
    Disconnected,
    Connecting,
    LoggedIn
};

---

Public Static Attributes Documentation

variable sErrors

Contains a map of error codes and translated messages.

QMap< QString, QString > QFieldCloudConnection::sErrors;

---

Public Properties Documentation

property availableProviders [1/2]

QList<AuthenticationProvider> QFieldCloudConnection::availableProviders;

---

property avatarUrl [1/2]

QString QFieldCloudConnection::avatarUrl;

---

property defaultUrl [1/2]

QString QFieldCloudConnection::defaultUrl;

---

property hasProviderConfiguration [1/2]

bool QFieldCloudConnection::hasProviderConfiguration;

---

property hasToken [1/2]

bool QFieldCloudConnection::hasToken;

---

property isFetchingAvailableProviders [1/2]

bool QFieldCloudConnection::isFetchingAvailableProviders;

---

property password [1/2]

QString QFieldCloudConnection::password;

---

property provider [1/2]

QString QFieldCloudConnection::provider;

---

property state [1/2]

ConnectionState QFieldCloudConnection::state;

---

property status [1/2]

ConnectionStatus QFieldCloudConnection::status;

---

property url [1/2]

QString QFieldCloudConnection::url;

---

property urls [1/2]

QStringList QFieldCloudConnection::urls;

---

property userInformation [1/2]

CloudUserInformation QFieldCloudConnection::userInformation;

---

property username [1/2]

QString QFieldCloudConnection::username;

---

Public Signals Documentation

signal availableProvidersChanged

void QFieldCloudConnection::availableProvidersChanged;

---

signal avatarUrlChanged

void QFieldCloudConnection::avatarUrlChanged;

---

signal error

void QFieldCloudConnection::error;

---

signal isFetchingAvailableProvidersChanged

void QFieldCloudConnection::isFetchingAvailableProvidersChanged;

---

signal loginFailed

void QFieldCloudConnection::loginFailed;

---

signal passwordChanged

void QFieldCloudConnection::passwordChanged;

---

signal pendingAttachmentsAdded

void QFieldCloudConnection::pendingAttachmentsAdded;

---

signal pendingAttachmentsUploadFinished

void QFieldCloudConnection::pendingAttachmentsUploadFinished;

---

signal pendingAttachmentsUploadStatus

void QFieldCloudConnection::pendingAttachmentsUploadStatus;

---

signal providerChanged

void QFieldCloudConnection::providerChanged;

---

signal providerConfigurationChanged

void QFieldCloudConnection::providerConfigurationChanged;

---

signal stateChanged

void QFieldCloudConnection::stateChanged;

---

signal statusChanged

void QFieldCloudConnection::statusChanged;

---

signal tokenChanged

void QFieldCloudConnection::tokenChanged;

---

signal urlChanged

void QFieldCloudConnection::urlChanged;

---

signal urlsChanged

void QFieldCloudConnection::urlsChanged;

---

signal userInformationChanged

void QFieldCloudConnection::userInformationChanged;

---

signal usernameChanged

void QFieldCloudConnection::usernameChanged;

---

Public Functions Documentation

function QFieldCloudConnection

QFieldCloudConnection::QFieldCloudConnection () 

---

function availableProviders [2/2]

QList< AuthenticationProvider > QFieldCloudConnection::availableProviders () const

---

function avatarUrl [2/2]

QString QFieldCloudConnection::avatarUrl () const

---

function get [1/3]

NetworkReply * QFieldCloudConnection::get (
    const QString & endpoint,
    const QVariantMap & params=QVariantMap()
) 

Sends a get request to the given endpoint. Query can be passed via params, empty by default.

If this connection is not logged in, will return nullptr. The returned reply needs to be deleted by the caller.

---

function get [2/3]

NetworkReply * QFieldCloudConnection::get (
    QNetworkRequest & request,
    const QString & endpoint,
    const QVariantMap & params=QVariantMap()
) 

Sends a get request to a given endpoint. Additional query can be passed via params, empty by default.

If this connection is not logged in, will return nullptr. The returned reply needs to be deleted by the caller.

---

function get [3/3]

NetworkReply * QFieldCloudConnection::get (
    QNetworkRequest & request,
    const QUrl & url,
    const QVariantMap & params=QVariantMap()
) 

---

function getAuthenticationProviders

Q_INVOKABLE void QFieldCloudConnection::getAuthenticationProviders () 

---

function hasProviderConfiguration [2/2]

inline bool QFieldCloudConnection::hasProviderConfiguration () 

---

function hasToken [2/2]

inline bool QFieldCloudConnection::hasToken () 

---

function isFetchingAvailableProviders [2/2]

bool QFieldCloudConnection::isFetchingAvailableProviders () const

---

function login

Q_INVOKABLE void QFieldCloudConnection::login (
    const QString & password=QString()
) 

---

function logout

Q_INVOKABLE void QFieldCloudConnection::logout () 

---

function password [2/2]

QString QFieldCloudConnection::password () const

---

function post [1/2]

NetworkReply * QFieldCloudConnection::post (
    const QString & endpoint,
    const QVariantMap & params=QVariantMap(),
    const QStringList & fileNames=QStringList()
) 

Sends a post request with the given parameters to the given endpoint.

If this connection is not logged in, will return nullptr. The returned reply needs to be deleted by the caller.

---

function post [2/2]

NetworkReply * QFieldCloudConnection::post (
    QNetworkRequest & request,
    const QString & endpoint,
    const QVariantMap & params=QVariantMap(),
    const QStringList & fileNames=QStringList()
) 

Sends a post request with the given parameters to the given endpoint.

If this connection is not logged in, will return nullptr. The returned reply needs to be deleted by the caller.

---

function provider [2/2]

QString QFieldCloudConnection::provider () const

---

function setAuthenticationDetails

void QFieldCloudConnection::setAuthenticationDetails (
    QNetworkRequest & request
) 

Sets authentication details on a request.

---

function setPassword

void QFieldCloudConnection::setPassword (
    const QString & password
) 

---

function setProvider

void QFieldCloudConnection::setProvider (
    const QString & provider
) 

---

function setUrl

void QFieldCloudConnection::setUrl (
    const QString & url
) 

Sets the current server connection URL and saves it into QSettings.

---

function setUsername

void QFieldCloudConnection::setUsername (
    const QString & username
) 

---

function state [2/2]

ConnectionState QFieldCloudConnection::state () const

---

function status [2/2]

ConnectionStatus QFieldCloudConnection::status () const

---

function token

QString QFieldCloudConnection::token () const

---

function uploadPendingAttachments

qsizetype QFieldCloudConnection::uploadPendingAttachments () 

Uploads any pending attachments linked to the logged in user account.

Returns:

the number of attachments to be uploaded.

---

function url [2/2]

QString QFieldCloudConnection::url () const

Returns the currently set server connection URL.

---

function urls [2/2]

QStringList QFieldCloudConnection::urls () const

Returns the connections URLs successfully logged in in the past.

---

function userInformation [2/2]

CloudUserInformation QFieldCloudConnection::userInformation () const

---

function username [2/2]

QString QFieldCloudConnection::username () const

---

Public Static Functions Documentation

function defaultUrl [2/2]

static QString QFieldCloudConnection::defaultUrl () 

Default server connection URL, pointing to the production server.

---

function errorString

Returns an error string to be shown to the user if reply has an error.

static QString QFieldCloudConnection::errorString (
    QNetworkReply * reply
) 

---

---

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