Class QfCloudConnection

ClassList > QfCloudConnection

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< QfAuthenticationProvider >	availableProviders
property QString	avatarUrl
property QString	defaultUrl
property bool	hasProviderConfiguration
property bool	hasToken
property bool	isFetchingAvailableProviders
property bool	isReachable
property QString	password
property QString	provider
property QfCloudServerInformation	serverInformation
property ConnectionState	state
property ConnectionStatus	status
property QString	url
property QStringList	urls
property QfCloudUserInformation	userInformation
property QString	username

Public Signals

Type	Name
signal void	availableProvidersChanged
signal void	avatarUrlChanged
signal void	error
signal void	isFetchingAvailableProvidersChanged
signal void	isReachableChanged
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	queuedProjectPushRequested (const QString & projectId)
signal void	serverInformationChanged
signal void	stateChanged
signal void	statusChanged
signal void	subscriptionInformationReceived (const QfCloudSubscriptionInformation & subscriptionInformation)
signal void	tokenChanged
signal void	urlChanged
signal void	urlsChanged
signal void	userInformationChanged
signal void	userOrganizationsReceived (const QStringList & organizations)
signal void	usernameChanged

Public Functions

Type	Name
	QfCloudConnection ()
QList< QfAuthenticationProvider >	availableProviders () const
QString	avatarUrl () const
QfNetworkReply *	get (const QString & endpoint, const QVariantMap & params=QVariantMap())
QfNetworkReply *	get (QNetworkRequest & request, const QString & endpoint, const QVariantMap & params=QVariantMap())
QfNetworkReply *	get (QNetworkRequest & request, const QUrl & url, const QVariantMap & params=QVariantMap())
Q_INVOKABLE void	getServerInformation ()
Q_INVOKABLE void	getSubscriptionInformation (const QString & user)
Q_INVOKABLE void	getUserOrganizations (const QString & user)
bool	hasProviderConfiguration ()
bool	hasToken ()
bool	isFetchingAvailableProviders () const
bool	isReachable () const
Q_INVOKABLE void	login (const QString & password=QString())
Q_INVOKABLE void	logout ()
QString	password () const
QfNetworkReply *	post (const QString & endpoint, const QVariantMap & params=QVariantMap(), const QStringList & fileNames=QStringList())
QfNetworkReply *	post (QNetworkRequest & request, const QString & endpoint, const QVariantMap & params=QVariantMap(), const QStringList & fileNames=QStringList())
QString	provider () const
void	queueProjectPush (const QString & projectId)
QfCloudServerInformation	serverInformation () 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
QfCloudUserInformation	userInformation () const
QString	username () const
	~QfCloudConnection ()

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 QfCloudConnection::ConnectionState {
    Idle,
    Busy
};

---

enum ConnectionStatus

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

---

Public Static Attributes Documentation

variable sErrors

Contains a map of error codes and translated messages.

QMap< QString, QString > QfCloudConnection::sErrors;

---

Public Properties Documentation

property availableProviders [1/2]

QList<QfAuthenticationProvider> QfCloudConnection::availableProviders;

---

property avatarUrl [1/2]

QString QfCloudConnection::avatarUrl;

---

property defaultUrl [1/2]

QString QfCloudConnection::defaultUrl;

---

property hasProviderConfiguration [1/2]

bool QfCloudConnection::hasProviderConfiguration;

---

property hasToken [1/2]

bool QfCloudConnection::hasToken;

---

property isFetchingAvailableProviders [1/2]

bool QfCloudConnection::isFetchingAvailableProviders;

---

property isReachable [1/2]

bool QfCloudConnection::isReachable;

---

property password [1/2]

QString QfCloudConnection::password;

---

property provider [1/2]

QString QfCloudConnection::provider;

---

property serverInformation [1/2]

QfCloudServerInformation QfCloudConnection::serverInformation;

---

property state [1/2]

ConnectionState QfCloudConnection::state;

---

property status [1/2]

ConnectionStatus QfCloudConnection::status;

---

property url [1/2]

QString QfCloudConnection::url;

---

property urls [1/2]

QStringList QfCloudConnection::urls;

---

property userInformation [1/2]

QfCloudUserInformation QfCloudConnection::userInformation;

---

property username [1/2]

QString QfCloudConnection::username;

---

Public Signals Documentation

signal availableProvidersChanged

void QfCloudConnection::availableProvidersChanged;

---

signal avatarUrlChanged

void QfCloudConnection::avatarUrlChanged;

---

signal error

void QfCloudConnection::error;

---

signal isFetchingAvailableProvidersChanged

void QfCloudConnection::isFetchingAvailableProvidersChanged;

---

signal isReachableChanged

void QfCloudConnection::isReachableChanged;

---

signal loginFailed

void QfCloudConnection::loginFailed;

---

signal passwordChanged

void QfCloudConnection::passwordChanged;

---

