LightDM.UserList¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`get_instance` ()
	`get_length` ()
	`get_user_by_name` (username)
	`get_users` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_user_added` (user)
	`do_user_changed` (user)
	`do_user_removed` (user)

Properties¶

Name	Type	Flags	Short Description
`length`	`int`	r	Number of login users
`num-users`	`int`	d/r	Number of login users `deprecated`

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`user-added`	The `::user-added` signal gets emitted when a user account is created.
`user-changed`	The `::user-changed` signal gets emitted when a user account is modified.
`user-removed`	The `::user-removed` signal gets emitted when a user account is removed.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class LightDM.UserList(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: LightDM.UserListClass

LightDM.UserList is an opaque data structure and can only be accessed using the provided functions.

classmethod get_instance()¶

Returns:: the LightDM.UserList
Return type:: LightDM.UserList

Get the user list.

get_length()¶

Returns:: The number of users able to log in
Return type:: int

get_user_by_name(username)¶

Parameters:: username (str) – Name of user to get.
Returns:: A LightDM.User entry for the given user.
Return type:: LightDM.User

Get information about a given user or None if this user doesn’t exist.

get_users()¶

Returns:: A list of LightDM.User that should be presented to the user.
Return type:: [LightDM.User]

Get a list of users to present to the user. This list may be a subset of the available users and may be empty depending on the server configuration.

do_user_added(user) virtual¶

Parameters:: user (LightDM.User) –

do_user_changed(user) virtual¶

Parameters:: user (LightDM.User) –

do_user_removed(user) virtual¶

Parameters:: user (LightDM.User) –

Signal Details¶

LightDM.UserList.signals.user_added(user_list, user)¶

Signal Name:

user-added

Flags:

RUN_LAST

Parameters:

user_list (LightDM.UserList) – The object which received the signal
user (LightDM.User) – The LightDM.User that has been added.

The ::user-added signal gets emitted when a user account is created.

LightDM.UserList.signals.user_changed(user_list, user)¶

Signal Name:

user-changed

Flags:

RUN_LAST

Parameters:

user_list (LightDM.UserList) – The object which received the signal
user (LightDM.User) – The LightDM.User that has been changed.

The ::user-changed signal gets emitted when a user account is modified.

LightDM.UserList.signals.user_removed(user_list, user)¶

Signal Name:

user-removed

Flags:

RUN_LAST

Parameters:

user_list (LightDM.UserList) – The object which received the signal
user (LightDM.User) – The LightDM.User that has been removed.

The ::user-removed signal gets emitted when a user account is removed.

Property Details¶

LightDM.UserList.props.length¶

Name:: length
Type:: int
Default Value:: 0
Flags:: READABLE

Number of login users

LightDM.UserList.props.num_users¶

Name:: num-users
Type:: int
Default Value:: 0
Flags:: DEPRECATED, READABLE

Number of login users

Deprecated since version ???.