← Back to branch summary

~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201111172307

« back to all changes in this revision

Viewing changes to docs/reference/tmpl/svc-channel-text.sgml

  • Committer: Ken VanDine
  • Date: 2011-11-17 20:53:21 UTC
  • mfrom: (1.6.34 upstream)
  • Revision ID: ken.vandine@canonical.com-20111117205321-l704j7kr1zgw5v9h
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/tmpl/svc-channel-text.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
svc-channel-text
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
 
 
15
</para>
 
16
 
 
17
<!-- ##### SECTION Stability_Level ##### -->
 
18
 
 
19
 
 
20
<!-- ##### SECTION Image ##### -->
 
21
 
 
22
 
 
23
<!-- ##### STRUCT TpSvcChannelTypeText ##### -->
 
24
<para>
 
25
 
 
26
</para>
 
27
 
 
28
 
 
29
<!-- ##### SIGNAL TpSvcChannelTypeText::lost-message ##### -->
 
30
<para>
 
31
 
 
32
</para>
 
33
 
 
34
@tpsvcchanneltypetext: the object which received the signal.
 
35
 
 
36
<!-- ##### SIGNAL TpSvcChannelTypeText::received ##### -->
 
37
<para>
 
38
 
 
39
</para>
 
40
 
 
41
@tpsvcchanneltypetext: the object which received the signal.
 
42
@arg1: 
 
43
@arg2: 
 
44
@arg3: 
 
45
@arg4: 
 
46
@arg5: 
 
47
@arg6: 
 
48
 
 
49
<!-- ##### SIGNAL TpSvcChannelTypeText::send-error ##### -->
 
50
<para>
 
51
 
 
52
</para>
 
53
 
 
54
@tpsvcchanneltypetext: the object which received the signal.
 
55
@arg1: 
 
56
@arg2: 
 
57
@arg3: 
 
58
@arg4: 
 
59
 
 
60
<!-- ##### SIGNAL TpSvcChannelTypeText::sent ##### -->
 
61
<para>
 
62
 
 
63
</para>
 
64
 
 
65
@tpsvcchanneltypetext: the object which received the signal.
 
66
@arg1: 
 
67
@arg2: 
 
68
@arg3: 
 
69
 
 
70
<!-- ##### STRUCT TpSvcChannelTypeTextClass ##### -->
 
71
<para>
 
72
 
 
73
</para>
 
74
 
 
75
 
 
76
<!-- ##### USER_FUNCTION tp_svc_channel_type_text_acknowledge_pending_messages_impl ##### -->
 
77
<para>
 
78
 
 
79
</para>
 
80
 
 
81
@self: 
 
82
@in_IDs: 
 
83
@context: 
 
84
 
 
85
 
 
86
<!-- ##### FUNCTION tp_svc_channel_type_text_implement_acknowledge_pending_messages ##### -->
 
87
<para>
 
88
 
 
89
</para>
 
90
 
 
91
@klass: 
 
92
@impl: 
 
93
 
 
94
 
 
95
<!-- ##### FUNCTION tp_svc_channel_type_text_return_from_acknowledge_pending_messages ##### -->
 
96
<para>
 
97
 
 
98
</para>
 
99
 
 
100
@context: 
 
101
 
 
102
 
 
103
<!-- ##### USER_FUNCTION tp_svc_channel_type_text_get_message_types_impl ##### -->
 
104
<para>
 
105
 
 
106
</para>
 
107
 
 
108
@self: 
 
109
@context: 
 
110
 
 
111
 
 
112
<!-- ##### FUNCTION tp_svc_channel_type_text_implement_get_message_types ##### -->
 
113
<para>
 
114
 
 
115
</para>
 
116
 
 
117
@klass: 
 
118
@impl: 
 
119
 
 
120
 
 
121
<!-- ##### FUNCTION tp_svc_channel_type_text_return_from_get_message_types ##### -->
 
122
<para>
 
123
 
 
124
</para>
 
125
 
 
126
@context: 
 
127
@out_Available_Types: 
 
128
 
 
129
 
 
130
<!-- ##### USER_FUNCTION tp_svc_channel_type_text_list_pending_messages_impl ##### -->
 
131
<para>
 
132
 
 
133
</para>
 
134
 
 
135
@self: 
 
136
@in_Clear: 
 
137
@context: 
 
138
 
 
139
 
 
140
<!-- ##### FUNCTION tp_svc_channel_type_text_implement_list_pending_messages ##### -->
 
141
<para>
 
142
 
 
143
</para>
 
144
 
 
145
@klass: 
 
146
@impl: 
 
147
 
 
148
 
 
149
<!-- ##### FUNCTION tp_svc_channel_type_text_return_from_list_pending_messages ##### -->
 
150
<para>
 
151
 
 
152
</para>
 
153
 
 
154
@context: 
 
155
@out_Pending_Messages: 
 
156
 
 
157
 
 
158
<!-- ##### USER_FUNCTION tp_svc_channel_type_text_send_impl ##### -->
 
159
<para>
 
160
 
 
161
</para>
 
162
 
 
163
@self: 
 
164
@in_Type: 
 
165
@in_Text: 
 
166
@context: 
 
167
 
 
168
 
 
169
<!-- ##### FUNCTION tp_svc_channel_type_text_implement_send ##### -->
 
170
<para>
 
171
 
 
172
</para>
 
173
 
 
174
@klass: 
 
175
@impl: 
 
176
 
 
177
 
 
178
<!-- ##### FUNCTION tp_svc_channel_type_text_return_from_send ##### -->
 
179
<para>
 
180
 
 
181
</para>
 
182
 
 
183
@context: 
 
184
 
 
185
 
 
186
<!-- ##### FUNCTION tp_svc_channel_type_text_emit_lost_message ##### -->
 
187
<para>
 
188
 
 
189
</para>
 
190
 
 
191
@instance: 
 
192
 
 
193
 
 
194
<!-- ##### FUNCTION tp_svc_channel_type_text_emit_received ##### -->
 
195
<para>
 
196
 
 
197
</para>
 
198
 
 
199
@instance: 
 
200
@arg_ID: 
 
201
@arg_Timestamp: 
 
202
@arg_Sender: 
 
203
@arg_Type: 
 
204
@arg_Flags: 
 
205
@arg_Text: 
 
206
 
 
207
 
 
208
<!-- ##### FUNCTION tp_svc_channel_type_text_emit_send_error ##### -->
 
209
<para>
 
210
 
 
211
</para>
 
212
 
 
213
@instance: 
 
214
@arg_Error: 
 
215
@arg_Timestamp: 
 
216
@arg_Type: 
 
217
@arg_Text: 
 
218
 
 
219
 
 
220
<!-- ##### FUNCTION tp_svc_channel_type_text_emit_sent ##### -->
 
221
<para>
 
222
 
 
223
</para>
 
224
 
 
225
@instance: 
 
226
@arg_Timestamp: 
 
227
@arg_Type: 
 
228
@arg_Text: 
 
229
 
 
230
 
 
231
<!-- ##### STRUCT TpSvcChannelInterfaceChatState ##### -->
 
232
<para>
 
233
 
 
234
</para>
 
235
 
 
236
 
 
237
<!-- ##### SIGNAL TpSvcChannelInterfaceChatState::chat-state-changed ##### -->
 
238
<para>
 
239
 
 
240
</para>
 
241
 
 
242
@tpsvcchannelinterfacechatstate: the object which received the signal.
 
243
@arg1: 
 
244
@arg2: 
 
245
 
 
246
<!-- ##### STRUCT TpSvcChannelInterfaceChatStateClass ##### -->
 
247
<para>
 
248
 
 
249
</para>
 
250
 
 
251
 
 
252
<!-- ##### USER_FUNCTION tp_svc_channel_interface_chat_state_set_chat_state_impl ##### -->
 
253
<para>
 
254
 
 
255
</para>
 
256
 
 
257
@self: 
 
258
@in_State: 
 
259
@context: 
 
260
 
 
261
 
 
262
<!-- ##### FUNCTION tp_svc_channel_interface_chat_state_implement_set_chat_state ##### -->
 
263
<para>
 
264
 
 
265
</para>
 
266
 
 
267
@klass: 
 
268
@impl: 
 
269
 
 
270
 
 
271
<!-- ##### FUNCTION tp_svc_channel_interface_chat_state_return_from_set_chat_state ##### -->
 
272
<para>
 
273
 
 
274
</para>
 
275
 
 
276
@context: 
 
277
 
 
278
 
 
279
<!-- ##### FUNCTION tp_svc_channel_interface_chat_state_emit_chat_state_changed ##### -->
 
