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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpClientMessage</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-automatic-client-factory.html" title="TpAutomaticClientFactory">
<link rel="next" href="TpSignalledMessage.html" title="TpSignalledMessage">
<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-automatic-client-factory.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="TpSignalledMessage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TpClientMessage.synopsis" class="shortcut">Top</a>
|
<a href="#TpClientMessage.description" class="shortcut">Description</a>
|
<a href="#TpClientMessage.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpClientMessage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpClientMessage.top_of_page"></a>TpClientMessage</span></h2>
<p>TpClientMessage — a message in the Telepathy message interface, client side</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpClientMessage.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="TpClientMessage.html#TpClientMessage-struct" title="TpClientMessage">TpClientMessage</a>;
<a class="link" href="TpMessage.html" title="TpMessage"><span class="returnvalue">TpMessage</span></a> * <a class="link" href="TpClientMessage.html#tp-client-message-new" title="tp_client_message_new ()">tp_client_message_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="TpMessage.html" title="TpMessage"><span class="returnvalue">TpMessage</span></a> * <a class="link" href="TpClientMessage.html#tp-client-message-new-text" title="tp_client_message_new_text ()">tp_client_message_new_text</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</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> *text</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="TpClientMessage.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="TpMessage.html" title="TpMessage">TpMessage</a>
+----TpClientMessage
</pre>
</div>
<div class="refsect1">
<a name="TpClientMessage.description"></a><h2>Description</h2>
<p>
<a class="link" href="TpClientMessage.html" title="TpClientMessage"><span class="type">TpClientMessage</span></a> is used within Telepathy clients to represent a
message composed by a client, which it will send using the
Messages interface.
Its subclass <a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a> represents messages as signalled by a
connection manager.
</p>
</div>
<div class="refsect1">
<a name="TpClientMessage.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpClientMessage-struct"></a><h3>TpClientMessage</h3>
<pre class="programlisting">typedef struct _TpClientMessage TpClientMessage;</pre>
<p>
Opaque structure representing a message in the Telepathy messages interface
(client side).
</p>
<p class="since">Since 0.13.9</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-client-message-new"></a><h3>tp_client_message_new ()</h3>
<pre class="programlisting"><a class="link" href="TpMessage.html" title="TpMessage"><span class="returnvalue">TpMessage</span></a> * tp_client_message_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
A convenient function to create a new <a class="link" href="TpClientMessage.html" title="TpClientMessage"><span class="type">TpClientMessage</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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="TpClientMessage.html" title="TpClientMessage"><span class="type">TpClientMessage</span></a> having only
the header part. <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.13.9</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-client-message-new-text"></a><h3>tp_client_message_new_text ()</h3>
<pre class="programlisting"><a class="link" href="TpMessage.html" title="TpMessage"><span class="returnvalue">TpMessage</span></a> * tp_client_message_new_text (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpChannelTextMessageType" title="enum TpChannelTextMessageType"><span class="type">TpChannelTextMessageType</span></a> type</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> *text</code></em>);</pre>
<p>
A convenient function to create a new <a class="link" href="TpClientMessage.html" title="TpClientMessage"><span class="type">TpClientMessage</span></a> having
'text/plain' as 'content-type', <em class="parameter"><code>type</code></em> as 'message-type' and
<em class="parameter"><code>text</code></em> as 'content'.
</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>type</code></em> :</span></p></td>
<td>the type of message</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>content of the messsage</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly allocated <a class="link" href="TpClientMessage.html" title="TpClientMessage"><span class="type">TpClientMessage</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.13.9</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
