← Back to branch summary

~ubuntu-branches/ubuntu/natty/empathy/natty-updates

« back to all changes in this revision

Viewing changes to docs/libempathy/html/EmpathyMessage.html

  • Committer: Bazaar Package Importer
  • Author(s): Sjoerd Simons
  • Date: 2008-03-10 16:39:07 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20080310163907-tv41g2zmf0qqgi85
Tags: 0.22.0-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libempathy/html/EmpathyMessage.html
7
7
<link rel="start" href="index.html" title="libempathy Reference Manual">
8
8
<link rel="up" href="libempathy_api.html" title="libempathy API reference">
9
9
<link rel="prev" href="EmpathyLogManager.html" title="EmpathyLogManager">
10
 
<link rel="next" href="libempathy-empathy-time.html" title="empathy-time">
 
10
<link rel="next" href="libempathy-empathy-status-presets.html" title="empathy-status-presets">
11
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="pt01.html" title="Part&#160;I.&#160;libempathy Overview">
23
23
<td><a accesskey="u" href="libempathy_api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
24
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
25
25
<th width="100%" align="center">libempathy Reference Manual</th>
26
 
<td><a accesskey="n" href="libempathy-empathy-time.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
26
<td><a accesskey="n" href="libempathy-empathy-status-presets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
27
</tr>
28
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id366925" class="shortcut">Top</a>
29
 
                  &#160;|&#160;
30
 
                  <a href="#id391854" class="shortcut">Description</a>
31
 
                  &#160;|&#160;
32
 
                  <a href="#id388821" class="shortcut">Object Hierarchy</a>
33
 
                  &#160;|&#160;
34
 
                  <a href="#id388845" class="shortcut">Properties</a></nobr></td></tr>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id344540" class="shortcut">Top</a>
 
29
                  &#160;|&#160;
 
30
                  <a href="#id395810" class="shortcut">Description</a>
 
31
                  &#160;|&#160;
 
32
                  <a href="#id345100" class="shortcut">Object Hierarchy</a>
 
33
                  &#160;|&#160;
 
34
                  <a href="#id345124" class="shortcut">Properties</a></nobr></td></tr>
35
35
</table>
36
36
<div class="refentry" lang="en">
37
37
<a name="EmpathyMessage"></a><div class="titlepage"></div>
38
38
<div class="refnamediv"><table width="100%"><tr>
39
39
<td valign="top">
40
40
<h2>
41
 
<a name="id366925"></a><span class="refentrytitle">EmpathyMessage</span>
 
41
<a name="id344540"></a><span class="refentrytitle">EmpathyMessage</span>
42
42
</h2>
43
43
<p>EmpathyMessage</p>
44
44
</td>
68
68
time_t              <a class="link" href="EmpathyMessage.html#empathy-message-get-timestamp">empathy_message_get_timestamp</a>       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);
69
69
void                <a class="link" href="EmpathyMessage.html#empathy-message-set-timestamp">empathy_message_set_timestamp</a>       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
70
70
                                                         time_t timestamp);
 
71
GDate*              <a class="link" href="EmpathyMessage.html#empathy-message-get-date-and-time">empathy_message_get_date_and_time</a>   (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
72
                                                         time_t *timestamp);
71
73
<a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a>  <a class="link" href="EmpathyMessage.html#empathy-message-type-from-str">empathy_message_type_from_str</a>       (const gchar *type_str);
72
74
const gchar*        <a class="link" href="EmpathyMessage.html#empathy-message-type-to-str">empathy_message_type_to_str</a>         (<a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a> type);
73
75
 
74
76
</pre>
75
77
</div>
76
78
<div class="refsect1" lang="en">
77
 
<a name="id388821"></a><h2>Object Hierarchy</h2>
 
79
<a name="id345100"></a><h2>Object Hierarchy</h2>
78
80
<pre class="synopsis">
79
81
 
80
82
  GObject