280
<para>
 
281
 
 
282
</para>
 
283
 
 
284
@instance: 
 
285
@arg_Contact: 
 
286
@arg_State: 
 
287
 
 
288
 
 
289
<!-- ##### STRUCT TpSvcChannelInterfaceMessages ##### -->
 
290
<para>
 
291
 
 
292
</para>
 
293
 
 
294
 
 
295
<!-- ##### SIGNAL TpSvcChannelInterfaceMessages::message-received ##### -->
 
296
<para>
 
297
 
 
298
</para>
 
299
 
 
300
@tpsvcchannelinterfacemessages: the object which received the signal.
 
301
 
 
302
<!-- ##### SIGNAL TpSvcChannelInterfaceMessages::message-sent ##### -->
 
303
<para>
 
304
 
 
305
</para>
 
306
 
 
307
@tpsvcchannelinterfacemessages: the object which received the signal.
 
308
@Param4: 
 
309
@Param4: 
 
310
 
 
311
<!-- ##### SIGNAL TpSvcChannelInterfaceMessages::pending-messages-removed ##### -->
 
312
<para>
 
313
 
 
314
</para>
 
315
 
 
316
@tpsvcchannelinterfacemessages: the object which received the signal.
 
317
@arg1: 
 
318
 
 
319
<!-- ##### STRUCT TpSvcChannelInterfaceMessagesClass ##### -->
 
320
<para>
 
321
 
 
322
</para>
 
323
 
 
324
 
 
325
<!-- ##### FUNCTION tp_svc_channel_interface_messages_emit_message_received ##### -->
 
326
<para>
 
327
 
 
328
</para>
 
329
 
 
330
@instance: 
 
331
@arg_Message: 
 
332
 
 
333
 
 
334
<!-- ##### FUNCTION tp_svc_channel_interface_messages_emit_message_sent ##### -->
 
335
<para>
 
336
 
 
337
</para>
 
338
 
 
339
@instance: 
 
340
@arg_Content: 
 
341
@arg_Flags: 
 
342
@arg_Message_Token: 
 
343
 
 
344
 
 
345
<!-- ##### FUNCTION tp_svc_channel_interface_messages_emit_pending_messages_removed ##### -->
 
346
<para>
 
347
 
 
348
</para>
 
349
 
 
350
@instance: 
 
351
@arg_Message_IDs: 
 
352
 
 
353
 
 
354
<!-- ##### USER_FUNCTION tp_svc_channel_interface_messages_get_pending_message_content_impl ##### -->
 
355
<para>
 
356
 
 
357
</para>
 
358
 
 
359
@self: 
 
360
@in_Message_ID: 
 
361
@in_Parts: 
 
362
@context: 
 
363
 
 
364
 
 
365
<!-- ##### FUNCTION tp_svc_channel_interface_messages_implement_get_pending_message_content ##### -->
 
366
<para>
 
367
 
 
368
</para>
 
369
 
 
370
@klass: 
 
371
@impl: 
 
372
 
 
373
 
 
374
<!-- ##### FUNCTION tp_svc_channel_interface_messages_implement_send_message ##### -->
 
375
<para>
 
376
 
 
377
</para>
 
378
 
 
379
@klass: 
 
380
@impl: 
 
381
 
 
382
 
 
383
<!-- ##### FUNCTION tp_svc_channel_interface_messages_return_from_get_pending_message_content ##### -->
 
384
<para>
 
385
 
 
386
</para>
 
387
 
 
388
@context: 
 
389
@out_Content: 
 
390
 
 
391
 
 
392
<!-- ##### FUNCTION tp_svc_channel_interface_messages_return_from_send_message ##### -->
 
393
<para>
 
394
 
 
395
</para>
 
396
 
 
397
@context: 
 
398
@out_Token: 
 
399
 
 
400
 
 
401
<!-- ##### USER_FUNCTION tp_svc_channel_interface_messages_send_message_impl ##### -->
 
402
<para>
 
403
 
 
404
</para>
 
405
 
 
406
@self: 
 
407
@in_Message: 
 
408
@in_Flags: 
 
409
@context: 
 
410
 
 
411
 
 
412
<!-- ##### STRUCT TpSvcChannelInterfacePassword ##### -->
 
413
<para>
 
414
 
 
415
</para>
 
