summaryrefslogtreecommitdiff
path: root/doc/tmpl/greeter.sgml
blob: 5dee0813b6cbbd2cc59b12da212557e821975e6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!-- ##### SECTION Title ##### -->
Greeter Interface

<!-- ##### SECTION Short_Description ##### -->
Make a connection to the LightDM daemon and authenticate users

<!-- ##### SECTION Long_Description ##### -->
<para>
#LightDMGreeter is an object that manages the connection to the LightDM server and provides common greeter functionality.
</para>
<para>
<example>
<title>Example Greeter</title>
<programlisting><![CDATA[
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_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);
    }
}
]]></programlisting>
</example>
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### USER_FUNCTION show_message ##### -->
<para>

</para>

@greeter: 
@text: 
@type: 


<!-- ##### USER_FUNCTION show_prompt ##### -->
<para>

</para>

@greeter: 
@text: 
@type: 


<!-- ##### USER_FUNCTION authentication_complete ##### -->
<para>

</para>

@greeter: 


<!-- ##### USER_FUNCTION autologin_timer_expired ##### -->
<para>

</para>

@greeter: 


<!-- ##### ENUM LightDMMessageType ##### -->
<para>

</para>

@LIGHTDM_MESSAGE_TYPE_INFO: 
@LIGHTDM_MESSAGE_TYPE_ERROR: 

<!-- ##### ENUM LightDMPromptType ##### -->
<para>

</para>

@LIGHTDM_PROMPT_TYPE_QUESTION: 
@LIGHTDM_PROMPT_TYPE_SECRET: 

<!-- ##### FUNCTION lightdm_greeter_new ##### -->
<para>

</para>

@void: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_connect_sync ##### -->
<para>

</para>

@greeter: 
@error: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_default_session_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_hint ##### -->
<para>

</para>

@greeter: 
@name: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_lock_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_has_guest_account_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_hide_users_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_show_manual_login_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_show_remote_login_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_select_user_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_select_guest_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_autologin_user_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_autologin_guest_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_autologin_timeout_hint ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_set_language ##### -->
<para>

</para>

@greeter: 
@language: 


<!-- ##### FUNCTION lightdm_greeter_cancel_autologin ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION lightdm_greeter_authenticate ##### -->
<para>

</para>

@greeter: 
@username: 


<!-- ##### FUNCTION lightdm_greeter_authenticate_as_guest ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION lightdm_greeter_authenticate_autologin ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION lightdm_greeter_authenticate_remote ##### -->
<para>

</para>

@greeter: 
@session: 
@username: 


<!-- ##### FUNCTION lightdm_greeter_respond ##### -->
<para>

</para>

@greeter: 
@response: 


<!-- ##### FUNCTION lightdm_greeter_cancel_authentication ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION lightdm_greeter_get_in_authentication ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_is_authenticated ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_get_authentication_user ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_start_session_sync ##### -->
<para>

</para>

@greeter: 
@session: 
@error: 
@Returns: 


<!-- ##### FUNCTION lightdm_greeter_ensure_shared_data_dir ##### -->
<para>

</para>

@greeter:
@username: