Sailfish Crypto
API DocumentationRequest Class
(Sailfish::Crypto::Request)Base-class of specific crypto service requests. More...
Public Types
| enum | Status { Inactive, Active, Finished } |
Properties
- customParameters : QVariantMap
- manager : Sailfish::Crypto::CryptoManager *
- result : const Sailfish::Crypto::Result
- status : const Sailfish::Crypto::Request::Status
Public Functions
| Request(QObject *parent = Q_NULLPTR) | |
| virtual | ~Request() |
| virtual QVariantMap | customParameters() const = 0 |
| virtual Sailfish::Crypto::CryptoManager * | manager() const = 0 |
| virtual Sailfish::Crypto::Result | result() const = 0 |
| virtual void | setCustomParameters(const QVariantMap ¶ms) = 0 |
| virtual void | setManager(Sailfish::Crypto::CryptoManager *manager) = 0 |
| virtual void | startRequest() = 0 |
| virtual Sailfish::Crypto::Request::Status | status() const = 0 |
| virtual void | waitForFinished() = 0 |
Signals
| void | customParametersChanged() |
| void | managerChanged() |
| void | resultChanged() |
| void | statusChanged() |
Detailed Description
Base-class of specific crypto service requests.
Member Type Documentation
enum Request::Status
This enum defines the possible states of a Request object
| Constant | Value | Description |
|---|---|---|
Sailfish::Crypto::Request::Inactive | 0 | The Request is inactive and has not been started |
Sailfish::Crypto::Request::Active | 1 | The Request is active and currently being processed |
Sailfish::Crypto::Request::Finished | 2 | The Request has been completed |
Property Documentation
customParameters : QVariantMap
Access functions:
| virtual QVariantMap | customParameters() const = 0 |
| virtual void | setCustomParameters(const QVariantMap ¶ms) = 0 |
Notifier signal:
| void | customParametersChanged() |
manager : Sailfish::Crypto::CryptoManager *
Access functions:
| virtual Sailfish::Crypto::CryptoManager * | manager() const = 0 |
| virtual void | setManager(Sailfish::Crypto::CryptoManager *manager) = 0 |
Notifier signal:
| void | managerChanged() |
result : const Sailfish::Crypto::Result
Access functions:
| virtual Sailfish::Crypto::Result | result() const = 0 |
Notifier signal:
| void | resultChanged() |
status : const Sailfish::Crypto::Request::Status
Access functions:
| virtual Sailfish::Crypto::Request::Status | status() const = 0 |
Notifier signal:
| void | statusChanged() |
Member Function Documentation
Request::Request(QObject *parent = Q_NULLPTR)
Construct a new Request object with the given parent
[virtual] Request::~Request()
Destroys the Request
[pure virtual] QVariantMap Request::customParameters() const
Returns the plugin-specific custom parameters associated with the request
Note: Getter function for property customParameters.
See also setCustomParameters().
[pure virtual] Sailfish::Crypto::CryptoManager *Request::manager() const
Returns the manager through which the request interfaces to the system crypto service
Note: Getter function for property manager.
See also setManager().
[pure virtual] Sailfish::Crypto::Result Request::result() const
Returns the result of the Request
Note: this value is only valid if the status of the request is Request::Finished.
Note: Getter function for property result.
[pure virtual] void Request::setCustomParameters(const QVariantMap ¶ms)
Sets plugin-specific custom parameters associated with the request to params
Note that in most cases, custom parameters set by the client will be ignored, unless the plugin they are requesting functionality from specifically requires a parameter to be passed via the custom parameters. Plugins must document any such requirements, in their user documentation.
Note: Setter function for property customParameters.
See also customParameters().
[pure virtual] void Request::startRequest()
[pure virtual] Sailfish::Crypto::Request::Status Request::status() const
Returns the current status of the Request
Note: Getter function for property status.