82
84
</pre>
83
85
</div>
84
86
<div class="refsect1" lang="en">
85
 
<a name="id388845"></a><h2>Properties</h2>
 
87
<a name="id345124"></a><h2>Properties</h2>
86
88
<pre class="synopsis">
87
89
 
88
90
  "<a class="link" href="EmpathyMessage.html#EmpathyMessage--body">body</a>"                     gchararray            : Read / Write
93
95
</pre>
94
96
</div>
95
97
<div class="refsect1" lang="en">
96
 
<a name="id391854"></a><h2>Description</h2>
 
98
<a name="id395810"></a><h2>Description</h2>
97
99
<p>
98
100
 
99
101
</p>
100
102
</div>
101
103
<div class="refsect1" lang="en">
102
 
<a name="id391870"></a><h2>Details</h2>
 
104
<a name="id395826"></a><h2>Details</h2>
103
105
<div class="refsect2" lang="en">
104
 
<a name="id391880"></a><h3>
 
106
<a name="id395836"></a><h3>
105
107
<a name="EmpathyMessage-struct"></a>EmpathyMessage</h3>
106
 
<a class="indexterm" name="id391892"></a><pre class="programlisting">typedef struct _EmpathyMessage EmpathyMessage;</pre>
 
108
<a class="indexterm" name="id395848"></a><pre class="programlisting">typedef struct _EmpathyMessage EmpathyMessage;</pre>
107
109
<p>
108
110
 
109
111
</p>
110
112
</div>
111
113
<hr>
112
114
<div class="refsect2" lang="en">
113
 
<a name="id391907"></a><h3>
 
115
<a name="id395863"></a><h3>
114
116
<a name="EmpathyMessageType"></a>enum EmpathyMessageType</h3>
115
 
