#LightDMGreeter is an opaque data structure and can only be accessed
using the provided functions.
Create a new greeter.
the new #LightDMGreeter
Starts the authentication procedure for a user.
#TRUE if authentication request sent.
A #LightDMGreeter
A username or #NULL to prompt for a username.
Starts the authentication procedure for the guest user.
#TRUE if authentication request sent.
A #LightDMGreeter
Starts the authentication procedure for the automatic login user.
#TRUE if authentication request sent.
A #LightDMGreeter
Start authentication for a remote session type.
#TRUE if authentication request sent.
A #LightDMGreeter
The name of a remote session
A username of #NULL to prompt for a username.
Cancel the current user authentication.
#TRUE if cancel request sent.
A #LightDMGreeter
Cancel the automatic login.
A #LightDMGreeter
Connects the greeter to the display manager. Will block until connected.
Use lightdm_greeter_connect_to_daemon_sync() instead
#TRUE if successfully connected
The greeter to connect
Asynchronously connects the greeter to the display manager.
When the operation is finished, @callback will be invoked. You can then call lightdm_greeter_connect_to_daemon_finish() to get the result of the operation.
See lightdm_greeter_connect_to_daemon_sync() for the synchronous version.
The greeter to connect
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when completed or %NULL.
data to pass to the @callback or %NULL.
Finishes an operation started with lightdm_greeter_connect_to_daemon().
#TRUE if successfully connected
The greeter the the request was done with
A #GAsyncResult.
Connects the greeter to the display manager. Will block until connected.
#TRUE if successfully connected
The greeter to connect
Ensure that a shared data dir for the given user is available. Both the
greeter user and @username will have write access to that folder. The
intention is that larger pieces of shared data would be stored there (files
that the greeter creates but wants to give to a user -- like camera
photos -- or files that the user creates but wants the greeter to
see -- like contact avatars).
LightDM will automatically create these if the user actually logs in, so
greeters only need to call this method if they want to store something in
the directory themselves.
A #LightDMGreeter
A username
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when completed or %NULL.
data to pass to the @callback or %NULL.
Function to call from lightdm_greeter_ensure_shared_data_dir callback.
The path to the shared directory, free with g_free.
A #LightDMGreeter
A #GAsyncResult.
Ensure that a shared data dir for the given user is available. Both the
greeter user and @username will have write access to that folder. The
intention is that larger pieces of shared data would be stored there (files
that the greeter creates but wants to give to a user -- like camera
photos -- or files that the user creates but wants the greeter to
see -- like contact avatars).
LightDM will automatically create these if the user actually logs in, so
greeters only need to call this method if they want to store something in
the directory themselves.
The path to the shared directory, free with g_free.
A #LightDMGreeter
A username
Get the user that is being authenticated.
The username of the authentication user being authenticated or #NULL if no authentication in progress.
A #LightDMGreeter
Check if the guest account should be automatically logged into when the timer expires.
#TRUE if the guest account should be automatically logged into.
A #LightDMGreeter
Get the session used to automatically log into when the timer expires.
The session name or %NULL if configured to use the default.
A #LightDMGreeter
Get the number of seconds to wait before automatically logging in.
The number of seconds to wait before automatically logging in or 0 for no timeout.
A #LightDMGreeter
Get the user account to automatically log into when the timer expires.
The user account to automatically log into or %NULL if none configured.
A #LightDMGreeter
Get the default session to use.
The session name
A #LightDMGreeter
Check if guest sessions are supported.
#TRUE if guest sessions are supported.
A #LightDMGreeter
Check if user accounts should be shown. If this is TRUE then the list of
accounts should be taken from #LightDMUserList and displayed in the greeter
for the user to choose from. Note that this list can be empty and it is
recommended you show a method for the user to enter a username manually.
If this option is shown the greeter should only allow these users to be
chosen for login unless the manual login hint is set.
#TRUE if the available users should not be shown.
A #LightDMGreeter
Get a hint.
The value for this hint or #NULL if not set.
A #LightDMGreeter
The hint name to query.
Checks if the greeter is in the process of authenticating.
#TRUE if the greeter is authenticating a user.
A #LightDMGreeter
Checks if the greeter has successfully authenticated.
#TRUE if the greeter is authenticated for login.
A #LightDMGreeter
Check if the greeter is acting as a lock screen.
#TRUE if the greeter was triggered by locking the seat.
A #LightDMGreeter
Check if the guest account should be selected by default.
#TRUE if the guest account should be selected by default.
A #LightDMGreeter
Get the user to select by default.
A username or %NULL if no particular user should be selected.
A #LightDMGreeter
Check if a manual login option should be shown. If set the GUI
should provide a way for a username to be entered manually.
Without this hint a greeter which is showing a user list can
limit logins to only those users.
#TRUE if a manual login option should be shown.
A #LightDMGreeter
Check if a remote login option should be shown. If set the GUI
should provide a way for a user to log into a remote desktop server.
#TRUE if a remote login option should be shown.
A #LightDMGreeter
Provide response to a prompt. May be one in a series.
#TRUE if response sent.
A #LightDMGreeter
Response to a prompt
Set the language for the currently authenticated user.
#TRUE if set language request sent.
A #LightDMGreeter
The language to use for this user in the form of a locale specification (e.g. "de_DE.UTF-8").
Set whether the greeter will be reset instead of killed after the user logs in.
This must be called before lightdm_greeter_connect is called.
A #LightDMGreeter
Whether the greeter wants to be reset instead of killed after the user logs in
Asynchronously start a session for the authenticated user.
When the operation is finished, @callback will be invoked. You can then call lightdm_greeter_start_session_finish() to get the result of the operation.
See lightdm_greeter_start_session_sync() for the synchronous version.
A #LightDMGreeter
The session to log into or #NULL to use the default.
A #GCancellable or %NULL.
A #GAsyncReadyCallback to call when completed or %NULL.
data to pass to the @callback or %NULL.
Start a session for the authenticated user.
TRUE if the session was started.
A #LightDMGreeter
A #GAsyncResult.
Start a session for the authenticated user.
TRUE if the session was started.
A #LightDMGreeter
The session to log into or #NULL to use the default.
The ::authentication-complete signal gets emitted when the greeter
has completed authentication.
Call lightdm_greeter_get_is_authenticated() to check if the authentication
was successful.
The ::timed-login signal gets emitted when the automatic login timer has expired.
The application should then call lightdm_greeter_authenticate_autologin().
The ::idle signal gets emitted when the user has logged in and the
greeter is no longer needed.
This signal only matters if the greeter has marked itself as
resettable using lightdm_greeter_set_resettable().
The ::reset signal gets emitted when the user is returning to a greeter
that was previously marked idle.
This signal only matters if the greeter has marked itself as
resettable using lightdm_greeter_set_resettable().
The ::show-message signal gets emitted when the greeter
should show a message to the user.
Message text
Message type
The ::show-prompt signal gets emitted when the greeter should show a
prompt to the user. The given text should be displayed and an input
field for the user to provide a response.
Call lightdm_greeter_respond() with the resultant input or
lightdm_greeter_cancel_authentication() to abort the authentication.
Prompt text
Prompt type
Class structure for #LightDMGreeter.
Error codes returned by greeter operations.
error communicating with daemon.
failed to connect to the daemon.
requested session failed to start.
autologin not configured.
autologin not configured.
#LightDMLanguage is an opaque data structure and can only be accessed
using the provided functions.
Get the code of a language (e.g. "de_DE.UTF-8")
The code of the language
A #LightDMLanguage
Get the name of a language.
The name of the language
A #LightDMLanguage
Get the territory the language is used in.
The territory the language is used in.
A #LightDMLanguage
Check if a language code matches this language.
#TRUE if the code matches this language.
A #LightDMLanguage
A language code
Class structure for #LightDMLanguage.
#LightDMLayout is an opaque data structure and can only be accessed
using the provided functions.
Get the long description of a layout.
A long description of the layout
A #LightDMLayout
Get the name of a layout.
The name of the layout
A #LightDMLayout
Get the short description of a layout.
A short description of the layout
A #LightDMLayout
Class structure for #LightDMLayout.
Informational message.
Error message.
Prompt types the client is required to display.
prompt is a question. The information can be shown as it is entered.
prompt is for secret information. The entered information should be obscured so it can't be publically visible.
#LightDMSession is an opaque data structure and can only be accessed
using the provided functions.
Get the comment for a session
The session comment
A #LightDMSession
Get the key for a session
The session key
A #LightDMSession
Get the name for a session
The session name
A #LightDMSession
Get the type a session
The session type, e.g. x or mir
A #LightDMSession
Class structure for #LightDMSession.
#LightDMUser is an opaque data structure and can only be accessed
using the provided functions.
Get the background file path for a user.
The background file path for the given user or #NULL if no path
A #LightDMUser
Get the display name of a user.
The display name of the given user
A #LightDMUser
Check if a user has waiting messages.
#TRUE if the user has waiting messages.
A #LightDMUser
Get the home directory for a user.
The users home directory
A #LightDMUser
Get the image URI for a user.
The image URI for the given user or #NULL if no URI
A #LightDMUser
Get if the user is locked.
%TRUE if the user is locked
A #LightDMUser
Get the language for a user.
The language in the form of a local specification (e.g. "de_DE.UTF-8") for the given user or #NULL if using the system default locale.
A #LightDMUser
Get the keyboard layout for a user.
The keyboard layout for the given user or #NULL if using system defaults. Copy the value if you want to use it long term.
A #LightDMUser
Get the configured keyboard layouts for a user.
A NULL-terminated array of keyboard layouts for the given user. Copy the values if you want to use them long term.
A #LightDMUser
Check if a user is logged in.
#TRUE if the user is currently logged in.
A #LightDMUser
Get the name of a user.
The name of the given user
A #LightDMUser
Get the real name of a user.
The real name of the given user
A #LightDMUser
Get the session for a user.
The session for the given user or #NULL if using system defaults.
A #LightDMUser
Get the uid of a user.
The uid of the given user
A #LightDMUser
The ::changed signal gets emitted this user account is modified.
Class structure for #LightDMUser.
#LightDMUserList is an opaque data structure and can only be accessed
using the provided functions.
Get the user list.
the #LightDMUserList
The number of users able to log in
a #LightDMUserList
Get information about a given user or #NULL if this user doesn't exist.
A #LightDMUser entry for the given user.
A #LightDMUserList
Name of user to get.
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.
A list of #LightDMUser that should be presented to the user.
A #LightDMUserList
The ::user-added signal gets emitted when a user account is created.
The #LightDMUser that has been added.
The ::user-changed signal gets emitted when a user account is modified.
The #LightDMUser that has been changed.
The ::user-removed signal gets emitted when a user account is removed.
The #LightDMUser that has been removed.
Class structure for #LightDMUserList.
Checks if is authorized to do a system hibernate.
#TRUE if can hibernate the system
Checks if is authorized to do a system restart.
#TRUE if can restart the system
Checks if is authorized to do a system shutdown.
#TRUE if can shutdown the system
Checks if authorized to do a system suspend.
#TRUE if can suspend the system
The name of the host we are running on.
Get the current language.
The current language or #NULL if no language.
Get a list of languages to present to the user.
A list of #LightDMLanguage that should be presented to the user.
Get the current keyboard layout.
The currently active layout for this user.
Get a list of keyboard layouts to present to the user.
A list of #LightDMLayout that should be presented to the user.
Get a system message that should be presented to the user.
e.g. "Welcome to Yoyodyne"
a string (the contents of /etc/motd) or %NULL if not set.
Get a word describing the OS, suitable for checking which OS the greeter is running on.
e.g. "ubuntu"
a string (ID variable from /etc/os-release) or %NULL if not set.
Get a line of text describing the OS without version information, suitable for presentation to the user.
e.g. "Ubuntu"
a string (NAME variable from /etc/os-release) or %NULL if not set.
Get a line of text describing the OS, suitable for presentation to the user.
e.g. "Ubuntu 16.04.1 LTS"
a string (PRETTY_NAME variable from /etc/os-release) or %NULL if not set.
Get a line of text describing the OS version, suitable for presentation to the user.
e.g. "16.04.1 LTS (Xenial Xapus)"
a string (VERSION variable from /etc/os-release) or %NULL if not set.
Get a word descibing the OS version, suitable for checking which version of the OS this greeter is running on.
e.g. "16.04"
a string (VERSION_ID variable from /etc/os-release) or %NULL if not set.
Get the available remote sessions.
A list of #LightDMSession
Get the available sessions.
A list of #LightDMSession
Triggers a system hibernate.
#TRUE if hibernate initiated.
Triggers a system restart.
#TRUE if restart initiated.
Set the layout for this session.
The layout to use
Triggers a system shutdown.
#TRUE if shutdown initiated.
Triggers a system suspend.
#TRUE if suspend initiated.