ActUserManager: libaccountsservice Reference Manual

ActUserManager

ActUserManager — manages ActUser objects

Functions

gboolean	act_user_manager_activate_user_session ()
ActUser *	act_user_manager_cache_user ()
void	act_user_manager_cache_user_async ()
ActUser *	act_user_manager_cache_user_finish ()
gboolean	act_user_manager_can_switch ()
ActUser *	act_user_manager_create_user ()
void	act_user_manager_create_user_async ()
ActUser *	act_user_manager_create_user_finish ()
gboolean	act_user_manager_delete_user ()
void	act_user_manager_delete_user_async ()
gboolean	act_user_manager_delete_user_finish ()
ActUserManager *	act_user_manager_get_default ()
ActUser *	act_user_manager_get_user ()
ActUser *	act_user_manager_get_user_by_id ()
gboolean	act_user_manager_goto_login_session ()
GSList *	act_user_manager_list_users ()
gboolean	act_user_manager_no_service ()
gboolean	act_user_manager_uncache_user ()
void	act_user_manager_uncache_user_async ()
gboolean	act_user_manager_uncache_user_finish ()

Properties

gpointer	exclude-usernames-list	Read / Write
gboolean	has-multiple-users	Read / Write
gpointer	include-usernames-list	Read / Write
gboolean	is-loaded	Read

Signals

void	user-added	Run Last
void	user-changed	Run Last
void	user-is-logged-in-changed	Run Last
void	user-removed	Run Last

Types and Values

#define	ACT_USER_MANAGER_ERROR
struct	ActUserManager
enum	ActUserManagerError

Object Hierarchy

    GObject
    ╰── ActUserManager

Description

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().

Functions

act_user_manager_activate_user_session ()

gboolean
act_user_manager_activate_user_session
                               (ActUserManager *manager,
                                ActUser *user);

Activate the session for a given user.

Parameters

manager	the user manager
user	the user to activate

Returns

whether successfully activated

act_user_manager_cache_user ()

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().

Parameters

manager	a ActUserManager
username	a user name
error	a GError

Returns

user object.

[transfer full]

act_user_manager_cache_user_async ()

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.

Parameters

manager	a ActUserManager
username	a unix user name
cancellable	optional GCancellable object, `NULL` to ignore.	[allow-none]
callback	a GAsyncReadyCallback to call when the request is satisfied.	[scope async]
user_data	the data to pass to `callback` .	[closure]

Since: 0.6.27

act_user_manager_cache_user_finish ()

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().

Parameters

manager	a ActUserManager
result	a GAsyncResult
error	a GError

Returns

user object.

[transfer full]

Since: 0.6.27

act_user_manager_can_switch ()

gboolean
act_user_manager_can_switch (ActUserManager *manager);

Check whether the user can switch to another session.

Parameters

manager

the user manager

Returns

whether we can switch to another session

act_user_manager_create_user ()

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.

Parameters

manager	a ActUserManager
username	a unix user name
fullname	a unix GECOS value
accounttype	a ActUserAccountType
error	a GError

Returns

user object.

[transfer full]

act_user_manager_create_user_async ()

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.

Parameters

manager	a ActUserManager
username	a unix user name
fullname	a unix GECOS value
accounttype	a ActUserAccountType
cancellable	optional GCancellable object, `NULL` to ignore.	[allow-none]
callback	a GAsyncReadyCallback to call when the request is satisfied.	[scope async]
user_data	the data to pass to `callback` .	[closure]

Since: 0.6.27

act_user_manager_create_user_finish ()

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().

Parameters

manager	a ActUserManager
result	a GAsyncResult
error	a GError

Returns

user object.

[transfer full]

Since: 0.6.27

act_user_manager_delete_user ()

gboolean
act_user_manager_delete_user (ActUserManager *manager,
                              ActUser *user,
                              gboolean remove_files,
                              GError **error);

Deletes a user account on the system.

Parameters

manager	a ActUserManager
user	an ActUser object
remove_files	`TRUE` to delete the users home directory
error	a GError

Returns

TRUE if the user account was successfully deleted

act_user_manager_delete_user_async ()

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.

Parameters

manager	a ActUserManager
user	a ActUser object
remove_files	`TRUE` to delete the users home directory
cancellable	optional GCancellable object, `NULL` to ignore.	[allow-none]
callback	a GAsyncReadyCallback to call when the request is satisfied.	[scope async]
user_data	the data to pass to `callback` .	[closure]

Since: 0.6.27

act_user_manager_delete_user_finish ()

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().

Parameters

manager	a ActUserManager
result	a GAsyncResult
error	a GError

Returns

TRUE if the user account was successfully deleted

Since: 0.6.27

act_user_manager_get_default ()

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]

act_user_manager_get_user ()

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.

Parameters

manager	the manager to query.
username	the login name of the user to get.

Returns

ActUser object.

[transfer none]

act_user_manager_get_user_by_id ()

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.

Parameters

manager	the manager to query.
id	the uid of the user to get.

Returns

ActUser object.

[transfer none]

act_user_manager_goto_login_session ()

gboolean
act_user_manager_goto_login_session (ActUserManager *manager);

Switch the display to the login manager.

Parameters

manager

the user manager

Returns

whether successful or not

act_user_manager_list_users ()

GSList *
act_user_manager_list_users (ActUserManager *manager);

Get a list of system user accounts

Parameters

manager

a ActUserManager

Returns

List of ActUser objects.

