Top | ![]() |
![]() |
![]() |
![]() |
Greeter InterfaceGreeter Interface — Make a connection to the LightDM daemon and authenticate users |
LightDMGreeter is an object that manages the connection to the LightDM server and provides common greeter functionality.
Example 1. Example Greeter
int main () { GMainLoop *main_loop; LightDMGreeter *greeter main_loop = g_main_loop_new (); greeter = lightdm_greeter_new (); g_object_connect (greeter, "show-prompt", G_CALLBACK (show_prompt_cb), NULL); g_object_connect (greeter, "authentication-complete", G_CALLBACK (authentication_complete_cb), NULL); // Connect to LightDM daemon if (!lightdm_greeter_connect_to_daemon_sync (greeter, NULL)) return EXIT_FAILURE; // Start authentication lightdm_greeter_authenticate (greeter, NULL); g_main_loop_run (main_loop); return EXIT_SUCCESS; } static void show_prompt_cb (LightDMGreeter *greeter, const char *text, LightDMPromptType type) { // Show the user the message and prompt for some response gchar *secret = prompt_user (text, type); // Give the result to the user lightdm_greeter_respond (greeter, response); } static void authentication_complete_cb (LightDMGreeter *greeter) { // Start the session if (!lightdm_greeter_get_is_authenticated (greeter) || !lightdm_greeter_start_session_sync (greeter, NULL)) { // Failed authentication, try again lightdm_greeter_authenticate (greeter, NULL); } }
void (*show_message) (LightDMGreeter *greeter
,const gchar *text
,LightDMMessageType type
);
void (*show_prompt) (LightDMGreeter *greeter
,const gchar *text
,LightDMPromptType type
);
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.
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.
greeter |
The greeter to connect |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when completed or |
[allow-none] |
user_data |
data to pass to the |
[allow-none] |
gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter
,GAsyncResult *result
,GError **error
);
Finishes an operation started with lightdm_greeter_connect_to_daemon()
.
gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter
,GError **error
);
Connects the greeter to the display manager. Will block until connected.
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.
greeter |
A LightDMGreeter |
|
username |
A username |
|
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when completed or |
[allow-none] |
user_data |
data to pass to the |
[allow-none] |
gchar * lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter
,GAsyncResult *result
);
Function to call from lightdm_greeter_ensure_shared_data_dir callback.
gchar * lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter
,const gchar *username
);
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.
const gchar *
lightdm_greeter_get_default_session_hint
(LightDMGreeter *greeter
);
Get the default session to use.
const gchar * lightdm_greeter_get_hint (LightDMGreeter *greeter
,const gchar *name
);
Get a hint.
gboolean
lightdm_greeter_get_lock_hint (LightDMGreeter *greeter
);
Check if the greeter is acting as a lock screen.
gboolean
lightdm_greeter_get_has_guest_account_hint
(LightDMGreeter *greeter
);
Check if guest sessions are supported.
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.
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.
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.
const gchar *
lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter
);
Get the user to select by default.
gboolean
lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter
);
Check if the guest account should be selected by default.
const gchar *
lightdm_greeter_get_autologin_user_hint
(LightDMGreeter *greeter
);
Get the user account to automatically log into when the timer expires.
gboolean
lightdm_greeter_get_autologin_guest_hint
(LightDMGreeter *greeter
);
Check if the guest account should be automatically logged into when the timer expires.
gint
lightdm_greeter_get_autologin_timeout_hint
(LightDMGreeter *greeter
);
Get the number of seconds to wait before automaitcally logging in.
void lightdm_greeter_set_language (LightDMGreeter *greeter
,const gchar *language
);
Set the language for the currently authenticated user.
void
lightdm_greeter_cancel_autologin (LightDMGreeter *greeter
);
Cancel the automatic login.
void lightdm_greeter_authenticate (LightDMGreeter *greeter
,const gchar *username
);
Starts the authentication procedure for a user.
greeter |
A LightDMGreeter |
|
username |
A username or NULL to prompt for a username. |
[allow-none] |
void
lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter
);
Starts the authentication procedure for the guest user.
void
lightdm_greeter_authenticate_autologin
(LightDMGreeter *greeter
);
Starts the authentication procedure for the automatic login user.
void lightdm_greeter_authenticate_remote (LightDMGreeter *greeter
,const gchar *session
,const gchar *username
);
Start authentication for a remote session type.
greeter |
A LightDMGreeter |
|
session |
The name of a remote session |
|
username |
A username of NULL to prompt for a username. |
[allow-none] |
void lightdm_greeter_respond (LightDMGreeter *greeter
,const gchar *response
);
Provide response to a prompt. May be one in a series.
void
lightdm_greeter_cancel_authentication (LightDMGreeter *greeter
);
Cancel the current user authentication.
gboolean
lightdm_greeter_get_in_authentication (LightDMGreeter *greeter
);
Checks if the greeter is in the process of authenticating.
gboolean
lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter
);
Checks if the greeter has successfully authenticated.
const gchar *
lightdm_greeter_get_authentication_user
(LightDMGreeter *greeter
);
Get the user that is being authenticated.
The username of the authentication user being authenticated or NULL if no authentication in progress.
[nullable]
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.
greeter |
A LightDMGreeter |
|
session |
The session to log into or NULL to use the default. |
[allow-none] |
cancellable |
A GCancellable or |
[allow-none] |
callback |
A GAsyncReadyCallback to call when completed or |
[allow-none] |
user_data |
data to pass to the |
[allow-none] |
gboolean lightdm_greeter_start_session_finish (LightDMGreeter *greeter
,GAsyncResult *result
,GError **error
);
Start a session for the authenticated user.
gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter
,const gchar *session
,GError **error
);
Start a session for the authenticated user.
greeter |
A LightDMGreeter |
|
session |
The session to log into or NULL to use the default. |
[allow-none] |
error |
return location for a GError, or |