<a class="indexterm" name="id391919"></a><pre class="programlisting">typedef enum {
 
117
<a class="indexterm" name="id395875"></a><pre class="programlisting">typedef enum {
116
118
        EMPATHY_MESSAGE_TYPE_NORMAL,
117
119
        EMPATHY_MESSAGE_TYPE_ACTION,
118
120
        EMPATHY_MESSAGE_TYPE_NOTICE,
126
128
</div>
127
129
<hr>
128
130
<div class="refsect2" lang="en">
129
 
<a name="id391936"></a><h3>
 
131
<a name="id395892"></a><h3>
130
132
<a name="empathy-message-get-gtype"></a>empathy_message_get_gtype ()</h3>
131
 
<a class="indexterm" name="id391949"></a><pre class="programlisting">GType               empathy_message_get_gtype           (void);</pre>
 
133
<a class="indexterm" name="id395905"></a><pre class="programlisting">GType               empathy_message_get_gtype           (void);</pre>
132
134
<p>
133
135
 
134
136
</p>
145
147
</div>
146
148
<hr>
147
149
<div class="refsect2" lang="en">
148
 
<a name="id391984"></a><h3>
 
150
<a name="id395940"></a><h3>
149
151
<a name="empathy-message-new"></a>empathy_message_new ()</h3>
150
 
<a class="indexterm" name="id391996"></a><pre class="programlisting"><a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a>*     empathy_message_new                 (const gchar *body);</pre>
 
152
<a class="indexterm" name="id395952"></a><pre class="programlisting"><a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a>*     empathy_message_new                 (const gchar *body);</pre>
151
153
<p>
152
154
 
153
155
</p>
171
173
</div>
172
174
<hr>
173
175
<div class="refsect2" lang="en">
174
 
<a name="id392052"></a><h3>
 
176
<a name="id396008"></a><h3>
175
177
<a name="empathy-message-set-type"></a>empathy_message_set_type ()</h3>
176
 
<a class="indexterm" name="id392064"></a><pre class="programlisting">void                empathy_message_set_type            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
178
<a class="indexterm" name="id396020"></a><pre class="programlisting">void                empathy_message_set_type            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
177
179
                                                         <a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a> type);</pre>
178
180
<p>
179
181
 
198
200
</div>
199
201
<hr>
200
202
<div class="refsect2" lang="en">
201
 
<a name="id392129"></a><h3>
 
203
<a name="id396085"></a><h3>
202
204
<a name="empathy-message-get-sender"></a>empathy_message_get_sender ()</h3>
203
 
<a class="indexterm" name="id392141"></a><pre class="programlisting"><a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>*     empathy_message_get_sender          (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
 
205
<a class="indexterm" name="id396097"></a><pre class="programlisting"><a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>*     empathy_message_get_sender          (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
204
206
<p>
205
207
 
206
208
</p>
224
226
</div>
225
227
<hr>
226
228
<div class="refsect2" lang="en">
227
 
<a name="id392197"></a><h3>
 
229
<a name="id396153"></a><h3>
228
230
<a name="empathy-message-set-sender"></a>empathy_message_set_sender ()</h3>
229
 
<a class="indexterm" name="id392209"></a><pre class="programlisting">void                empathy_message_set_sender          (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
231
<a class="indexterm" name="id396165"></a><pre class="programlisting">void                empathy_message_set_sender          (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
230
232
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact);</pre>
231
233
<p>
232
234
 
251
253
</div>
252
254
<hr>
253
255
<div class="refsect2" lang="en">
254
 
<a name="id392274"></a><h3>
 
256
<a name="id396230"></a><h3>
255
257
<a name="empathy-message-get-receiver"></a>empathy_message_get_receiver ()</h3>
256
 
<a class="indexterm" name="id392287"></a><pre class="programlisting"><a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>*     empathy_message_get_receiver        (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
 
258
<a class="indexterm" name="id396243"></a><pre class="programlisting"><a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>*     empathy_message_get_receiver        (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
257
259
<p>
258
260
 
259
261
</p>
277
279
</div>
278
280
<hr>
279
281
<div class="refsect2" lang="en">
280
 
<a name="id392342"></a><h3>
 
282
<a name="id396298"></a><h3>
281
283
<a name="empathy-message-set-receiver"></a>empathy_message_set_receiver ()</h3>
282
 
<a class="indexterm" name="id392355"></a><pre class="programlisting">void                empathy_message_set_receiver        (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
284
<a class="indexterm" name="id396311"></a><pre class="programlisting">void                empathy_message_set_receiver        (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
283
285
                                                         <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a> *contact);</pre>
284
286
<p>
285
287
 
304
306
</div>
305
307
<hr>
306
308
<div class="refsect2" lang="en">
307
 
<a name="id392420"></a><h3>
 
309
<a name="id396376"></a><h3>
308
310
<a name="empathy-message-get-body"></a>empathy_message_get_body ()</h3>
309
 
<a class="indexterm" name="id392432"></a><pre class="programlisting">const gchar*        empathy_message_get_body            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
 
311
<a class="indexterm" name="id396388"></a><pre class="programlisting">const gchar*        empathy_message_get_body            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
310
312
<p>
311
313
 
312
314
</p>
330
332
</div>
331
333
<hr>
332
334
<div class="refsect2" lang="en">
333
 
<a name="id392489"></a><h3>
 
335
<a name="id396445"></a><h3>
334
336
<a name="empathy-message-set-body"></a>empathy_message_set_body ()</h3>
335
 
<a class="indexterm" name="id392501"></a><pre class="programlisting">void                empathy_message_set_body            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
337
<a class="indexterm" name="id396457"></a><pre class="programlisting">void                empathy_message_set_body            (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
336
338
                                                         const gchar *body);</pre>
337
339
<p>
338
340
 
357
359
</div>
358
360
<hr>
359
361
<div class="refsect2" lang="en">
360
 
<a name="id392566"></a><h3>
 
362
<a name="id396522"></a><h3>
361
363
<a name="empathy-message-get-timestamp"></a>empathy_message_get_timestamp ()</h3>
362
 
<a class="indexterm" name="id392579"></a><pre class="programlisting">time_t              empathy_message_get_timestamp       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
 
364
<a class="indexterm" name="id396535"></a><pre class="programlisting">time_t              empathy_message_get_timestamp       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message);</pre>
363
365
<p>
364
366
 
365
367
</p>
383
385
</div>
384
386
<hr>
385
387
<div class="refsect2" lang="en">
386
 
<a name="id392634"></a><h3>
 
388
<a name="id396590"></a><h3>
387
389
<a name="empathy-message-set-timestamp"></a>empathy_message_set_timestamp ()</h3>
388
 
<a class="indexterm" name="id392647"></a><pre class="programlisting">void                empathy_message_set_timestamp       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
390
<a class="indexterm" name="id396603"></a><pre class="programlisting">void                empathy_message_set_timestamp       (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
389
391
                                                         time_t timestamp);</pre>
390
392
<p>
391
393
 
410
412
</div>
411
413
<hr>
412
414
<div class="refsect2" lang="en">
413
 
<a name="id392712"></a><h3>
 
415
<a name="id396668"></a><h3>
 
416
<a name="empathy-message-get-date-and-time"></a>empathy_message_get_date_and_time ()</h3>
 
417
<a class="indexterm" name="id396680"></a><pre class="programlisting">GDate*              empathy_message_get_date_and_time   (<a class="link" href="EmpathyMessage.html" title="EmpathyMessage">EmpathyMessage</a> *message,
 
418
                                                         time_t *timestamp);</pre>
 
419
<p>
 
420
 
 
421
</p>
 
422
<div class="variablelist"><table border="0">
 
423
<col align="left" valign="top">
 
424
<tbody>
 
425
<tr>
 
426
<td><p><span class="term"><em class="parameter"><code>message</code></em>&#160;:</span></p></td>
 
427
<td>
 
428
</td>
 
429
</tr>
 
430
<tr>
 
431
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em>&#160;:</span></p></td>
 
432
<td>
 
433
</td>
 
434
</tr>
 
435
<tr>
 
436
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
437
<td>
 
438
 
 
439
 
 
440
</td>
 
441
</tr>
 
442
</tbody>
 
443
</table></div>
 
444
</div>
 
445
<hr>
 
446
<div class="refsect2" lang="en">
 
447
<a name="id396756"></a><h3>
414
448
<a name="empathy-message-type-from-str"></a>empathy_message_type_from_str ()</h3>
415
 
<a class="indexterm" name="id392724"></a><pre class="programlisting"><a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a>  empathy_message_type_from_str       (const gchar *type_str);</pre>
 
449
<a class="indexterm" name="id396768"></a><pre class="programlisting"><a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a>  empathy_message_type_from_str       (const gchar *type_str);</pre>
416
450
<p>
417
451
 
418
452
</p>
436
470
</div>
437
471
<hr>
438
472
<div class="refsect2" lang="en">
439
 
<a name="id392780"></a><h3>
 
473
<a name="id396824"></a><h3>
440
474
<a name="empathy-message-type-to-str"></a>empathy_message_type_to_str ()</h3>
441
 
<a class="indexterm" name="id392792"></a><pre class="programlisting">const gchar*        empathy_message_type_to_str         (<a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a> type);</pre>
 
475
<a class="indexterm" name="id396836"></a><pre class="programlisting">const gchar*        empathy_message_type_to_str         (<a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a> type);</pre>
442
476
<p>
443
477
 
444
478
</p>
462
496
</div>
463
497
</div>
464
498
<div class="refsect1" lang="en">
465
 
<a name="id392850"></a><h2>Property Details</h2>
 
499
<a name="id396894"></a><h2>Property Details</h2>
466
500
<div class="refsect2" lang="en">
467
 
<a name="id392861"></a><h3>
 
501
<a name="id396905"></a><h3>
468
502
<a name="EmpathyMessage--body"></a>The <code class="literal">"body"</code> property</h3>
469
 
<a class="indexterm" name="id392875"></a><pre class="programlisting">  "body"                     gchararray            : Read / Write</pre>
 
503
<a class="indexterm" name="id396919"></a><pre class="programlisting">  "body"                     gchararray            : Read / Write</pre>
470
504
<p>The content of the message.</p>
471
505
<p>Default value: NULL</p>
472
506
</div>
473
507
<hr>
474
508
<div class="refsect2" lang="en">
475
 
<a name="id392901"></a><h3>
 
509
<a name="id396945"></a><h3>
476
510
<a name="EmpathyMessage--receiver"></a>The <code class="literal">"receiver"</code> property</h3>
477
 
<a class="indexterm" name="id392916"></a><pre class="programlisting">  "receiver"                 <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>        : Read / Write</pre>
 
511
<a class="indexterm" name="id396960"></a><pre class="programlisting">  "receiver"                 <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>        : Read / Write</pre>
478
512
<p>The receiver of the message.</p>
479
513
</div>
480
514
<hr>
481
515
<div class="refsect2" lang="en">
482
 
<a name="id392937"></a><h3>
 
516
<a name="id396981"></a><h3>
483
517
<a name="EmpathyMessage--sender"></a>The <code class="literal">"sender"</code> property</h3>
484
 
<a class="indexterm" name="id392952"></a><pre class="programlisting">  "sender"                   <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>        : Read / Write</pre>
 
518
<a class="indexterm" name="id396996"></a><pre class="programlisting">  "sender"                   <a class="link" href="EmpathyContact.html" title="EmpathyContact">EmpathyContact</a>        : Read / Write</pre>
485
519
<p>The sender of the message.</p>
486
520
</div>
487
521
<hr>
488
522
<div class="refsect2" lang="en">
489
 
<a name="id392973"></a><h3>
 
523
<a name="id397017"></a><h3>
490
524
<a name="EmpathyMessage--timestamp"></a>The <code class="literal">"timestamp"</code> property</h3>
491
 
<a class="indexterm" name="id392988"></a><pre class="programlisting">  "timestamp"                glong                 : Read / Write</pre>
 
525
<a class="indexterm" name="id397032"></a><pre class="programlisting">  "timestamp"                glong                 : Read / Write</pre>
492
526
<p>timestamp.</p>
493
527
<p>Allowed values: &gt;= G_MAXULONG</p>
494
528
<p>Default value: -1</p>
495
529
</div>
496
530
<hr>
497
531
<div class="refsect2" lang="en">
498
 
<a name="id393018"></a><h3>
 
532
<a name="id397062"></a><h3>
499
533
<a name="EmpathyMessage--type"></a>The <code class="literal">"type"</code> property</h3>
500
 
<a class="indexterm" name="id393032"></a><pre class="programlisting">  "type"                     <a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a>    : Read / Write</pre>
 
534
<a class="indexterm" name="id397076"></a><pre class="programlisting">  "type"                     <a class="link" href="EmpathyMessage.html#EmpathyMessageType">EmpathyMessageType</a>    : Read / Write</pre>
501
535
<p>The type of message.</p>
502
536
<p>Default value: EMPATHY_MESSAGE_TYPE_NORMAL</p>
503
537
</div>
504
538
</div>
505
539
<div class="refsect1" lang="en">
506
 
<a name="id393058"></a><div class="refsect2" lang="en"><a name="id393059"></a></div>
 
540
<a name="id397102"></a><div class="refsect2" lang="en"><a name="id397103"></a></div>
507
541
<hr>
508
 
<div class="refsect2" lang="en"><a name="id393060"></a></div>
 
542
<div class="refsect2" lang="en"><a name="id397104"></a></div>
509
543
</div>
510
544
</div>
511
545
</body>