416
 
 
417
 
 
418
<!-- ##### SIGNAL TpSvcChannelInterfacePassword::password-flags-changed ##### -->
 
419
<para>
 
420
 
 
421
</para>
 
422
 
 
423
@tpsvcchannelinterfacepassword: the object which received the signal.
 
424
@arg1: 
 
425
@arg2: 
 
426
 
 
427
<!-- ##### STRUCT TpSvcChannelInterfacePasswordClass ##### -->
 
428
<para>
 
429
 
 
430
</para>
 
431
 
 
432
 
 
433
<!-- ##### USER_FUNCTION tp_svc_channel_interface_password_get_password_flags_impl ##### -->
 
434
<para>
 
435
 
 
436
</para>
 
437
 
 
438
@self: 
 
439
@context: 
 
440
 
 
441
 
 
442
<!-- ##### FUNCTION tp_svc_channel_interface_password_implement_get_password_flags ##### -->
 
443
<para>
 
444
 
 
445
</para>
 
446
 
 
447
@klass: 
 
448
@impl: 
 
449
 
 
450
 
 
451
<!-- ##### FUNCTION tp_svc_channel_interface_password_return_from_get_password_flags ##### -->
 
452
<para>
 
453
 
 
454
</para>
 
455
 
 
456
@context: 
 
457
@out_Password_Flags: 
 
458
 
 
459
 
 
460
<!-- ##### USER_FUNCTION tp_svc_channel_interface_password_provide_password_impl ##### -->
 
461
<para>
 
462
 
 
463
</para>
 
464
 
 
465
@self: 
 
466
@in_Password: 
 
467
@context: 
 
468
 
 
469
 
 
470
<!-- ##### FUNCTION tp_svc_channel_interface_password_implement_provide_password ##### -->
 
471
<para>
 
472
 
 
473
</para>
 
474
 
 
475
@klass: 
 
476
@impl: 
 
477
 
 
478
 
 
479
<!-- ##### FUNCTION tp_svc_channel_interface_password_return_from_provide_password ##### -->
 
480
<para>
 
481
 
 
482
</para>
 
483
 
 
484
@context: 
 
485
@out_Correct: 
 
486
 
 
487
 
 
488
<!-- ##### FUNCTION tp_svc_channel_interface_password_emit_password_flags_changed ##### -->
 
489
<para>
 
490
 
 
491
</para>
 
492
 
 
493
@instance: 
 
494
@arg_Added: 
 
495
@arg_Removed: 
 
496
 
 
497
 
 
498
<!-- ##### STRUCT TpSvcChannelInterfaceSMS ##### -->
 
499
<para>
 
500
 
 
501
</para>
 
502
 
 
503
 
 
504
<!-- ##### SIGNAL TpSvcChannelInterfaceSMS::s-ms-channel-changed ##### -->
 
505
<para>
 
506
 
 
507
</para>
 
508
 
 
509
@tpsvcchannelinterfacesms: the object which received the signal.
 
510
@arg1: 
 
511
 
 
512
<!-- ##### STRUCT TpSvcChannelInterfaceSMSClass ##### -->
 
513
<para>
 
514
 
 
515
</para>
 
516
 
 
517
 
 
518
<!-- ##### FUNCTION tp_svc_channel_interface_sms_emit_sms_channel_changed ##### -->
 
519
<para>
 
520
 
 
521
</para>
 
522
 
 
523
@instance: 
 
524
@arg_SMSChannel: 
 
525
 
 
526
 
 
527
<!-- ##### USER_FUNCTION tp_svc_channel_interface_sms_get_sms_length_impl ##### -->
 
528
<para>
 
529
 
 
530
</para>
 
531
 
 
532
@self: 
 
533
@in_Message: 
 
534
@context: 
 
535
 
 
536
 
 
537
<!-- ##### FUNCTION tp_svc_channel_interface_sms_implement_get_sms_length ##### -->
 
538
<para>
 
539
 
 
540
</para>
 
541
 
 
542
@klass: 
 
543
@impl: 
 
544
 
 
545
 
 
546
<!-- ##### FUNCTION tp_svc_channel_interface_sms_return_from_get_sms_length ##### -->
 
547
<para>
 
548
 
 
549
</para>
 
550
 
 
551
@context: 
 
552
@out_Chunks_Required: 
 
553
@out_Remaining_Characters: 
 
554
@out_Estimated_Cost: 
 
555
 
 
556