API Documentation
Documentation for developing SailfishOS applications<sailfishusermanagerinterface.h> - Sailfish User Manager interface definitions
Contains defines, structs and serializing operators to use with SailfishUserManager D-Bus interface. More...
Classes
| class | SailfishUserManagerEntry |
Functions
| QDBusArgument & | operator<<(QDBusArgument &argument, const SailfishUserManagerEntry &user) |
| const QDBusArgument & | operator>>(const QDBusArgument &argument, SailfishUserManagerEntry &user) |
Constants
This header has defines for several constants.
| Constant | Description |
|---|---|
SAILFISH_USERMANAGER_DBUS_INTERFACE | D-Bus interface of SailfishUserManager. |
SAILFISH_USERMANAGER_DBUS_OBJECT_PATH | D-Bus path of SailfishUserManager. |
SAILFISH_USERMANAGER_GUEST_HOME | Home directory path of guest user. |
SAILFISH_USERMANAGER_GUEST_UID | UID of guest user. |
SAILFISH_USERMANAGER_MAX_USERS | Maximum number of users that can be created. Does not include guest user but includes device owner. |
D-Bus errors
This header has defines for D-Bus error names that SailfishUserManager may return over D-Bus. Note that this does not include all possible errors that can be returned as they may be generic errors from QDBusError::ErrorType as well.
| Constant | Description |
|---|---|
SailfishUserManagerErrorBusy | The service may not perform the action right now. You may try again later. This may happen if the action is already taking place or if user is currently for example making a call. |
SailfishUserManagerErrorHomeCreateFailed | The service could not create home directory for the user. This may happen if the directory path is already reserved. |
SailfishUserManagerErrorMaxUsersReached | Maximum user count has been already reached and no more users can be created. You may create another user after removing an already existing user. |
SailfishUserManagerErrorUserAddFailed | Creating user failed for some reason. |
SailfishUserManagerErrorUserModifyFailed | User could not be added to user groups or changing user's name failed. |
SailfishUserManagerErrorUserRemoveFailed | Removing user failed for some reason. |
SailfishUserManagerErrorGetUidFailed | Could not determine active user on seat0. |
SailfishUserManagerErrorGetUuidFailed | Could not read UUID for the user. |
SailfishUserManagerErrorUserNotFound | User with given UID does not exist. |
SailfishUserManagerErrorAddToGroupFailed | User could not be added to one or more supplementary groups. |
SailfishUserManagerErrorRemoveFromGroupFailed | User could not be removed from one or more supplementary groups. |
Classes
class SailfishUserManagerEntry
The SailfishUserManagerEntry struct describes a user on device.
This struct is used by SailfishUserManager::users to send username, real name and UID (User IDentifier) over D-Bus.
Function Documentation
QDBusArgument &operator<<(QDBusArgument &argument, const SailfishUserManagerEntry &user)
Operator to serialize user into argument.
Returns reference to argument.
const QDBusArgument &operator>>(const QDBusArgument &argument, SailfishUserManagerEntry &user)
Operator to deserialize user from argument.
Returns reference to argument.