QGpgME  10.3.4.0000000
Qt API for GpgME
Public Member Functions | List of all members
QGpgME::Protocol Class Referenceabstract

#include <protocol.h>

Public Member Functions

virtual QString name () const =0
 
virtual QString displayName () const =0
 
virtual KeyListJobkeyListJob (bool remote=false, bool includeSigs=false, bool validate=false) const =0
 
virtual ListAllKeysJoblistAllKeysJob (bool includeSigs=false, bool validate=false) const =0
 
virtual EncryptJobencryptJob (bool armor=false, bool textmode=false) const =0
 
virtual DecryptJobdecryptJob () const =0
 
virtual SignJobsignJob (bool armor=false, bool textMode=false) const =0
 
virtual VerifyDetachedJobverifyDetachedJob (bool textmode=false) const =0
 
virtual VerifyOpaqueJobverifyOpaqueJob (bool textmode=false) const =0
 
virtual KeyGenerationJobkeyGenerationJob () const =0
 
virtual ImportJobimportJob () const =0
 
virtual ImportFromKeyserverJobimportFromKeyserverJob () const =0
 
virtual ExportJobpublicKeyExportJob (bool armor=false) const =0
 
virtual ExportJobsecretKeyExportJob (bool armor=false, const QString &charset=QString()) const =0
 
virtual DownloadJobdownloadJob (bool armor=false) const =0
 
virtual DeleteJobdeleteJob () const =0
 
virtual SignEncryptJobsignEncryptJob (bool armor=false, bool textMode=false) const =0
 
virtual DecryptVerifyJobdecryptVerifyJob (bool textmode=false) const =0
 
virtual RefreshKeysJobrefreshKeysJob () const =0
 
virtual ChangeExpiryJobchangeExpiryJob () const =0
 
virtual SignKeyJobsignKeyJob () const =0
 
virtual ChangePasswdJobchangePasswdJob () const =0
 
virtual ChangeOwnerTrustJobchangeOwnerTrustJob () const =0
 
virtual AddUserIDJobaddUserIDJob () const =0
 
virtual SpecialJobspecialJob (const char *type, const QMap< QString, QVariant > &args) const =0
 
virtual KeyListJoblocateKeysJob () const =0
 
virtual KeyForMailboxJobkeyForMailboxJob () const =0
 
virtual WKSPublishJobwksPublishJob () const =0
 
virtual TofuPolicyJobtofuPolicyJob () const =0
 
virtual QuickJobquickJob () const =0
 

Detailed Description

The main entry point for QGpgME Comes in OpenPGP and SMIME(CMS) flavors.

Use the proctocol class to obtain an instance of a job. Jobs provide async API for GnuPG that can be connected to signals / slots.

A job is usually started with start() and emits a result signal. The parameters of the result signal depend on the job but the last two are always a QString for the auditlog and an GpgME::Error for an eventual error.

In case async API is used and the result signal is emitted a job schedules its own deletion.

Most jobs also provide a synchronous call exec in which case you have to explicitly delete the job if you don't need it anymore.

// Async example:
KeyListJob *job = openpgp()->keyListJob();
connect(job, &KeyListJob::result, job, [this, job](KeyListResult, std::vector<Key> keys, QString, Error)
{
// keys and resuls can now be used.
});
// Sync eaxmple:
KeyListJob *job = openpgp()->keyListJob(false, false, false);
std::vector<GpgME::Key> keys;
GpgME::KeyListResult result = job->exec(QStringList() <<
QStringLiteral("alfa@example.net"),
false, keys);
delete job;

Member Function Documentation

◆ keyForMailboxJob()

virtual KeyForMailboxJob* QGpgME::Protocol::keyForMailboxJob ( ) const
pure virtual

Find the best key to use for a mailbox.

◆ locateKeysJob()

virtual KeyListJob* QGpgME::Protocol::locateKeysJob ( ) const
pure virtual

A key locate job.

This tries to find a key in local and remote sources, if the key was remote it is imported by GnuPG. Same as KeyListJob but intended to be used to locate keys automatically. This ends up calling –locate-keys.

Only available for OpenPGP

Results are validated. As if keyListJob was called with both includeSigs and validate options.

◆ quickJob()

virtual QuickJob* QGpgME::Protocol::quickJob ( ) const
pure virtual

A Job for the quick commands

◆ tofuPolicyJob()

virtual TofuPolicyJob* QGpgME::Protocol::tofuPolicyJob ( ) const
pure virtual

A Job to set tofu policy

◆ wksPublishJob()

virtual WKSPublishJob* QGpgME::Protocol::wksPublishJob ( ) const
pure virtual

A Job for interacting with gnupg's wks tools.


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