Sailfish Secrets
API DocumentationRequest Class
(Sailfish::Secrets::Request)Base-class of specific secrets service requests. More...
Public Types
| enum | Status { Inactive, Active, Finished } |
Properties
- manager : Sailfish::Secrets::SecretManager *
- result : const Sailfish::Secrets::Result
- status : const Sailfish::Secrets::Request::Status
Public Functions
| Request(QObject *parent = Q_NULLPTR) | |
| virtual | ~Request() |
| virtual Sailfish::Secrets::SecretManager * | manager() const = 0 |
| virtual Sailfish::Secrets::Result | result() const = 0 |
| virtual void | setManager(Sailfish::Secrets::SecretManager *manager) = 0 |
| virtual void | startRequest() = 0 |
| virtual Sailfish::Secrets::Request::Status | status() const = 0 |
| virtual void | waitForFinished() = 0 |
Signals
| void | managerChanged() |
| void | resultChanged() |
| void | statusChanged() |
Detailed Description
Base-class of specific secrets service requests.
Member Type Documentation
enum Request::Status
This enum defines the possible states of a Request object
| Constant | Value | Description |
|---|---|---|
Sailfish::Secrets::Request::Inactive | 0 | The Request is inactive and has not been started |
Sailfish::Secrets::Request::Active | 1 | The Request is active and currently being processed |
Sailfish::Secrets::Request::Finished | 2 | The Request has been completed |
Property Documentation
manager : Sailfish::Secrets::SecretManager *
Access functions:
| virtual Sailfish::Secrets::SecretManager * | manager() const = 0 |
| virtual void | setManager(Sailfish::Secrets::SecretManager *manager) = 0 |
Notifier signal:
| void | managerChanged() |
result : const Sailfish::Secrets::Result
Access functions:
| virtual Sailfish::Secrets::Result | result() const = 0 |
Notifier signal:
| void | resultChanged() |
status : const Sailfish::Secrets::Request::Status
Access functions:
| virtual Sailfish::Secrets::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] Sailfish::Secrets::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::startRequest()
[pure virtual] Sailfish::Secrets::Request::Status Request::status() const
Returns the current status of the Request
Note: Getter function for property status.