Quotient::AccountSettings Class Reference

A group of settings for one Matrix account. More...

#include <settings.h>

Inheritance diagram for Quotient::AccountSettings:

Collaboration diagram for Quotient::AccountSettings:

Public Member Functions
	AccountSettings (const QString &accountId, QObject *parent=nullptr)
QString	userId () const
QUrl	homeserver () const
void	setHomeserver (const QUrl &url)
QByteArray	encryptionAccountPickle ()
void	setEncryptionAccountPickle (const QByteArray &encryptionAccountPickle)
Q_INVOKABLE void	clearEncryptionAccountPickle ()
Public Member Functions inherited from Quotient::SettingsGroup
	SettingsGroup (const QString &path, QObject *parent=nullptr)
Public Member Functions inherited from Quotient::Settings
	Settings (QObject *parent=nullptr)
Q_INVOKABLE void	setValue (const QString &key, const QVariant &value)
	Set the value for a given key.
Q_INVOKABLE void	remove (const QString &key)
	Remove the value from both the primary and legacy locations.
Q_INVOKABLE QVariant	value (const QString &key, const QVariant &defaultValue={}) const
	Obtain a value for a given key.
template<typename T >
T	get (const QString &key, const T &defaultValue={}) const
	Obtain a value for a given key, coerced to the given type.
Q_INVOKABLE bool	contains (const QString &key) const
Q_INVOKABLE QStringList	childGroups () const
Q_INVOKABLE QStringList	childGroups (bool decodeSlashes) const

Properties
QString	userId
QByteArray	encryptionAccountPickle

Additional Inherited Members
Static Public Member Functions inherited from Quotient::Settings
static void	setLegacyNames (const QString &organizationName, const QString &applicationName={})
	Add a legacy organisation/application name to migrate settings from.
static QString	toEncoded (QString key)
	Escape forward- and backslashes in keys because QSettings doesn't (see #842)
static QString	fromEncoded (QString key)
	Unescape \ and / in keys stored with escapedForSettings()
Protected Attributes inherited from Quotient::Settings
QSettings	legacySettings { legacyOrganizationName, legacyApplicationName }

Detailed Description

A group of settings for one Matrix account.

This class provides typesafe accessors to common account settings such as user and device id. User id (aka MXID) is stored as a group name. Although QSettings does not protect forward- and backslashes inside group names, AccountSettings covers for that, percent-encoding the user id before passing it to QSettings.

Definition at line 113 of file settings.h.

Constructor & Destructor Documentation

AccountSettings()

Quotient::AccountSettings::AccountSettings ( const QString &  accountId, QObject *  parent = nullptr  )

explicit

Member Function Documentation

clearEncryptionAccountPickle()

Q_INVOKABLE void Quotient::AccountSettings::clearEncryptionAccountPickle

(

)

encryptionAccountPickle()

QByteArray Quotient::AccountSettings::encryptionAccountPickle

(

)

homeserver()

QUrl Quotient::AccountSettings::homeserver

(

)

const

setEncryptionAccountPickle()

void Quotient::AccountSettings::setEncryptionAccountPickle

(

const QByteArray &

encryptionAccountPickle

)

setHomeserver()

void Quotient::AccountSettings::setHomeserver

(

const QUrl &

url

)

userId()

QString Quotient::AccountSettings::userId

(

)

const

Property Documentation

encryptionAccountPickle

QByteArray Quotient::AccountSettings::encryptionAccountPickle

readwrite

Definition at line 119 of file settings.h.

userId

QString Quotient::AccountSettings::userId

read

Definition at line 115 of file settings.h.

---

The documentation for this class was generated from the following file:

• Quotient/settings.h