The IKeychainService interface provides methods intended to start potentially asynchronous interaction with the keychain and signals intended to notify listeners about the completion of asynchronous interactions.
More...
#include <IKeychainService.h>
|
| IKeychainService (QObject *parent=nullptr) |
|
|
QTextStream & | operator<< (QTextStream &strm, const ErrorCode errorCode) |
|
QDebug & | operator<< (QDebug &dbg, const ErrorCode errorCode) |
|
The IKeychainService interface provides methods intended to start potentially asynchronous interaction with the keychain and signals intended to notify listeners about the completion of asynchronous interactions.
◆ ErrorCode
Error codes for results of operations with the keychain service
Enumerator |
---|
NoError | No error occurred, operation was successful
|
EntryNotFound | For the given key no data was found
|
CouldNotDeleteEntry | Could not delete existing secret data
|
AccessDeniedByUser | User denied access to keychain
|
AccessDenied | Access denied for some reason
|
NoBackendAvailable | No platform-specific keychain service available
|
NotImplemented | Not implemented on platform
|
OtherError | Something else went wrong, the error description specifies what
|
◆ deletePasswordJobFinished
void quentier::IKeychainService::deletePasswordJobFinished |
( |
QUuid |
requestId, |
|
|
ErrorCode |
errorCode, |
|
|
ErrorString |
errorDescription |
|
) |
| |
|
signal |
deletePasswordJobFinished signal should be emitted in response to the call of startDeletePasswordJob method
- Parameters
-
requestId | Request id returned from startDeletePasswordJob method |
errorCode | Error code determining whether the operation was successful or some error has occurred |
errorDescription | Textual description of error in case of unsuccessful execution |
◆ readPasswordJobFinished
void quentier::IKeychainService::readPasswordJobFinished |
( |
QUuid |
requestId, |
|
|
ErrorCode |
errorCode, |
|
|
ErrorString |
errorDescription, |
|
|
QString |
password |
|
) |
| |
|
signal |
readPasswordJobFinished signal should be emitted in response to the call of startReadPasswordJob method
- Parameters
-
requestId | Request id returned from startReadPasswordJob method |
errorCode | Error code determining whether the operation was successful or some error has occurred |
errorDescription | Textual description of error in case of unsuccessful execution |
password | Password read from the keychain |
◆ startDeletePasswordJob()
virtual QUuid quentier::IKeychainService::startDeletePasswordJob |
( |
const QString & |
service, |
|
|
const QString & |
key |
|
) |
| |
|
pure virtual |
startDeletePasswordJob slot should start the potentially asynchronous process of deleting the password from the keychain. When ready, this slot is expected to emit deletePasswordJobFinished signal.
- Parameters
-
service | Name of service within the keychain |
key | Key under which the password is stored |
- Returns
- Unique identifier assigned to this delete password request
◆ startReadPasswordJob()
virtual QUuid quentier::IKeychainService::startReadPasswordJob |
( |
const QString & |
service, |
|
|
const QString & |
key |
|
) |
| |
|
pure virtual |
startReadPasswordJob slot should start the potentially asynchronous process of reading the password from the keychain. When ready, this slot is expected to emit readPasswordJobFinished signal.
- Parameters
-
service | Name of service within the keychain |
key | Key under which the password is stored |
- Returns
- Unique identifier assigned to this read password request
◆ startWritePasswordJob()
virtual QUuid quentier::IKeychainService::startWritePasswordJob |
( |
const QString & |
service, |
|
|
const QString & |
key, |
|
|
const QString & |
password |
|
) |
| |
|
pure virtual |
startWritePasswordJob slot should start the potentially asynchronous process of storing the password in the keychain. When ready, this slot is expected to emit writePasswordJobFinished signal.
- Parameters
-
service | Name of service within the keychain |
key | Key to store the password under |
password | Password to store in the keychain |
- Returns
- Unique identifier assigned to this write password request
◆ writePasswordJobFinished
void quentier::IKeychainService::writePasswordJobFinished |
( |
QUuid |
requestId, |
|
|
ErrorCode |
errorCode, |
|
|
ErrorString |
errorDescription |
|
) |
| |
|
signal |
writePasswordJobFinished signal should be emitted in response to the call of startWritePasswordJob method
- Parameters
-
requestId | Request id returned from startWritePasswordJob method |
errorCode | Error code determining whether the operation was successful or some error has occurred |
errorDescription | Textual description of error in case of unsuccessful execution |