GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

qt: Improve WKSPublishJob apidoc

Browse Source 
* lang/qt/src/wkspublishjob.h: Improve doc.
This commit is contained in:
Andre Heinecke 2016-10-19 15:17:09 +02:00
parent cffa924064
commit 26cbba3c9c
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
lang/qt/src/wkspublishjob.h
View File

@ -47,6 +47,15 @@ namespace QGpgME {
* *
* Remember that after a result is emitted the job is auto deleted * Remember that after a result is emitted the job is auto deleted
* so you can only use it for a single action. * so you can only use it for a single action.
*
* The workflow is to call startCreate, check for errors and then
* send the RFC822 mail returned in returnedData.
*
* When the response is received start a startRecieve with the
* RFC822 mail received as paramater response. Check for errors
* and then send again send the result from returnedData back to
* the server.
*
*/ */
class QGPGME_EXPORT WKSPublishJob: public Job class QGPGME_EXPORT WKSPublishJob: public Job
{ {
@ -69,16 +78,16 @@ public:
virtual void startCheck(const QString &mailbox) = 0; virtual void startCheck(const QString &mailbox) = 0;
/** Create a publish request. /** Create a publish request.
* The returned Data from the result will contain * The returnedData from the result signal will contain
* the full Mail as returned by gpg-wks-client --create * the full Request as returned by gpg-wks-client --create
* *
* @param fpr the fingerprint of the key to create the request for. * @param fpr the fingerprint of the key to create the request for.
* @param mailbox A simple mail address without a Name. * @param mailbox A simple mail address without a Name.
*/ */
virtual void startCreate(const char *fpr, const QString &mailbox) = 0; virtual void startCreate(const char *fpr, const QString &mailbox) = 0;
/** Handle a submisson response. The returned Data will contain /** Handle a submisson response. The returnedData in the result singnal
* the full Mail as returned by gpg-wks-client --create * will contain the confirmation response as returned by gpg-wks-client --receive
* *
* @param response The response of the server. * @param response The response of the server.
**/ **/