summaryrefslogtreecommitdiffstats
path: root/docs/reference/pygio-mountoperation.xml
blob: 34dec13b5f3d3844e7fb04cbc437ecba729456c1 (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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-giomountoperation">
    <refnamediv>
        <refname>gio.MountOperation</refname>
        <refpurpose>Authentication methods for mountable locations.</refpurpose>
    </refnamediv>

    <refsect1>
        <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>gio.MountOperation</classname></ooclass>
        <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
    
    <constructorsynopsis language="python">
    <methodname><link linkend="constructor-giomountoperation">gio.MountOperation</link></methodname>
    <methodparam></methodparam>
    </constructorsynopsis>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-anonymous">get_anonymous</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-choice">get_choice</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-domain">get_domain</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-password">get_password</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-password-save">get_password_save</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--get-username">get_username</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--reply">replay</link></methodname>
        <methodparam><parameter role="keyword">result</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-anonymous">set_anonymous</link></methodname>
        <methodparam><parameter role="keyword">anonymous</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-choice">set_choice</link></methodname>
        <methodparam><parameter role="keyword">choice</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-domain">set_domain</link></methodname>
        <methodparam><parameter role="keyword">domain</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-password">set_password</link></methodname>
        <methodparam><parameter role="keyword">password</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-password-save">set_password_save</link></methodname>
        <methodparam><parameter role="keyword">save</parameter></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-giomountoperation--set-username">set_username</link></methodname>
        <methodparam><parameter role="keyword">username</parameter></methodparam>
    </methodsynopsis>
    
    </classsynopsis>
    </refsect1>

    <refsect1>
        <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-giomountoperation">gio.MountOperation</link>
</synopsis>

    </refsect1>

    <refsect1 id="properties-giomountoperation">
        <title>gio.MountOperation Properties</title>
    
        <blockquote role="properties">
            <informaltable pgwide="1" frame="none">
                <tgroup cols="3">
                    <colspec column="1" colwidth="1in"/>
                    <colspec column="2" colwidth="1in"/>
                    <colspec column="3" colwidth="4in"/>
                    <tbody>
                        <row valign="top">
                            <entry>"anonymous"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                Whether to use an anonymous user when authenticating.
                                Default value: <literal>False</literal>
                            </entry>
                        </row>
                        <row valign="top">
                            <entry>"choice"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The index of the user's choice when a question is asked during
                                the mount operation. See the "ask-question" signal.
                                Allowed values: >= 0 Default value: 0
                            </entry>
                        </row>
                        <row valign="top">
                            <entry>"domain"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The domain to use for the mount operation. Default value: <literal>None</literal>
                            </entry>
                        </row>
                        <row valign="top">
                            <entry>"password"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The password that is used for authentication when carrying out the
                                mount operation. Default value: <literal>None</literal>
                            </entry>
                        </row>
                        <row valign="top">
                            <entry>"password-save"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                Determines if and how the password information should be saved.
                                Default value: gio.PASSWORD_SAVE_NEVER
                            </entry>
                        </row>
                        <row valign="top">
                            <entry>"username"</entry>
                            <entry>Read/Write</entry>
                            <entry>
                                The user name that is used for authentication when carrying out the
                                mount operation. Default value: <literal>None</literal>
                            </entry>
                        </row>
                    </tbody>
                </tgroup>
            </informaltable>
        </blockquote>
  
    </refsect1>

    <refsect1 id="signal-prototypes-giomountoperation">
        <title>gio.MountOperation Signal Prototypes</title>
  
        <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
  
        <variablelist>
            <varlistentry>
                <term><link linkend="signal-giomountoperation--aborted">"aborted"</link></term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>mountoperation</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><link linkend="signal-giomountoperation--ask-password">"ask-password"</link></term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>mountoperation</parameter></methodparam>
                        <methodparam><parameter>message</parameter></methodparam>
                        <methodparam><parameter>default_user</parameter></methodparam>
                        <methodparam><parameter>default_domain</parameter></methodparam>
                        <methodparam><parameter>flags</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><link linkend="signal-giomountoperation--ask-question">"ask-question"</link></term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>mountoperation</parameter></methodparam>
                        <methodparam><parameter>message</parameter></methodparam>
                        <methodparam><parameter>choices</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term><link linkend="signal-giomountoperation--reply">"reply"</link></term>
                <listitem>
                    <methodsynopsis language="python"><methodname>callback</methodname>
                        <methodparam><parameter>mountoperation</parameter></methodparam>
                        <methodparam><parameter>result</parameter></methodparam>
                        <methodparam><parameter>user_param1</parameter></methodparam>
                        <methodparam><parameter>...</parameter></methodparam>
                    </methodsynopsis>
                </listitem>
            </varlistentry>
        </variablelist>
  
    </refsect1>

    <refsect1>
        <title>Description</title>

        <para>
            The <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
        provides a mechanism for authenticating mountable operations, such as loop mounting files,
        hard drive partitions or server locations.
        </para>
        <para>
            Mounting operations are handed a
            <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
            that then can use if they require any privileges or authentication for their volumes to be
            mounted (e.g. a hard disk partition or an encrypted filesystem), or if they are implementing
            a remote server protocol which requires user credentials such as FTP or WebDAV.
        </para>
        <para>
            Users should instantiate a subclass of this that implements all the various callbacks
            to show the required dialogs, such as
            <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
        </para>
    </refsect1>

    <refsect1 id="constructor-giomountoperation">
        <title>Constructor</title>
  
        <programlisting><constructorsynopsis language="python">
            <methodname>gio.MountOperation</methodname>
            <methodparam></methodparam>
        </constructorsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><emphasis>Returns</emphasis>&nbsp;:</term>
                <listitem><simpara>a new
                <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>.
                </simpara></listitem>
            </varlistentry>
        </variablelist>
    
        <para>
            Creates a new mount operation.
        </para>
  
    </refsect1>

    <refsect1>
        <title>Methods</title>

        <refsect2 id="method-giomountoperation--get-anonymous">
            <title>gio.MountOperation.get_anonymous</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_anonymous</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara><literal>True</literal> if mount operation is anonymous.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_anonymous</methodname>() method check to see whether
                the mount operation is being used for an anonymous user
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--get-choice">
            <title>gio.MountOperation.get_choice</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_choice</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>an integer containing an index of the user's
                    choice from the choice's list, or 0.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_anonymous</methodname>() method gets a choice
                from the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--get-domain">
            <title>gio.MountOperation.get_domain</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_domain</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>a string set to the domain.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_domain</methodname>() method gets the domain
                of the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--get-password">
            <title>gio.MountOperation.get_password</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_password</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>a string containing the password within
                    the mountoperation.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_password</methodname>() method gets a password
                from the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--get-password-save">
            <title>gio.MountOperation.get_password_save</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_password_save</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>a
                    <xref linkend="gio-password-save-constants" endterm="gio-password-save-constants-title"></xref>
                    flag.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_password_save</methodname>() method gets the state
                of saving passwords for the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--get-username">
            <title>gio.MountOperation.get_username</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_username</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                    <listitem><simpara>a string containing the user name.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>get_username</methodname>() method get the user
                name from the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--reply">
            <title>gio.MountOperation.reply</title>

            <programlisting><methodsynopsis language="python">
                <methodname>reply</methodname>
                <methodparam><parameter role="keyword">result</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>result</parameter>&nbsp;:</term>
                    <listitem><simpara>a
                    <xref linkend="gio-mount-operation-result-constants" endterm="gio-mount-operation-result-constants-title"></xref>
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>reply</methodname>() method emits the "reply" signal.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-anonymous">
            <title>gio.MountOperation.set_anonymous</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_anonymous</methodname>
                <methodparam><parameter role="keyword">anonymous</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>anonymous</parameter>&nbsp;:</term>
                    <listitem><simpara>boolean value.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_anonymous</methodname>() method sets the mount operation
                to use an anonymous user if anonymous is <literal>True</literal>.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-choice">
            <title>gio.MountOperation.set_choice</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_choice</methodname>
                <methodparam><parameter role="keyword">choice</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>choice</parameter>&nbsp;:</term>
                    <listitem><simpara>an integer.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_choice</methodname>() method sets a default choice for the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-domain">
            <title>gio.MountOperation.set_domain</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_domain</methodname>
                <methodparam><parameter role="keyword">domain</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>domain</parameter>&nbsp;:</term>
                    <listitem><simpara>the domain to set.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_domain</methodname>() method sets the mount operation's domain.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-password">
            <title>gio.MountOperation.set_password</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_password</methodname>
                <methodparam><parameter role="keyword">password</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>password</parameter>&nbsp;:</term>
                    <listitem><simpara>password to set.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_password</methodname>() method sets the mount
                operation's password to password.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-password-save">
            <title>gio.MountOperation.set_password_save</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_password_save</methodname>
                <methodparam><parameter role="keyword">save</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>save</parameter>&nbsp;:</term>
                    <listitem><simpara>a set of
                    <xref linkend="gio-password-save-constants" endterm="gio-password-save-constants-title"></xref>
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_password_save</methodname>() method sets the state
                of saving passwords for the mount operation.
            </para>
        </refsect2>

        <refsect2 id="method-giomountoperation--set-username">
            <title>gio.MountOperation.set_username</title>

            <programlisting><methodsynopsis language="python">
                <methodname>set_username</methodname>
                <methodparam><parameter role="keyword">username</parameter></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><parameter>username</parameter>&nbsp;:</term>
                    <listitem><simpara>input username.
                    </simpara></listitem>
                </varlistentry>
            </variablelist>
    
            <para>
                The <methodname>set_anonymous</methodname>() method sets the user
                name within op to username.
            </para>
        </refsect2>
    </refsect1>

    <refsect1>
        <title>Signals</title>
    
        <refsect2 id="signal-giomountoperation--aborted">
            <title>The "aborted" gio.MountOperation Signal</title>
      
            <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
                <methodparam><parameter>mountoperation</parameter></methodparam>
                <methodparam><parameter>user_param1</parameter></methodparam>
                <methodparam><parameter>...</parameter></methodparam>
            </methodsynopsis></programlisting>
      
            <variablelist>
                <varlistentry>
                    <term><parameter>mountoperation</parameter>&nbsp;:</term>
                    <listitem><simpara>the mountoperation</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</term>
                    <listitem><simpara>the first user parameter (if any) specified
                    with the <link
                    linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
                    method</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>...</parameter>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if any)</simpara></listitem>
                </varlistentry>
            </variablelist>
      
            <para>
                Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress.
                Implementations of <link linkend="class-giomountoperation"><classname>gio.MountOperation</classname></link>
                should handle this signal by dismissing open password dialogs.
            </para>
        </refsect2>
    
        <refsect2 id="signal-giomountoperation--ask-password">
            <title>The "ask-password" gio.MountOperation Signal</title>
      
            <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
                <methodparam><parameter>mountoperation</parameter></methodparam>
                <methodparam><parameter>message</parameter></methodparam>
                <methodparam><parameter>default_user</parameter></methodparam>
                <methodparam><parameter>default_domain</parameter></methodparam>
                <methodparam><parameter>flags</parameter></methodparam>
                <methodparam><parameter>user_param1</parameter></methodparam>
                <methodparam><parameter>...</parameter></methodparam>
            </methodsynopsis></programlisting>
      
            <variablelist>
                <varlistentry>
                    <term><parameter>mountoperation</parameter>&nbsp;:</term>
                    <listitem><simpara>the mountoperation</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>message</parameter>&nbsp;:</term>
                    <listitem><simpara>string containing a message to display to the user.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>default_user</parameter>&nbsp;:</term>
                    <listitem><simpara>string containing the default user name.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>default_domain</parameter>&nbsp;:</term>
                    <listitem><simpara>string containing the default domain.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>flags</parameter>&nbsp;:</term>
                    <listitem><simpara>a set of
                    <xref linkend="gio-ask-password-flags-constants" endterm="gio-ask-password-flags-constants-title"></xref>
                    </simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</term>
                    <listitem><simpara>the first user parameter (if any) specified
                    with the <link
                    linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
                    method</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>...</parameter>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if any)</simpara></listitem>
                </varlistentry>
            </variablelist>
      
            <para>
                This signal is emitted when a mount operation asks the user for a password.
                If the message contains a line break, the first line should be presented as a heading.
                For example, it may be used as the primary text in a
                <link linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>.
            </para>
        </refsect2>
    
        <refsect2 id="signal-giomountoperation--ask-question">
            <title>The "ask-question" gio.MountOperation Signal</title>
      
            <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
                <methodparam><parameter>mountoperation</parameter></methodparam>
                <methodparam><parameter>message</parameter></methodparam>
                <methodparam><parameter>choices</parameter></methodparam>
                <methodparam><parameter>user_param1</parameter></methodparam>
                <methodparam><parameter>...</parameter></methodparam>
            </methodsynopsis></programlisting>
      
            <variablelist>
                <varlistentry>
                    <term><parameter>mountoperation</parameter>&nbsp;:</term>
                    <listitem><simpara>the mountoperation</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>message</parameter>&nbsp;:</term>
                    <listitem><simpara>string containing a message to display to the user.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>choices</parameter>&nbsp;:</term>
                    <listitem><simpara>a list of strings for each possible choice.</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</term>
                    <listitem><simpara>the first user parameter (if any) specified
                    with the <link
                    linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
                    method</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>...</parameter>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if any)</simpara></listitem>
                </varlistentry>
            </variablelist>
      
            <para>
                This signal is emitted when asking the user a question and gives a list of choices
                for the user to choose from. If the message contains a line break, the first line should be
                presented as a heading. For example, it may be used as the primary text in a
                <link linkend="class-gtkmessagedialog"><classname>gtk.MessageDialog</classname></link>.
            </para>
        </refsect2>
    
        <refsect2 id="signal-giomountoperation--reply">
            <title>The "reply" gio.MountOperation Signal</title>
      
            <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
                <methodparam><parameter>mountoperation</parameter></methodparam>
                <methodparam><parameter>result</parameter></methodparam>
                <methodparam><parameter>user_param1</parameter></methodparam>
                <methodparam><parameter>...</parameter></methodparam>
            </methodsynopsis></programlisting>
      
            <variablelist>
                <varlistentry>
                    <term><parameter>mountoperation</parameter>&nbsp;:</term>
                    <listitem><simpara>the mountoperation</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>result</parameter>&nbsp;:</term>
                    <listitem><simpara>a
                    <xref linkend="gio-mount-operation-result-constants" endterm="gio-mount-operation-result-constants-title"></xref>
                    indicating how the request was handled</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>user_param1</parameter>&nbsp;:</term>
                    <listitem><simpara>the first user parameter (if any) specified
                    with the <link
                    linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
                    method</simpara></listitem>
                </varlistentry>
                <varlistentry>
                    <term><parameter>...</parameter>&nbsp;:</term>
                    <listitem><simpara>additional user parameters (if any)</simpara></listitem>
                </varlistentry>
            </variablelist>
      
            <para>
                This signal is emitted when the user has replied to the mount operation.
            </para>
        </refsect2>
  
  </refsect1>
</refentry>