doc/tmpl/greeter.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Greeter Interface
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Make a connection to the LightDM daemon and authenticate users
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #LightDMGreeter is an object that manages the connection to the LightDM server and provides common greeter functionality.
  10 </para>
  11 <para>
  12 <example>
  13 <title>Example Greeter</title>
  14 <programlisting><![CDATA[
  15 int main ()
  16 {
  17     GMainLoop *main_loop;
  18     LightDMGreeter *greeter
  19
  20     main_loop = g_main_loop_new ();
  21
  22     greeter = lightdm_greeter_new ();
  23     g_object_connect (greeter, "show-prompt", G_CALLBACK (show_prompt_cb), NULL);
  24     g_object_connect (greeter, "authentication-complete", G_CALLBACK (authentication_complete_cb), NULL);
  25
  26     // Connect to LightDM daemon
  27     if (!lightdm_greeter_connect_sync (LIGHTDM_GREETER (greeter)))
  28         return EXIT_FAILURE;
  29
  30     // Start authentication
  31     lightdm_greeter_authenticate (greeter, NULL);
  32
  33     g_main_loop_run (main_loop);
  34
  35     return EXIT_SUCCESS;
  36 }
  37
  38 static void show_prompt_cb (LightDMGreeter *greeter, const char *text, LightDMPromptType type)
  39 {
  40     // Show the user the message and prompt for some response
  41     gchar *secret = prompt_user (text, type);
  42
  43     // Give the result to the user
  44     lightdm_greeter_respond (greeter, response);
  45 }
  46
  47 static void authentication_complete_cb (LightDMGreeter *greeter)
  48 {
  49     // Start the session
  50     if (!lightdm_greeter_get_is_authenticated (greeter) ||
  51         !lightdm_greeter_start_session_sync (greeter))
  52     {
  53         // Failed authentication, try again
  54         lightdm_greeter_authenticate (greeter, NULL);
  55     }
  56 }
  57 ]]></programlisting>
  58 </example>
  59 </para>
  60
  61 <!-- ##### SECTION See_Also ##### -->
  62 <para>
  63
  64 </para>
  65
  66 <!-- ##### SECTION Stability_Level ##### -->
  67
  68
  69 <!-- ##### SECTION Image ##### -->
  70
  71
  72 <!-- ##### USER_FUNCTION show_message ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @greeter:
  78 @text:
  79 @type:
  80
  81
  82 <!-- ##### USER_FUNCTION show_prompt ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @greeter:
  88 @text:
  89 @type:
  90
  91
  92 <!-- ##### USER_FUNCTION authentication_complete ##### -->
  93 <para>
  94
  95 </para>
  96
  97 @greeter:
  98
  99
 100 <!-- ##### USER_FUNCTION autologin_timer_expired ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @greeter:
 106
 107
 108 <!-- ##### ENUM LightDMMessageType ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @LIGHTDM_MESSAGE_TYPE_INFO:
 114 @LIGHTDM_MESSAGE_TYPE_ERROR:
 115
 116 <!-- ##### ENUM LightDMPromptType ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @LIGHTDM_PROMPT_TYPE_QUESTION:
 122 @LIGHTDM_PROMPT_TYPE_SECRET:
 123
 124 <!-- ##### FUNCTION lightdm_greeter_new ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @void:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION lightdm_greeter_connect_sync ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @greeter:
 139 @Returns:
 140
 141
 142 <!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @greeter:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION lightdm_greeter_get_hint ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @greeter:
 157 @name:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION lightdm_greeter_get_has_guest_account_hint ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @greeter:
 167 @Returns:
 168
 169
 170 <!-- ##### FUNCTION lightdm_greeter_get_hide_users_hint ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @greeter:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION lightdm_greeter_get_select_user_hint ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @greeter:
 185 @Returns:
 186
 187
 188 <!-- ##### FUNCTION lightdm_greeter_get_select_guest_hint ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @greeter:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION lightdm_greeter_get_autologin_user_hint ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @greeter:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION lightdm_greeter_get_autologin_guest_hint ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @greeter:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION lightdm_greeter_get_autologin_timeout_hint ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @greeter:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @greeter:
 230
 231
 232 <!-- ##### FUNCTION lightdm_greeter_authenticate ##### -->
 233 <para>
 234
 235 </para>
 236
 237 @greeter:
 238 @username:
 239
 240
 241 <!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @greeter:
 247
 248
 249 <!-- ##### FUNCTION lightdm_greeter_respond ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @greeter:
 255 @response:
 256
 257
 258 <!-- ##### FUNCTION lightdm_greeter_cancel_authentication ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @greeter:
 264
 265
 266 <!-- ##### FUNCTION lightdm_greeter_get_in_authentication ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @greeter:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION lightdm_greeter_get_is_authenticated ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @greeter:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION lightdm_greeter_get_authentication_user ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @greeter:
 290 @Returns:
 291
 292
 293 <!-- ##### FUNCTION lightdm_greeter_start_session_sync ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @greeter:
 299 @session:
 300 @Returns:
 301
 302