lightdm_greeter_error_quark ()

GQuark
lightdm_greeter_error_quark (void);

lightdm_greeter_new ()

LightDMGreeter *
lightdm_greeter_new (void);

Create a new greeter.

lightdm_greeter_set_resettable ()

void
lightdm_greeter_set_resettable (LightDMGreeter *greeter,
                                gboolean resettable);

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.

lightdm_greeter_connect_to_daemon ()

void
lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter,
                                   GCancellable *cancellable,
                                   GAsyncReadyCallback callback,
                                   gpointer user_data);

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.

lightdm_greeter_connect_to_daemon_finish ()

gboolean
lightdm_greeter_connect_to_daemon_finish
                               (LightDMGreeter *greeter,
                                GAsyncResult *result,
                                GError **error);

Finishes an operation started with lightdm_greeter_connect_to_daemon().

lightdm_greeter_connect_to_daemon_sync ()

gboolean
lightdm_greeter_connect_to_daemon_sync
                               (LightDMGreeter *greeter,
                                GError **error);

Connects the greeter to the display manager. Will block until connected.

lightdm_greeter_get_hint ()

const gchar *
lightdm_greeter_get_hint (LightDMGreeter *greeter,
                          const gchar *name);

Get a hint.

lightdm_greeter_get_default_session_hint ()

const gchar *
lightdm_greeter_get_default_session_hint
                               (LightDMGreeter *greeter);

Get the default session to use.

lightdm_greeter_get_hide_users_hint ()

gboolean
lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);

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.

lightdm_greeter_get_show_manual_login_hint ()

gboolean
lightdm_greeter_get_show_manual_login_hint
                               (LightDMGreeter *greeter);

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.

lightdm_greeter_get_show_remote_login_hint ()

gboolean
lightdm_greeter_get_show_remote_login_hint
                               (LightDMGreeter *greeter);

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.

lightdm_greeter_get_lock_hint ()

gboolean
lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);

Check if the greeter is acting as a lock screen.

lightdm_greeter_get_has_guest_account_hint ()

gboolean
lightdm_greeter_get_has_guest_account_hint
                               (LightDMGreeter *greeter);

Check if guest sessions are supported.

lightdm_greeter_get_select_user_hint ()

const gchar *
lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);

Get the user to select by default.

lightdm_greeter_get_select_guest_hint ()

gboolean
lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);

Check if the guest account should be selected by default.

lightdm_greeter_get_autologin_user_hint ()

const gchar *
lightdm_greeter_get_autologin_user_hint
                               (LightDMGreeter *greeter);

Get the user account to automatically log into when the timer expires.

lightdm_greeter_get_autologin_guest_hint ()

gboolean
lightdm_greeter_get_autologin_guest_hint
                               (LightDMGreeter *greeter);

Check if the guest account should be automatically logged into when the timer expires.

lightdm_greeter_get_autologin_timeout_hint ()

gint
lightdm_greeter_get_autologin_timeout_hint
                               (LightDMGreeter *greeter);

Get the number of seconds to wait before automaitcally logging in.

lightdm_greeter_cancel_autologin ()

void
lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);

Cancel the automatic login.

lightdm_greeter_authenticate ()

gboolean
lightdm_greeter_authenticate (LightDMGreeter *greeter,
                              const gchar *username,
                              GError **error);

Starts the authentication procedure for a user.

lightdm_greeter_authenticate_as_guest ()

gboolean
lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter,
                                       GError **error);

Starts the authentication procedure for the guest user.

lightdm_greeter_authenticate_autologin ()

gboolean
lightdm_greeter_authenticate_autologin
                               (LightDMGreeter *greeter,
                                GError **error);

Starts the authentication procedure for the automatic login user.

lightdm_greeter_authenticate_remote ()

gboolean
lightdm_greeter_authenticate_remote (LightDMGreeter *greeter,
                                     const gchar *session,
                                     const gchar *username,
                                     GError **error);

Start authentication for a remote session type.

lightdm_greeter_respond ()

gboolean
lightdm_greeter_respond (LightDMGreeter *greeter,
                         const gchar *response,
                         GError **error);

Provide response to a prompt. May be one in a series.

lightdm_greeter_cancel_authentication ()

gboolean
lightdm_greeter_cancel_authentication (LightDMGreeter *greeter,
                                       GError **error);

Cancel the current user authentication.

lightdm_greeter_get_in_authentication ()

gboolean
lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);

Checks if the greeter is in the process of authenticating.

lightdm_greeter_get_is_authenticated ()

gboolean
lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);

Checks if the greeter has successfully authenticated.

lightdm_greeter_get_authentication_user ()

const gchar *
lightdm_greeter_get_authentication_user
                               (LightDMGreeter *greeter);

Get the user that is being authenticated.

lightdm_greeter_set_language ()

gboolean
lightdm_greeter_set_language (LightDMGreeter *greeter,
                              const gchar *language,
                              GError **error);

