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 (greeter, NULL))
  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, NULL))
  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 ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @greeter:
 139 @cancellable:
 140 @callback:
 141 @user_data:
 142
 143
 144 <!-- ##### FUNCTION lightdm_greeter_connect_finish ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @greeter:
 150 @result:
 151 @error:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION lightdm_greeter_connect_sync ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @greeter:
 161 @error:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION lightdm_greeter_ensure_shared_data_dir ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @greeter:
 171 @username:
 172 @cancellable:
 173 @callback:
 174 @user_data:
 175
 176
 177 <!-- ##### FUNCTION lightdm_greeter_ensure_shared_data_dir_finish ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @greeter:
 183 @result:
 184 @Returns:
 185
 186
 187 <!-- ##### FUNCTION lightdm_greeter_ensure_shared_data_dir_sync ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @greeter:
 193 @username:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @greeter:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION lightdm_greeter_get_hint ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @greeter:
 212 @name:
 213 @Returns:
 214
 215
 216 <!-- ##### FUNCTION lightdm_greeter_get_lock_hint ##### -->
 217 <para>
 218
 219 </para>
 220
 221 @greeter:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION lightdm_greeter_get_has_guest_account_hint ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @greeter:
 231 @Returns:
 232
 233
 234 <!-- ##### FUNCTION lightdm_greeter_get_hide_users_hint ##### -->
 235 <para>
 236
 237 </para>
 238
 239 @greeter:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION lightdm_greeter_get_show_manual_login_hint ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @greeter:
 249 @Returns:
 250
 251
 252 <!-- ##### FUNCTION lightdm_greeter_get_show_remote_login_hint ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @greeter:
 258 @Returns:
 259
 260
 261 <!-- ##### FUNCTION lightdm_greeter_get_select_user_hint ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @greeter:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION lightdm_greeter_get_select_guest_hint ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @greeter:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION lightdm_greeter_get_autologin_user_hint ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @greeter:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION lightdm_greeter_get_autologin_guest_hint ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @greeter:
 294 @Returns:
 295
 296
 297 <!-- ##### FUNCTION lightdm_greeter_get_autologin_timeout_hint ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @greeter:
 303 @Returns:
 304
 305
 306 <!-- ##### FUNCTION lightdm_greeter_set_language ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @greeter:
 312 @language:
 313
 314
 315 <!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @greeter:
 321
 322
 323 <!-- ##### FUNCTION lightdm_greeter_authenticate ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @greeter:
 329 @username:
 330
 331
 332 <!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @greeter:
 338
 339
 340 <!-- ##### FUNCTION lightdm_greeter_authenticate_autologin ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @greeter:
 346
 347
 348 <!-- ##### FUNCTION lightdm_greeter_authenticate_remote ##### -->
 349 <para>
 350
 351 </para>
 352
 353 @greeter:
 354 @session:
 355 @username:
 356
 357
 358 <!-- ##### FUNCTION lightdm_greeter_respond ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @greeter:
 364 @response:
 365
 366
 367 <!-- ##### FUNCTION lightdm_greeter_cancel_authentication ##### -->
 368 <para>
 369
 370 </para>
 371
 372 @greeter:
 373
 374
 375 <!-- ##### FUNCTION lightdm_greeter_get_in_authentication ##### -->
 376 <para>
 377
 378 </para>
 379
 380 @greeter:
 381 @Returns:
 382
 383
 384 <!-- ##### FUNCTION lightdm_greeter_get_is_authenticated ##### -->
 385 <para>
 386
 387 </para>
 388
 389 @greeter:
 390 @Returns:
 391
 392
 393 <!-- ##### FUNCTION lightdm_greeter_get_authentication_user ##### -->
 394 <para>
 395
 396 </para>
 397
 398 @greeter:
 399 @Returns:
 400
 401
 402 <!-- ##### FUNCTION lightdm_greeter_start_session ##### -->
 403 <para>
 404
 405 </para>
 406
 407 @greeter:
 408 @session:
 409 @cancellable:
 410 @callback:
 411 @user_data:
 412
 413
 414 <!-- ##### FUNCTION lightdm_greeter_start_session_finish ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @greeter:
 420 @result:
 421 @error:
 422 @Returns:
 423
 424
 425 <!-- ##### FUNCTION lightdm_greeter_start_session_sync ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @greeter:
 431 @session:
 432 @error:
 433 @Returns:
 434
 435