summaryrefslogtreecommitdiff
path: root/doc/tmpl/greeter.sgml
blob: c62f6d3cfa6530867a06a91f61dedab76887aec4 (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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
<!-- ##### SECTION Title ##### -->
LdmGreeter

<!-- ##### SECTION Short_Description ##### -->
LightDM greeter object

<!-- ##### SECTION Long_Description ##### -->
<para>
#LdmGreeter is an object that manages the connection to the LightDM server and provides common greeter functionality.
</para>
<para>
To connect to the display manager instanciate a #LdmGreeter object from inside the greeter process:
<example>
<title>Connecting to the display manager</title>
<programlisting><![CDATA[
LdmGreeter *greeter = ldm_greeter_new ();
if (!ldm_greeter_connect (LDM_GREETER (greeter))) {
    // Log an error
    exit (0);
}
]]></programlisting>
</example>
Information on how to connect to the display manager is passed using environment variables.
</para>
<para>
Once connected, start an authentication conversation like this:
<example>
<title>Example Authorization Conversation</title>
<programlisting><![CDATA[
static void show_prompt_cb (LdmGreeter *greeter, const char *text)
{
    // Show the user the message and prompt for some response
    gchar *secret = prompt_user (text);

    // Give the result to the user
    ldm_greeter_provide_secret (greeter, secret);
}

static void authentication_complete_cb (LdmGreeter *greeter)
{
    if (ldm_greeter_get_is_authenticated (greeter)) {
        // Log in to this session.
        ldm_greeter_login (greeter);
    }
    else {
        // Display a warning and reset the greeter
        reset_login_screen ();
    }
}

static void quit_cb (LdmGreeter *greeter)
{
    // Clean up
    // ...
    
    exit (0);
}

g_object_connect (G_OBJECT (greeter), "show-prompt", G_CALLBACK (show_prompt_cb), NULL);
g_object_connect (G_OBJECT (greeter), "authentication-complete", G_CALLBACK (authentication_complete_cb), NULL);
g_object_connect (G_OBJECT (greeter), "quit", G_CALLBACK (quit_cb), NULL);
]]></programlisting>
</example>
</para>

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

</para>

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


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


<!-- ##### STRUCT LdmGreeter ##### -->
<para>

</para>


<!-- ##### SIGNAL LdmGreeter::authentication-complete ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.

<!-- ##### SIGNAL LdmGreeter::quit ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.

<!-- ##### SIGNAL LdmGreeter::show-error ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL LdmGreeter::show-message ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL LdmGreeter::show-prompt ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL LdmGreeter::timed-login ##### -->
<para>

</para>

@ldmgreeter: the object which received the signal.
@arg1: 

<!-- ##### ARG LdmGreeter:can-hibernate ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:can-restart ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:can-shutdown ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:can-suspend ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:is-authenticated ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:layout ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:login-delay ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:num-users ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:session ##### -->
<para>

</para>

<!-- ##### ARG LdmGreeter:timed-login-user ##### -->
<para>

</para>

<!-- ##### FUNCTION ldm_greeter_new ##### -->
<para>

</para>

@void: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_connect ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_num_users ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_users ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_languages ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_language ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_layout ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_layouts ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_set_layout ##### -->
<para>

</para>

@greeter: 
@layout: 


<!-- ##### FUNCTION ldm_greeter_get_sessions ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_session ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_set_session ##### -->
<para>

</para>

@greeter: 
@session: 


<!-- ##### FUNCTION ldm_greeter_get_timed_login_user ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_get_timed_login_delay ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_cancel_timed_login ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_start_authentication ##### -->
<para>

</para>

@greeter: 
@username: 


<!-- ##### FUNCTION ldm_greeter_provide_secret ##### -->
<para>

</para>

@greeter: 
@secret: 


<!-- ##### FUNCTION ldm_greeter_cancel_authentication ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_get_is_authenticated ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_login ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_get_can_suspend ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_suspend ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_get_can_hibernate ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_hibernate ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_get_can_restart ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_restart ##### -->
<para>

</para>

@greeter: 


<!-- ##### FUNCTION ldm_greeter_get_can_shutdown ##### -->
<para>

</para>

@greeter: 
@Returns: 


<!-- ##### FUNCTION ldm_greeter_shutdown ##### -->
<para>

</para>

@greeter: