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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpFileTransferChannel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-client.html" title="Client-side proxies">
<link rel="prev" href="telepathy-glib-text-channel.html" title="TpTextChannel">
<link rel="next" href="telepathy-glib-call-channel.html" title="TpCallChannel">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="telepathy-glib-text-channel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="telepathy-glib-call-channel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#telepathy-glib-file-transfer-channel.synopsis" class="shortcut">Top</a>
|
<a href="#telepathy-glib-file-transfer-channel.description" class="shortcut">Description</a>
|
<a href="#telepathy-glib-file-transfer-channel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#telepathy-glib-file-transfer-channel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#telepathy-glib-file-transfer-channel.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-file-transfer-channel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-file-transfer-channel.top_of_page"></a>TpFileTransferChannel</span></h2>
<p>TpFileTransferChannel — proxy object for a file transfer channel</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-file-transfer-channel.synopsis"></a><h2>Synopsis</h2>
<a name="TpFileTransferChannel"></a><pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
struct <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel-struct" title="struct TpFileTransferChannel">TpFileTransferChannel</a>;
struct <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannelClass" title="struct TpFileTransferChannelClass">TpFileTransferChannelClass</a>;
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="returnvalue">TpFileTransferChannel</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-new" title="tp_file_transfer_channel_new ()">tp_file_transfer_channel_new</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *immutable_properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
#define <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</a>
const <span class="returnvalue">char</span> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-mime-type" title="tp_file_transfer_channel_get_mime_type ()">tp_file_transfer_channel_get_mime_type</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#GDateTime"><span class="returnvalue">GDateTime</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-date" title="tp_file_transfer_channel_get_date ()">tp_file_transfer_channel_get_date</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-description" title="tp_file_transfer_channel_get_description ()">tp_file_transfer_channel_get_description</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-filename" title="tp_file_transfer_channel_get_filename ()">tp_file_transfer_channel_get_filename</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-size" title="tp_file_transfer_channel_get_size ()">tp_file_transfer_channel_get_size</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-transferred-bytes" title="tp_file_transfer_channel_get_transferred_bytes ()">tp_file_transfer_channel_get_transferred_bytes</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
<a class="link" href="telepathy-glib-enums.html#TpFileTransferState" title="enum TpFileTransferState"><span class="returnvalue">TpFileTransferState</span></a> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-state" title="tp_file_transfer_channel_get_state ()">tp_file_transfer_channel_get_state</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpFileTransferStateChangeReason" title="enum TpFileTransferStateChangeReason"><span class="type">TpFileTransferStateChangeReason</span></a> *reason</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-service-name" title="tp_file_transfer_channel_get_service_name ()">tp_file_transfer_channel_get_service_name</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-metadata" title="tp_file_transfer_channel_get_metadata ()">tp_file_transfer_channel_get_metadata</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-async" title="tp_file_transfer_channel_accept_file_async ()">tp_file_transfer_channel_accept_file_async</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> offset</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-finish" title="tp_file_transfer_channel_accept_file_finish ()">tp_file_transfer_channel_accept_file_finish</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-async" title="tp_file_transfer_channel_provide_file_async ()">tp_file_transfer_channel_provide_file_async</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-finish" title="tp_file_transfer_channel_provide_file_finish ()">tp_file_transfer_channel_provide_file_finish</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="telepathy-glib-proxy.html#TpProxy">TpProxy</a>
+----<a class="link" href="telepathy-glib-channel.html#TpChannel">TpChannel</a>
+----TpFileTransferChannel
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpFileTransferChannel implements
<a class="link" href="TpChannelIface.html" title="TpChannelIface">TpChannelIface</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--date" title='The "date" property'>date</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#GDateTime"><span class="type">GDateTime</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--description" title='The "description" property'>description</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--file" title='The "file" property'>file</a>" <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--filename" title='The "filename" property'>filename</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--initial-offset" title='The "initial-offset" property'>initial-offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--metadata" title='The "metadata" property'>metadata</a>" <span class="type">GHashTable_gchararray+GStrv_*</span> : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--mime-type" title='The "mime-type" property'>mime-type</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--service-name" title='The "service-name" property'>service-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--size" title='The "size" property'>size</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'>state</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
"<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--transferred-bytes" title='The "transferred-bytes" property'>transferred-bytes</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.description"></a><h2>Description</h2>
<p>
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> is a sub-class of <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> providing convenient
API to send and receive files.
</p>
<p>
The channel properties are available in
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--date" title='The "date" property'><span class="type">"date"</span></a>, <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--description" title='The "description" property'><span class="type">"description"</span></a>,
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--filename" title='The "filename" property'><span class="type">"filename"</span></a>,
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--initial-offset" title='The "initial-offset" property'><span class="type">"initial-offset"</span></a>,
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--mime-type" title='The "mime-type" property'><span class="type">"mime-type"</span></a>, <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--size" title='The "size" property'><span class="type">"size"</span></a>,
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'><span class="type">"state"</span></a>, and
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--transferred-bytes" title='The "transferred-bytes" property'><span class="type">"transferred-bytes"</span></a> GObject properties, with
accessor functions too.
</p>
<p>
To send a file to a contact, one should create a File Transfer
channel with the appropriate D-Bus properties set by specifying
their values in the channel creation method call. The file transfer
invitation will be sent to the remote contact when the channel is
created. For example:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GHashTable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">request </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="telepathy-glib-asv.html#tp-asv-new">tp_asv_new</a></span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-CHANNEL-TYPE:CAPS">TP_PROP_CHANNEL_CHANNEL_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-FILE-TRANSFER:CAPS">TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TARGET-HANDLE-TYPE:CAPS">TP_PROP_CHANNEL_TARGET_HANDLE_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT:CAPS">G_TYPE_UINT</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-enums.html#TP-HANDLE-TYPE-CONTACT:CAPS">TP_HANDLE_TYPE_CONTACT</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TARGET-ID:CAPS">TP_PROP_CHANNEL_TARGET_ID</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"foo@bar.com"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-CONTENT-TYPE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"text/plain"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-DATE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DATE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INT64:CAPS">G_TYPE_INT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">1320925992</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-DESCRIPTION:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DESCRIPTION</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">""</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-FILENAME:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_FILENAME</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"test.pdf"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-INITIAL-OFFSET:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_INITIAL_OFFSET</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT64:CAPS">G_TYPE_UINT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-SIZE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_SIZE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT64:CAPS">G_TYPE_UINT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">165710</span><span class="symbol">,</span>
<span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="usertype">TpAccountChannelRequest</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">channel_request </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="telepathy-glib-account-channel-request.html#tp-account-channel-request-new">tp_account_channel_request_new</a></span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal"> account</span><span class="symbol">,</span><span class="normal"> request</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-defs.html#TP-USER-ACTION-TIME-CURRENT-TIME:CAPS">TP_USER_ACTION_TIME_CURRENT_TIME</a></span><span class="symbol">);</span>
<span class="function"><a href="telepathy-glib-account-channel-request.html#tp-account-channel-request-create-and-handle-channel-async">tp_account_channel_request_create_and_handle_channel_async</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">channel_request</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">,</span>
<span class="normal"> create_and_handle_cb</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-unref">g_hash_table_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">request</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
Once a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> is created as a proxy to the channel
on D-Bus. The "notify::state" GObject signals on the resulting
channel should be monitored; when the channel moves to state
<a class="link" href="telepathy-glib-enums.html#TP-FILE-TRANSFER-STATE-ACCEPTED:CAPS"><code class="literal">TP_FILE_TRANSFER_STATE_ACCEPTED</code></a>,
<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-async" title="tp_file_transfer_channel_provide_file_async ()"><code class="function">tp_file_transfer_channel_provide_file_async()</code></a> should be called.
</p>
<p>
When an incoming File Transfer channel appears, one should call
<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-async" title="tp_file_transfer_channel_accept_file_async ()"><code class="function">tp_file_transfer_channel_accept_file_async()</code></a>.
</p>
<p>
To cancel or reject a pending or ongoing file transfer, one should
close the channel using <a class="link" href="telepathy-glib-channel.html#tp-channel-close-async" title="tp_channel_close_async ()"><code class="function">tp_channel_close_async()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpFileTransferChannel-struct"></a><h3>struct TpFileTransferChannel</h3>
<pre class="programlisting">struct TpFileTransferChannel;</pre>
<p>
Data structure representing a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>.
</p>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannelClass"></a><h3>struct TpFileTransferChannelClass</h3>
<pre class="programlisting">struct TpFileTransferChannelClass {
};
</pre>
<p>
The class of a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>.
</p>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-new"></a><h3>tp_file_transfer_channel_new ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="returnvalue">TpFileTransferChannel</span></a> * tp_file_transfer_channel_new (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *immutable_properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_file_transfer_channel_new</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-simple-client-factory.html#tp-simple-client-factory-ensure-channel" title="tp_simple_client_factory_ensure_channel ()"><code class="function">tp_simple_client_factory_ensure_channel()</code></a> instead.</p>
</div>
<p>
Convenient function to create a new <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>conn</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>; may not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path of the channel; may not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>immutable_properties</code></em> :</span></p></td>
<td>the immutable properties of the channel,
as signalled by the NewChannel D-Bus signal or returned by the
CreateChannel and EnsureChannel D-Bus methods: a mapping from
strings (D-Bus interface name + "." + property name) to <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> instances. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to indicate the error if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS"></a><h3>TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</h3>
<pre class="programlisting">#define TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</pre>
<p>
Expands to a call to a function that returns a quark for the "core"
feature on a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>.
</p>
<p>
When this feature is prepared, the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--transferred-bytes" title='The "transferred-bytes" property'><span class="type">"transferred-bytes"</span></a>
property has been retrieved and will be updated.
</p>
<p>
One can ask for a feature to be prepared using the <a class="link" href="telepathy-glib-proxy.html#tp-proxy-prepare-async" title="tp_proxy_prepare_async ()"><code class="function">tp_proxy_prepare_async()</code></a>
function, and waiting for it to trigger the callback.
</p>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-mime-type"></a><h3>tp_file_transfer_channel_get_mime_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * tp_file_transfer_channel_get_mime_type
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--mime-type" title='The "mime-type" property'><span class="type">"mime-type"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--mime-type" title='The "mime-type" property'><span class="type">"mime-type"</span></a> property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-date"></a><h3>tp_file_transfer_channel_get_date ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#GDateTime"><span class="returnvalue">GDateTime</span></a> * tp_file_transfer_channel_get_date (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--date" title='The "date" property'><span class="type">"date"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--date" title='The "date" property'><span class="type">"date"</span></a>
property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-description"></a><h3>tp_file_transfer_channel_get_description ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_file_transfer_channel_get_description
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--description" title='The "description" property'><span class="type">"description"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--description" title='The "description" property'><span class="type">"description"</span></a> property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-filename"></a><h3>tp_file_transfer_channel_get_filename ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_file_transfer_channel_get_filename
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--filename" title='The "filename" property'><span class="type">"filename"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--filename" title='The "filename" property'><span class="type">"filename"</span></a> property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-size"></a><h3>tp_file_transfer_channel_get_size ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> tp_file_transfer_channel_get_size (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--size" title='The "size" property'><span class="type">"size"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--size" title='The "size" property'><span class="type">"size"</span></a> property</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-transferred-bytes"></a><h3>tp_file_transfer_channel_get_transferred_bytes ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> tp_file_transfer_channel_get_transferred_bytes
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--transferred-bytes" title='The "transferred-bytes" property'><span class="type">"transferred-bytes"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--transferred-bytes" title='The "transferred-bytes" property'><span class="type">"transferred-bytes"</span></a> property</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-state"></a><h3>tp_file_transfer_channel_get_state ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-enums.html#TpFileTransferState" title="enum TpFileTransferState"><span class="returnvalue">TpFileTransferState</span></a> tp_file_transfer_channel_get_state (<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpFileTransferStateChangeReason" title="enum TpFileTransferStateChangeReason"><span class="type">TpFileTransferStateChangeReason</span></a> *reason</code></em>);</pre>
<p>
Returns the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'><span class="type">"state"</span></a> property.
</p>
<p>
If <em class="parameter"><code>reason</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> it is set to the reason why
<a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'><span class="type">"state"</span></a> changed to its current value.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>reason</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-enums.html#TpFileTransferStateChangeReason" title="enum TpFileTransferStateChangeReason"><span class="type">TpFileTransferStateChangeReason</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'><span class="type">"state"</span></a> property</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-service-name"></a><h3>tp_file_transfer_channel_get_service_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_file_transfer_channel_get_service_name
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--service-name" title='The "service-name" property'><span class="type">"service-name"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--service-name" title='The "service-name" property'><span class="type">"service-name"</span></a> property</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-get-metadata"></a><h3>tp_file_transfer_channel_get_metadata ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * tp_file_transfer_channel_get_metadata
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--metadata" title='The "metadata" property'><span class="type">"metadata"</span></a> property
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the
value of the <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--metadata" title='The "metadata" property'><span class="type">"metadata"</span></a> property. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GStrv]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-accept-file-async"></a><h3>tp_file_transfer_channel_accept_file_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tp_file_transfer_channel_accept_file_async
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> offset</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Accept an incoming file transfer in the
<a class="link" href="telepathy-glib-enums.html#TP-FILE-TRANSFER-STATE-PENDING:CAPS"><code class="literal">TP_FILE_TRANSFER_STATE_PENDING</code></a> state. Once the accept has been
processed, <em class="parameter"><code>callback</code></em> will be called. You can then call
<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-finish" title="tp_file_transfer_channel_accept_file_finish ()"><code class="function">tp_file_transfer_channel_accept_file_finish()</code></a> to get the result of
the operation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> where the file should be saved</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td>Offset from the start of <em class="parameter"><code>file</code></em> where transfer begins</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback to call when the transfer has been accepted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-accept-file-finish"></a><h3>tp_file_transfer_channel_accept_file_finish ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tp_file_transfer_channel_accept_file_finish
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Finishes a call to <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-async" title="tp_file_transfer_channel_accept_file_async ()"><code class="function">tp_file_transfer_channel_accept_file_async()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the accept operation was a success, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-provide-file-async"></a><h3>tp_file_transfer_channel_provide_file_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tp_file_transfer_channel_provide_file_async
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Provide a file transfer. This should be called when the file
transfer state changes (<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-get-state" title="tp_file_transfer_channel_get_state ()"><code class="function">tp_file_transfer_channel_get_state()</code></a> and
the "notify::state" signal) to
<a class="link" href="telepathy-glib-enums.html#TP-FILE-TRANSFER-STATE-ACCEPTED:CAPS"><code class="literal">TP_FILE_TRANSFER_STATE_ACCEPTED</code></a> or
<a class="link" href="telepathy-glib-enums.html#TP-FILE-TRANSFER-STATE-PENDING:CAPS"><code class="literal">TP_FILE_TRANSFER_STATE_PENDING</code></a>. Once the file has been provided,
the channel <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel--state" title='The "state" property'><span class="type">"state"</span></a> will change to
<a class="link" href="telepathy-glib-enums.html#TP-FILE-TRANSFER-STATE-OPEN:CAPS"><code class="literal">TP_FILE_TRANSFER_STATE_OPEN</code></a>.
</p>
<p>
Once the file has been provided, <em class="parameter"><code>callback</code></em> will be called. You
should then call <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-finish" title="tp_file_transfer_channel_provide_file_finish ()"><code class="function">tp_file_transfer_channel_provide_file_finish()</code></a> to
get the result of the operation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> to send to the remote contact</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback to call when the transfer has been accepted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-file-transfer-channel-provide-file-finish"></a><h3>tp_file_transfer_channel_provide_file_finish ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tp_file_transfer_channel_provide_file_finish
(<em class="parameter"><code><a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Finishes a call to <a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-async" title="tp_file_transfer_channel_provide_file_async ()"><code class="function">tp_file_transfer_channel_provide_file_async()</code></a>.
</p>
<p>
Successful return from this function does not mean that the file
transfer has completed or has even started at all. The state of the
file transfer should be monitored with the "notify::state" signal.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-file-transfer-channel.html#TpFileTransferChannel"><span class="type">TpFileTransferChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file has been successfully provided, or
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.17.1</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-file-transfer-channel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpFileTransferChannel--date"></a><h3>The <code class="literal">"date"</code> property</h3>
<pre class="programlisting"> "date" <a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#GDateTime"><span class="type">GDateTime</span></a>* : Read</pre>
<p>
A <a href="http://library.gnome.org/devel/glib/unstable/glib-GDateTime.html#GDateTime"><span class="type">GDateTime</span></a> representing the last modification time of the file to be
transferred.
</p>
<p>
Since 0.15.5
</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--description"></a><h3>The <code class="literal">"description"</code> property</h3>
<pre class="programlisting"> "description" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The description of the file transfer, defined by the sender when
sending the file transfer offer.
</p>
<p>
Since 0.15.5
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--file"></a><h3>The <code class="literal">"file"</code> property</h3>
<pre class="programlisting"> "file" <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a>* : Read</pre>
<p>
For incoming file transfers, this property will be set to a
<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> for the location where the file will be saved (given by
<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-accept-file-async" title="tp_file_transfer_channel_accept_file_async ()"><code class="function">tp_file_transfer_channel_accept_file_async()</code></a>) when the transfer
starts. The feature <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> must
already be prepared for this property to have a meaningful
value, and to receive change notification. Once the initial
value is set, this property will not be changed.
</p>
<p>
For outgoing file transfers, this property is a <a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="type">GFile</span></a> for the
location of the file being sent (given by
<a class="link" href="telepathy-glib-file-transfer-channel.html#tp-file-transfer-channel-provide-file-async" title="tp_file_transfer_channel_provide_file_async ()"><code class="function">tp_file_transfer_channel_provide_file_async()</code></a>). The feature
<a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> does not have to be
prepared and there is no change notification.
</p>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--filename"></a><h3>The <code class="literal">"filename"</code> property</h3>
<pre class="programlisting"> "filename" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The name of the file on the sender's side. This is therefore given as a
suggested filename for the receiver.
</p>
<p>
Since 0.15.5
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--initial-offset"></a><h3>The <code class="literal">"initial-offset"</code> property</h3>
<pre class="programlisting"> "initial-offset" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read</pre>
<p>
The offset in bytes from where the file should be sent.
</p>
<p>
The <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> feature has to be
prepared for this property to be meaningful and kept up to date.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--metadata"></a><h3>The <code class="literal">"metadata"</code> property</h3>
<pre class="programlisting"> "metadata" <span class="type">GHashTable_gchararray+GStrv_*</span> : Read</pre>
<p>
Additional information about the file transfer set by the channel
initiator, or an empty <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> if the initiator did not
provide any additional information.
</p>
<p>
To provide metadata along with a file offer, include
<a class="link" href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-INTERFACE-FILE-TRANSFER-METADATA-METADATA:CAPS" title="TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_METADATA"><code class="literal">TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_METADATA</code></a> in the
channel request. For example:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GHashTable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">request</span><span class="symbol">;</span>
<span class="usertype">GHashTable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">metadata </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-new">g_hash_table_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-str-hash">g_str_hash</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-str-equal">g_str_equal</a></span><span class="symbol">);</span>
<span class="keyword">const</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> </span><span class="symbol">*</span><span class="normal"> </span><span class="keyword">const</span><span class="normal"> values</span><span class="symbol">[]</span><span class="normal"> </span><span class="symbol">=</span><span class="normal"> </span><span class="cbracket">{</span><span class="normal"> </span><span class="string">"Jason Derulo"</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Tinie Tempah"</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a> </span><span class="cbracket">}</span><span class="symbol">;</span>
<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#g-hash-table-insert">g_hash_table_insert</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">metadata</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"best buds"</span><span class="symbol">,</span><span class="normal"> values</span><span class="symbol">);</span>
<span class="normal">request </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="telepathy-glib-asv.html#tp-asv-new">tp_asv_new</a></span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-CHANNEL-TYPE:CAPS">TP_PROP_CHANNEL_CHANNEL_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-FILE-TRANSFER:CAPS">TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TARGET-HANDLE-TYPE:CAPS">TP_PROP_CHANNEL_TARGET_HANDLE_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT:CAPS">G_TYPE_UINT</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-enums.html#TP-HANDLE-TYPE-CONTACT:CAPS">TP_HANDLE_TYPE_CONTACT</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TARGET-ID:CAPS">TP_PROP_CHANNEL_TARGET_ID</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"foo@bar.com"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-CONTENT-TYPE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"text/plain"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-DATE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DATE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-INT64:CAPS">G_TYPE_INT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">1320925992</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-DESCRIPTION:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DESCRIPTION</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">""</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-FILENAME:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_FILENAME</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"test.pdf"</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-INITIAL-OFFSET:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_INITIAL_OFFSET</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT64:CAPS">G_TYPE_UINT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TYPE-FILE-TRANSFER-SIZE:CAPS">TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_SIZE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT64:CAPS">G_TYPE_UINT64</a></span><span class="symbol">,</span><span class="normal"> </span><span class="number">165710</span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-INTERFACE-FILE-TRANSFER-METADATA-METADATA:CAPS">TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_METADATA</a></span><span class="symbol">,</span><span class="normal"> TP_TYPE_METADATA</span><span class="symbol">,</span><span class="normal"> metadata</span><span class="symbol">,</span>
<span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">);</span>
<span class="symbol">...</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
The <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> feature has to be
prepared for this property to be meaningful.
</p>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--mime-type"></a><h3>The <code class="literal">"mime-type"</code> property</h3>
<pre class="programlisting"> "mime-type" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The MIME type of the file to be transferred.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.15.5</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--service-name"></a><h3>The <code class="literal">"service-name"</code> property</h3>
<pre class="programlisting"> "service-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
A string representing the name of the service suggested to handle
this file transfer channel, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the initiator did not
provide one.
</p>
<p>
This is a useful way of requesting file transfer channels with a
hint of what handler they should be handled by on the remote
side. If a channel request is made with this property set (to a
contact who also supports the metadata extension; see the
requestable channel classes for said contact), this property will
be set to the same value on the remote incoming channel and
handlers can match on this in their handler filter. For example,
a remote handler could call the following:
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="function"><a href="telepathy-glib-base-client.html#tp-base-client-take-handler-filter">tp_base_client_take_handler_filter</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">handler</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="telepathy-glib-asv.html#tp-asv-new">tp_asv_new</a></span><span class="normal"> </span><span class="symbol">(</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-CHANNEL-TYPE:CAPS">TP_PROP_CHANNEL_CHANNEL_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-interfaces.html#TP-IFACE-CHANNEL-TYPE-FILE-TRANSFER:CAPS">TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-TARGET-HANDLE-TYPE:CAPS">TP_PROP_CHANNEL_TARGET_HANDLE_TYPE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-UINT:CAPS">G_TYPE_UINT</a></span><span class="symbol">,</span><span class="normal"> <a href="telepathy-glib-enums.html#TP-HANDLE-TYPE-CONTACT:CAPS">TP_HANDLE_TYPE_CONTACT</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-REQUESTED:CAPS">TP_PROP_CHANNEL_REQUESTED</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS">G_TYPE_BOOLEAN</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">,</span>
<span class="normal"> <a href="telepathy-glib-interfaces.html#TP-PROP-CHANNEL-INTERFACE-FILE-TRANSFER-METADATA-SERVICE-NAME:CAPS">TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_SERVICE_NAME</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#G-TYPE-STRING:CAPS">G_TYPE_STRING</a></span><span class="symbol">,</span><span class="normal"> </span><span class="string">"service.name"</span><span class="symbol">,</span>
<span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">));</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
The <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> feature has to be
prepared for this property to be meaningful.
</p>
<p>Default value: ""</p>
<p class="since">Since 0.17.1</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--size"></a><h3>The <code class="literal">"size"</code> property</h3>
<pre class="programlisting"> "size" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read</pre>
<p>
The size of the file to be transferred,
or <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#G-MAXUINT64:CAPS"><code class="literal">G_MAXUINT64</code></a> if not known.
</p>
<p>
Since 0.15.5
</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--state"></a><h3>The <code class="literal">"state"</code> property</h3>
<pre class="programlisting"> "state" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
<p>
A TpFileTransferState holding the state of the file transfer.
</p>
<p>
The <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> feature has to be
prepared for this property to be meaningful and kept up to date.
</p>
<p>
Since 0.17.1
</p>
<p>Allowed values: <= 6</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="TpFileTransferChannel--transferred-bytes"></a><h3>The <code class="literal">"transferred-bytes"</code> property</h3>
<pre class="programlisting"> "transferred-bytes" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read</pre>
<p>
The number of bytes transferred so far in this
file transfer.
</p>
<p>
The <a class="link" href="telepathy-glib-file-transfer-channel.html#TP-FILE-TRANSFER-CHANNEL-FEATURE-CORE:CAPS" title="TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE"><code class="literal">TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE</code></a> feature has to be
prepared for this property to be meaningful and kept up to date.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.15.5</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
