Implementation of credentials interface for the console. More...

#include <qgscredentials.h>

Inheritance diagram for QgsCredentialsConsole:

Signals
void	destroyed ()
	signals that object will be destroyed and shouldn't be used anymore

Public Member Functions
	QgsCredentialsConsole ()

Public Member Functions inherited from QgsCredentials
virtual	~QgsCredentials ()=default
	Destructor.

bool	get (const QString &realm, QString &username, QString &password, const QString &message=QString(), bool requestCredentials=true)
	Requests credentials for the specified realm.

bool	getMasterPassword (QString &password, bool stored=false)

void	lock ()
	Lock the instance against access from multiple threads.

QMutex *	mutex ()
	Returns pointer to mutex.

void	put (const QString &realm, const QString &username, const QString &password)
	Stores the correct username and password for the specified realm.

void	unlock ()
	Unlock the instance after being locked.

Protected Member Functions
bool	request (const QString &realm, QString &username, QString &password, const QString &message=QString()) override
	request a password

bool	requestMasterPassword (QString &password, bool stored=false) override
	request a master password

Protected Member Functions inherited from QgsCredentials
	QgsCredentials ()=default
	Constructor for QgsCredentials.

void	setInstance (QgsCredentials *instance)
	register instance

Additional Inherited Members
Static Public Member Functions inherited from QgsCredentials
static QgsCredentials *	instance ()
	retrieves instance

Detailed Description

Implementation of credentials interface for the console.

This class outputs message to the standard output and retrieves input from standard input. Therefore it won't be the right choice for apps without GUI.

Definition at line 175 of file qgscredentials.h.

Constructor & Destructor Documentation

◆ QgsCredentialsConsole()

QgsCredentialsConsole::QgsCredentialsConsole ( )

Definition at line 125 of file qgscredentials.cpp.

Member Function Documentation

◆ destroyed

void QgsCredentialsConsole::destroyed ( )

signal

signals that object will be destroyed and shouldn't be used anymore

◆ request()

bool QgsCredentialsConsole::request	(	const QString &	realm,
		QString &	username,
		QString &	password,
		const QString &	message = `QString()`
	)

overrideprotectedvirtual

request a password

Implements QgsCredentials.

Definition at line 130 of file qgscredentials.cpp.

◆ requestMasterPassword()

bool QgsCredentialsConsole::requestMasterPassword	(	QString &	password,
		bool	stored = `false`
	)

overrideprotectedvirtual

request a master password

Implements QgsCredentials.

Definition at line 146 of file qgscredentials.cpp.

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

/build/qgis-3.34.0+99sid/src/core/qgscredentials.h
/build/qgis-3.34.0+99sid/src/core/qgscredentials.cpp

Signals

Public Member Functions

Protected Member Functions