![]() |
![]() |
![]() |
libaccountsservice Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
#define ACT_USER_MANAGER_ERROR struct ActUserManager; enum ActUserManagerError; gboolean act_user_manager_activate_user_session (ActUserManager *manager
,ActUser *user
); ActUser * act_user_manager_cache_user (ActUserManager *manager
,const char *username
,GError **error
); void act_user_manager_cache_user_async (ActUserManager *manager
,const gchar *username
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); ActUser * act_user_manager_cache_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
); gboolean act_user_manager_can_switch (ActUserManager *manager
); ActUser * act_user_manager_create_user (ActUserManager *manager
,const char *username
,const char *fullname
,ActUserAccountType accounttype
,GError **error
); void act_user_manager_create_user_async (ActUserManager *manager
,const gchar *username
,const gchar *fullname
,ActUserAccountType accounttype
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); ActUser * act_user_manager_create_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
); gboolean act_user_manager_delete_user (ActUserManager *manager
,ActUser *user
,gboolean remove_files
,GError **error
); void act_user_manager_delete_user_async (ActUserManager *manager
,ActUser *user
,gboolean remove_files
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean act_user_manager_delete_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
); ActUserManager * act_user_manager_get_default (void
); ActUser * act_user_manager_get_user (ActUserManager *manager
,const char *username
); ActUser * act_user_manager_get_user_by_id (ActUserManager *manager
,uid_t id
); gboolean act_user_manager_goto_login_session (ActUserManager *manager
); GSList * act_user_manager_list_users (ActUserManager *manager
); gboolean act_user_manager_no_service (ActUserManager *manager
); gboolean act_user_manager_uncache_user (ActUserManager *manager
,const char *username
,GError **error
);
"exclude-usernames-list" gpointer : Read / Write "has-multiple-users" gboolean : Read "include-usernames-list" gpointer : Read / Write "is-loaded" gboolean : Read
"user-added" :Run Last
"user-changed" :Run Last
"user-is-logged-in-changed" :Run Last
"user-removed" :Run Last
ActUserManager is a manager object that gives access to user creation, deletion, enumeration, etc.
There is typically a singleton ActUserManager object, which
can be obtained by act_user_manager_get_default()
.
#define ACT_USER_MANAGER_ERROR act_user_manager_error_quark ()
The GError domain for ActUserManagerError errors
typedef enum { ACT_USER_MANAGER_ERROR_FAILED, ACT_USER_MANAGER_ERROR_USER_EXISTS, ACT_USER_MANAGER_ERROR_USER_DOES_NOT_EXIST, ACT_USER_MANAGER_ERROR_PERMISSION_DENIED, ACT_USER_MANAGER_ERROR_NOT_SUPPORTED } ActUserManagerError;
Various error codes returned by the accounts service.
gboolean act_user_manager_activate_user_session (ActUserManager *manager
,ActUser *user
);
Activate the session for a given user.
|
the user manager |
|
the user to activate |
Returns : |
whether successfully activated |
ActUser * act_user_manager_cache_user (ActUserManager *manager
,const char *username
,GError **error
);
Caches a user account so it shows up via act_user_manager_list_users()
.
|
a ActUserManager |
|
a user name |
|
a GError |
Returns : |
user object. [transfer full] |
void act_user_manager_cache_user_async (ActUserManager *manager
,const gchar *username
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously caches a user account so it shows up via
act_user_manager_list_users()
.
For more details, see act_user_manager_cache_user()
, which
is the synchronous version of this call.
|
a ActUserManager |
|
a unix user name |
|
optional GCancellable object,
NULL to ignore. [allow-none]
|
|
a GAsyncReadyCallback to call when the request is satisfied. [scope async] |
|
the data to pass to callback . [closure]
|
Since 0.6.27
ActUser * act_user_manager_cache_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
);
Finishes an asynchronous user caching.
See act_user_manager_cache_user_async()
.
|
a ActUserManager |
|
a GAsyncResult |
|
a GError |
Returns : |
user object. [transfer full] |
Since 0.6.27
gboolean act_user_manager_can_switch (ActUserManager *manager
);
Check whether the user can switch to another session.
|
the user manager |
Returns : |
whether we can switch to another session |
ActUser * act_user_manager_create_user (ActUserManager *manager
,const char *username
,const char *fullname
,ActUserAccountType accounttype
,GError **error
);
Creates a user account on the system.
|
a ActUserManager |
|
a unix user name |
|
a unix GECOS value |
|
a ActUserAccountType |
|
a GError |
Returns : |
user object. [transfer full] |
void act_user_manager_create_user_async (ActUserManager *manager
,const gchar *username
,const gchar *fullname
,ActUserAccountType accounttype
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously creates a user account on the system.
For more details, see act_user_manager_create_user()
, which
is the synchronous version of this call.
|
a ActUserManager |
|
a unix user name |
|
a unix GECOS value |
|
a ActUserAccountType |
|
optional GCancellable object,
NULL to ignore. [allow-none]
|
|
a GAsyncReadyCallback to call when the request is satisfied. [scope async] |
|
the data to pass to callback . [closure]
|
Since 0.6.27
ActUser * act_user_manager_create_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
);
Finishes an asynchronous user creation.
See act_user_manager_create_user_async()
.
|
a ActUserManager |
|
a GAsyncResult |
|
a GError |
Returns : |
user object. [transfer full] |
Since 0.6.27
gboolean act_user_manager_delete_user (ActUserManager *manager
,ActUser *user
,gboolean remove_files
,GError **error
);
Deletes a user account on the system.
|
a ActUserManager |
|
an ActUser object |
|
TRUE to delete the users home directory |
|
a GError |
Returns : |
TRUE if the user account was successfully deleted |
void act_user_manager_delete_user_async (ActUserManager *manager
,ActUser *user
,gboolean remove_files
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously deletes a user account from the system.
For more details, see act_user_manager_delete_user()
, which
is the synchronous version of this call.
|
a ActUserManager |
|
a ActUser object |
|
TRUE to delete the users home directory |
|
optional GCancellable object,
NULL to ignore. [allow-none]
|
|
a GAsyncReadyCallback to call when the request is satisfied. [scope async] |
|
the data to pass to callback . [closure]
|
Since 0.6.27
gboolean act_user_manager_delete_user_finish (ActUserManager *manager
,GAsyncResult *result
,GError **error
);
Finishes an asynchronous user account deletion.
See act_user_manager_delete_user_async()
.
|
a ActUserManager |
|
a GAsyncResult |
|
a GError |
Returns : |
TRUE if the user account was successfully deleted |
Since 0.6.27
ActUserManager * act_user_manager_get_default (void
);
Returns the user manager singleton instance. Calling this function will
automatically being loading the user list if it isn't loaded already.
The "is-loaded" property will be set to TRUE
when the users
are finished loading and then act_user_manager_list_users()
can be called.
Returns : |
user manager object. [transfer none] |
ActUser * act_user_manager_get_user (ActUserManager *manager
,const char *username
);
Retrieves a pointer to the ActUser object for the login username
from manager
. Trying to use this object before its
"is-loaded" property is TRUE
will result in undefined
behavior.
|
the manager to query. |
|
the login name of the user to get. |
Returns : |
ActUser object. [transfer none] |
ActUser * act_user_manager_get_user_by_id (ActUserManager *manager
,uid_t id
);
Retrieves a pointer to the ActUser object for the user with the
given uid from manager
. Trying to use this object before its
"is-loaded" property is TRUE
will result in undefined
behavior.
|
the manager to query. |
|
the uid of the user to get. |
Returns : |
ActUser object. [transfer none] |
gboolean act_user_manager_goto_login_session (ActUserManager *manager
);
Switch the display to the login manager.
|
the user manager |
Returns : |
whether successful or not |
GSList * act_user_manager_list_users (ActUserManager *manager
);
Get a list of system user accounts
|
a ActUserManager |
Returns : |
List of ActUser objects. [element-type ActUser][transfer container] |
gboolean act_user_manager_no_service (ActUserManager *manager
);
Check whether or not the accounts service is running.
|
a ActUserManager |
Returns : |
whether or not accounts service is running |
gboolean act_user_manager_uncache_user (ActUserManager *manager
,const char *username
,GError **error
);
Releases all metadata about a user account, including icon,
language and session. If the user account is from a remote
server and the user has never logged in before, then that
account will no longer show up in ListCachedUsers()
output.
|
a ActUserManager |
|
a user name |
|
a GError |
Returns : |
TRUE if successful, otherwise FALSE
|
"exclude-usernames-list"
property "exclude-usernames-list" gpointer : Read / Write
Usernames who are specifically excluded.
"has-multiple-users"
property "has-multiple-users" gboolean : Read
Whether more than one normal user is present.
Default value: FALSE
"include-usernames-list"
property "include-usernames-list" gpointer : Read / Write
Usernames who are specifically included.
"user-added"
signalvoid user_function (ActUserManager *arg0,
ActUser *arg1,
gpointer user_data) : Run Last
Emitted when a user is added to the user manager.
|
user data set when the signal handler was connected. |
"user-changed"
signalvoid user_function (ActUserManager *arg0,
ActUser *arg1,
gpointer user_data) : Run Last
One of the users has changed
|
user data set when the signal handler was connected. |
"user-is-logged-in-changed"
signalvoid user_function (ActUserManager *arg0,
ActUser *arg1,
gpointer user_data) : Run Last
One of the users has logged in or out.
|
user data set when the signal handler was connected. |
"user-removed"
signalvoid user_function (ActUserManager *arg0,
ActUser *arg1,
gpointer user_data) : Run Last
Emitted when a user is removed from the user manager.
|
user data set when the signal handler was connected. |