signal pendingAttachmentsAdded

void QfCloudConnection::pendingAttachmentsAdded;

---

signal pendingAttachmentsUploadFinished

void QfCloudConnection::pendingAttachmentsUploadFinished;

---

signal pendingAttachmentsUploadStatus

void QfCloudConnection::pendingAttachmentsUploadStatus;

---

signal providerChanged

void QfCloudConnection::providerChanged;

---

signal providerConfigurationChanged

void QfCloudConnection::providerConfigurationChanged;

---

signal queuedProjectPushRequested

void QfCloudConnection::queuedProjectPushRequested;

---

signal serverInformationChanged

void QfCloudConnection::serverInformationChanged;

---

signal stateChanged

void QfCloudConnection::stateChanged;

---

signal statusChanged

void QfCloudConnection::statusChanged;

---

signal subscriptionInformationReceived

void QfCloudConnection::subscriptionInformationReceived;

---

signal tokenChanged

void QfCloudConnection::tokenChanged;

---

signal urlChanged

void QfCloudConnection::urlChanged;

---

signal urlsChanged

void QfCloudConnection::urlsChanged;

---

signal userInformationChanged

void QfCloudConnection::userInformationChanged;

---

signal userOrganizationsReceived

void QfCloudConnection::userOrganizationsReceived;

---

signal usernameChanged

void QfCloudConnection::usernameChanged;

---

Public Functions Documentation

function QfCloudConnection

QfCloudConnection::QfCloudConnection () 

---

function availableProviders [2/2]

QList< QfAuthenticationProvider > QfCloudConnection::availableProviders () const

---

function avatarUrl [2/2]

QString QfCloudConnection::avatarUrl () const

---

function get [1/3]

QfNetworkReply * QfCloudConnection::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]

QfNetworkReply * QfCloudConnection::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]

QfNetworkReply * QfCloudConnection::get (
    QNetworkRequest & request,
    const QUrl & url,
    const QVariantMap & params=QVariantMap()
) 

---

function getServerInformation

Q_INVOKABLE void QfCloudConnection::getServerInformation () 

---

function getSubscriptionInformation

Q_INVOKABLE void QfCloudConnection::getSubscriptionInformation (
    const QString & user
) 

---

function getUserOrganizations

Q_INVOKABLE void QfCloudConnection::getUserOrganizations (
    const QString & user
) 

---

function hasProviderConfiguration [2/2]

inline bool QfCloudConnection::hasProviderConfiguration () 

---

function hasToken [2/2]

inline bool QfCloudConnection::hasToken () 

---

function isFetchingAvailableProviders [2/2]

bool QfCloudConnection::isFetchingAvailableProviders () const

---

function isReachable [2/2]

bool QfCloudConnection::isReachable () const

Returns whether the network is currently reachable.

If reachability information is not available, this returns true to keep the existing behavior unchanged.

---

function login

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

---

function logout

Q_INVOKABLE void QfCloudConnection::logout () 

---

function password [2/2]

QString QfCloudConnection::password () const

---

function post [1/2]

QfNetworkReply * QfCloudConnection::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]

QfNetworkReply * QfCloudConnection::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 QfCloudConnection::provider () const

---

function queueProjectPush

void QfCloudConnection::queueProjectPush (
    const QString & projectId
) 

Queues a project push request when the network is not reachable.

The push will be automatically triggered once the connection is back online and the user is logged in.

---

function serverInformation [2/2]

inline QfCloudServerInformation QfCloudConnection::serverInformation () const

---

function setAuthenticationDetails

void QfCloudConnection::setAuthenticationDetails (
    QNetworkRequest & request
) 

Sets authentication details on a request.

---

function setPassword

void QfCloudConnection::setPassword (
    const QString & password
) 

---

function setProvider

void QfCloudConnection::setProvider (
    const QString & provider
) 

---

function setUrl

void QfCloudConnection::setUrl (
    const QString & url
) 

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

---

function setUsername

void QfCloudConnection::setUsername (
    const QString & username
) 

---

function state [2/2]

ConnectionState QfCloudConnection::state () const

---

function status [2/2]

ConnectionStatus QfCloudConnection::status () const

---

function token

QString QfCloudConnection::token () const

---

function uploadPendingAttachments

qsizetype QfCloudConnection::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 QfCloudConnection::url () const

Returns the currently set server connection URL.

---

function urls [2/2]

QStringList QfCloudConnection::urls () const

Returns the connections URLs successfully logged in in the past.

---

function userInformation [2/2]

QfCloudUserInformation QfCloudConnection::userInformation () const

---

function username [2/2]

QString QfCloudConnection::username () const

---

function ~QfCloudConnection

QfCloudConnection::~QfCloudConnection () 

---

Public Static Functions Documentation

function defaultUrl [2/2]

static QString QfCloudConnection::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 QfCloudConnection::errorString (
    QNetworkReply * reply
) 

---

---

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