Set the language for the currently authenticated user.

lightdm_greeter_start_session ()

void
lightdm_greeter_start_session (LightDMGreeter *greeter,
                               const gchar *session,
                               GCancellable *cancellable,
                               GAsyncReadyCallback callback,
                               gpointer user_data);

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.

lightdm_greeter_start_session_finish ()

gboolean
lightdm_greeter_start_session_finish (LightDMGreeter *greeter,
                                      GAsyncResult *result,
                                      GError **error);

Start a session for the authenticated user.

lightdm_greeter_start_session_sync ()

gboolean
lightdm_greeter_start_session_sync (LightDMGreeter *greeter,
                                    const gchar *session,
                                    GError **error);

Start a session for the authenticated user.

lightdm_greeter_ensure_shared_data_dir ()

void
lightdm_greeter_ensure_shared_data_dir
                               (LightDMGreeter *greeter,
                                const gchar *username,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

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.

lightdm_greeter_ensure_shared_data_dir_finish ()

gchar *
lightdm_greeter_ensure_shared_data_dir_finish
                               (LightDMGreeter *greeter,
                                GAsyncResult *result,
                                GError **error);

Function to call from lightdm_greeter_ensure_shared_data_dir callback.

lightdm_greeter_ensure_shared_data_dir_sync ()

gchar *
lightdm_greeter_ensure_shared_data_dir_sync
                               (LightDMGreeter *greeter,
                                const gchar *username,
                                GError **error);

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.

lightdm_greeter_connect_sync ()

gboolean
lightdm_greeter_connect_sync (LightDMGreeter *greeter,
                              GError **error);

Connects the greeter to the display manager. Will block until connected.

enum LightDMPromptType

Prompt types the client is required to display.

enum LightDMMessageType

enum LightDMGreeterError

Error codes returned by greeter operations.

The “authentication-user” property

  “authentication-user”      gchar *

The user being authenticated.

Flags: Read

Default value: NULL

The “autologin-guest-hint” property

  “autologin-guest-hint”     gboolean

Autologin guest account hint.

Flags: Read

Default value: FALSE

The “autologin-timeout-hint” property

  “autologin-timeout-hint”   gint

Autologin timeout hint.

Flags: Read

Allowed values: >= 0

Default value: 0

The “autologin-user-hint” property

  “autologin-user-hint”      gchar *

Autologin user hint.

Flags: Read

Default value: NULL

The “default-session-hint” property

  “default-session-hint”     gchar *

Default session hint.

Flags: Read

Default value: NULL

The “has-guest-account-hint” property

  “has-guest-account-hint”   gboolean

Has guest account hint.

Flags: Read

Default value: FALSE

The “hide-users-hint” property

  “hide-users-hint”          gboolean

Hide users hint.

Flags: Read

Default value: FALSE

The “in-authentication” property

  “in-authentication”        gboolean

TRUE if a user is being authenticated.

Flags: Read

Default value: FALSE

The “is-authenticated” property

  “is-authenticated”         gboolean

TRUE if the selected user is authenticated.

Flags: Read

Default value: FALSE

The “lock-hint” property

  “lock-hint”                gboolean

Lock hint.

Flags: Read

Default value: FALSE

The “select-guest-hint” property

  “select-guest-hint”        gboolean

Select guest account hint.

Flags: Read

Default value: FALSE

The “select-user-hint” property

  “select-user-hint”         gchar *

Select user hint.

Flags: Read

Default value: NULL

The “show-manual-login-hint” property

  “show-manual-login-hint”   gboolean

Show manual login hint.

Flags: Read

Default value: FALSE

The “show-remote-login-hint” property

  “show-remote-login-hint”   gboolean

Show remote login hint.

Flags: Read

Default value: FALSE

The “authentication-complete” signal

void
user_function (LightDMGreeter *greeter,
               gpointer        user_data)

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.

Flags: Run Last

The “autologin-timer-expired” signal

void
user_function (LightDMGreeter *greeter,
               gpointer        user_data)

The ::timed-login signal gets emitted when the automatic login timer has expired. The application should then call lightdm_greeter_authenticate_autologin().

Flags: Run Last

The “idle” signal

void
user_function (LightDMGreeter *greeter,
               gpointer        user_data)

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

Flags: Run Last

The “reset” signal

void
user_function (LightDMGreeter *greeter,
               gpointer        user_data)

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

Flags: Run Last

The “show-message” signal

void
user_function (LightDMGreeter    *greeter,
               gchar             *text,
               LightDMMessageType type,
               gpointer           user_data)

The ::show-message signal gets emitted when the greeter should show a message to the user.

Flags: Run Last

The “show-prompt” signal

void
user_function (LightDMGreeter   *greeter,
               gchar            *text,
               LightDMPromptType type,
               gpointer          user_data)

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.

Flags: Run Last