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_sync ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @greeter:
 139 @error:
 140 @Returns:
 141
 142
 143 <!-- ##### FUNCTION lightdm_greeter_ensure_shared_data_dir_sync ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @greeter:
 149 @username:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @greeter:
 159 @Returns:
 160
 161
 162 <!-- ##### FUNCTION lightdm_greeter_get_hint ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @greeter:
 168 @name:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION lightdm_greeter_get_lock_hint ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @greeter:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION lightdm_greeter_get_has_guest_account_hint ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @greeter:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION lightdm_greeter_get_hide_users_hint ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @greeter:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION lightdm_greeter_get_show_manual_login_hint ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @greeter:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION lightdm_greeter_get_show_remote_login_hint ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @greeter:
 214 @Returns:
 215
 216
 217 <!-- ##### FUNCTION lightdm_greeter_get_select_user_hint ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @greeter:
 223 @Returns:
 224
 225
 226 <!-- ##### FUNCTION lightdm_greeter_get_select_guest_hint ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @greeter:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION lightdm_greeter_get_autologin_user_hint ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @greeter:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION lightdm_greeter_get_autologin_guest_hint ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @greeter:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION lightdm_greeter_get_autologin_timeout_hint ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @greeter:
 259 @Returns:
 260
 261
 262 <!-- ##### FUNCTION lightdm_greeter_set_language ##### -->
 263 <para>
 264
 265 </para>
 266
 267 @greeter:
 268 @language:
 269
 270
 271 <!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @greeter:
 277
 278
 279 <!-- ##### FUNCTION lightdm_greeter_authenticate ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @greeter:
 285 @username:
 286
 287
 288 <!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @greeter:
 294
 295
 296 <!-- ##### FUNCTION lightdm_greeter_authenticate_autologin ##### -->
 297 <para>
 298
 299 </para>
 300
 301 @greeter:
 302
 303
 304 <!-- ##### FUNCTION lightdm_greeter_authenticate_remote ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @greeter:
 310 @session:
 311 @username:
 312
 313
 314 <!-- ##### FUNCTION lightdm_greeter_respond ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @greeter:
 320 @response:
 321
 322
 323 <!-- ##### FUNCTION lightdm_greeter_cancel_authentication ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @greeter:
 329
 330
 331 <!-- ##### FUNCTION lightdm_greeter_get_in_authentication ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @greeter:
 337 @Returns:
 338
 339
 340 <!-- ##### FUNCTION lightdm_greeter_get_is_authenticated ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @greeter:
 346 @Returns:
 347
 348
 349 <!-- ##### FUNCTION lightdm_greeter_get_authentication_user ##### -->
 350 <para>
 351
 352 </para>
 353
 354 @greeter:
 355 @Returns:
 356
 357
 358 <!-- ##### FUNCTION lightdm_greeter_start_session_sync ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @greeter:
 364 @session:
 365 @error:
 366 @Returns:
 367
 368