Sailfish Secrets
API DocumentationPluginInfo Class
(Sailfish::Secrets::PluginInfo)Information about a plugin More...
| Header: | #include <Secrets/plugininfo.h> |
Public Types
| enum | Status { Unknown, Available, MasterUnlocked, PluginUnlocked, PluginSupportsLocking, PluginSupportsSetLockCode } |
| flags | StatusFlags |
Properties
- displayName : const QString
- name : const QString
- statusFlags : const StatusFlags
- version : const int
Public Functions
| PluginInfo(const QString &displayName = QString(), const QString &name = QString(), int version = 0, StatusFlags status = PluginInfo::Unknown) | |
| PluginInfo(const PluginInfo &other) | |
| ~PluginInfo() | |
| QString | displayName() const |
| QString | name() const |
| StatusFlags | statusFlags() const |
| int | version() const |
| PluginInfo & | operator=(const Sailfish::Secrets::PluginInfo &other) |
Detailed Description
Information about a plugin
The result encapsulates the name and version of a plugin. Instances of this object which contain information about plugins which are available for use by clients can be accessed via PluginInfoRequest.
Clients should target a specific plugin when they implement their application, as each plugin may have slightly different semantics.
Clients must read the documentation supplied by the plugin implementor in order to know what functionality a given version of the plugin supports.
Member Type Documentation
enum PluginInfo::Status
flags PluginInfo::StatusFlags
The StatusFlags type is a typedef for QFlags<Status>. It stores an OR combination of Status values.
Property Documentation
displayName : const QString
Access functions:
| QString | displayName() const |
name : const QString
Access functions:
| QString | name() const |
statusFlags : const StatusFlags
Access functions:
| StatusFlags | statusFlags() const |
version : const int
Access functions:
| int | version() const |
Member Function Documentation
PluginInfo::PluginInfo(const QString &displayName = QString(), const QString &name = QString(), int version = 0, StatusFlags status = PluginInfo::Unknown)
Constructs a plugin info object containing the given name, version and status
PluginInfo::PluginInfo(const PluginInfo &other)
Constructs a copy of the other plugin info object
PluginInfo::~PluginInfo()
Destroys the plugin info object
QString PluginInfo::displayName() const
Returns the display name of the plugin
This is the user-friendly, human-readable name reported by the plugin and should already be translated.
Note: Getter function for property displayName.
QString PluginInfo::name() const
Returns the name of the plugin
This is a unique identifier for the plugin, and is not necessarily human-readable.
Note: Getter function for property name.
StatusFlags PluginInfo::statusFlags() const
Returns the status flags of the plugin
Note: Getter function for property statusFlags.
int PluginInfo::version() const
Returns the version of the plugin
Note: Getter function for property version.
PluginInfo &PluginInfo::operator=(const Sailfish::Secrets::PluginInfo &other)
Copy-assignment operator.