[element-type ActUser][transfer container]

act_user_manager_no_service ()

gboolean
act_user_manager_no_service (ActUserManager *manager);

Check whether or not the accounts service is running.

Parameters

manager

a ActUserManager

Returns

whether or not accounts service is running

act_user_manager_uncache_user ()

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.

Parameters

manager	a ActUserManager
username	a user name
error	a GError

Returns

TRUE if successful, otherwise FALSE

act_user_manager_uncache_user_async ()

void
act_user_manager_uncache_user_async (ActUserManager *manager,
                                     const gchar *username,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data);

act_user_manager_uncache_user_finish ()

gboolean
act_user_manager_uncache_user_finish (ActUserManager *manager,
                                      GAsyncResult *result,
                                      GError **error);

Finishes an asynchronous user uncaching.

See act_user_manager_uncache_user_async().

Parameters

manager	a ActUserManager
result	a GAsyncResult
error	a GError

Returns

TRUE if the user account was successfully uncached

Since: 0.6.39

Types and Values

ACT_USER_MANAGER_ERROR

#define ACT_USER_MANAGER_ERROR act_user_manager_error_quark ()

The GError domain for ActUserManagerError errors

struct ActUserManager

struct ActUserManager;

A user manager object.

enum ActUserManagerError

Various error codes returned by the accounts service.

Members

ACT_USER_MANAGER_ERROR_FAILED	Generic failure
ACT_USER_MANAGER_ERROR_USER_EXISTS	The user already exists
ACT_USER_MANAGER_ERROR_USER_DOES_NOT_EXIST	The user does not exist
ACT_USER_MANAGER_ERROR_PERMISSION_DENIED	Permission denied
ACT_USER_MANAGER_ERROR_NOT_SUPPORTED	Operation not supported

Property Details

The `“exclude-usernames-list”` property

  “exclude-usernames-list”   gpointer

Usernames who are specifically excluded.

Owner: ActUserManager

Flags: Read / Write

The `“has-multiple-users”` property

  “has-multiple-users”       gboolean

Whether more than one normal user is present.

Owner: ActUserManager

Flags: Read / Write

Default value: FALSE

The `“include-usernames-list”` property

  “include-usernames-list”   gpointer

Usernames who are specifically included.

Owner: ActUserManager

Flags: Read / Write

The `“is-loaded”` property

  “is-loaded”                gboolean

Determines whether or not the manager object is loaded and ready to read from.

Owner: ActUserManager

Flags: Read

Default value: FALSE

Signal Details

The `“user-added”` signal

void
user_function (ActUserManager *gobject,
               ActUser        *user,
               gpointer        user_data)

Emitted when a user is added to the user manager.

Parameters

gobject	the object which received the signal
user	the ActUser that was added
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“user-changed”` signal

void
user_function (ActUserManager *gobject,
               ActUser        *user,
               gpointer        user_data)

One of the users has changed

Parameters

gobject	the object which received the signal
user	the ActUser that changed
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“user-is-logged-in-changed”` signal

void
user_function (ActUserManager *gobject,
               ActUser        *user,
               gpointer        user_data)

One of the users has logged in or out.

Parameters

gobject	the object which received the signal
user	the ActUser that changed login status
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“user-removed”` signal

void
user_function (ActUserManager *gobject,
               ActUser        *user,
               gpointer        user_data)

Emitted when a user is removed from the user manager.

Parameters

gobject	the object which received the signal
user	the ActUser that was removed
user_data	user data set when the signal handler was connected.

Flags: Run Last

ActUserManager

Functions

Properties

Signals

Types and Values

Object Hierarchy

Description

Functions

act_user_manager_activate_user_session ()

Parameters

Returns

act_user_manager_cache_user ()

Parameters

Returns

act_user_manager_cache_user_async ()

Parameters

act_user_manager_cache_user_finish ()

Parameters

Returns

act_user_manager_can_switch ()

Parameters

Returns

act_user_manager_create_user ()

Parameters

Returns

act_user_manager_create_user_async ()

Parameters

act_user_manager_create_user_finish ()

Parameters

Returns

act_user_manager_delete_user ()

Parameters

Returns

act_user_manager_delete_user_async ()

Parameters

act_user_manager_delete_user_finish ()

Parameters

Returns

act_user_manager_get_default ()

Returns

act_user_manager_get_user ()

Parameters

Returns

act_user_manager_get_user_by_id ()

Parameters

Returns

act_user_manager_goto_login_session ()

Parameters

Returns

act_user_manager_list_users ()

Parameters

Returns

act_user_manager_no_service ()

Parameters

Returns

act_user_manager_uncache_user ()

Parameters

Returns

act_user_manager_uncache_user_async ()

act_user_manager_uncache_user_finish ()

Parameters

Returns

Types and Values

ACT_USER_MANAGER_ERROR

struct ActUserManager

enum ActUserManagerError

Members

Property Details

The “exclude-usernames-list” property

The “has-multiple-users” property

The “include-usernames-list” property

The “is-loaded” property

Signal Details

The “user-added” signal

Parameters

The “user-changed” signal

Parameters

The “user-is-logged-in-changed” signal

Parameters

The “user-removed” signal

The `“exclude-usernames-list”` property

The `“has-multiple-users”` property

The `“include-usernames-list”` property

The `“is-loaded”` property

The `“user-added”` signal

The `“user-changed”` signal

The `“user-is-logged-in-changed”` signal

The `“user-removed”` signal