← Back to branch summary

~ubuntu-branches/ubuntu/utopic/telepathy-glib/utopic

« back to all changes in this revision

Viewing changes to docs/reference/html/TpSignalledMessage.html

  • Committer: Package Import Robot
  • Author(s): Simon McVittie
  • Date: 2014-09-16 15:49:50 UTC
  • mfrom: (60.1.5 sid)
  • Revision ID: package-import@ubuntu.com-20140916154950-krvowuvofhu8u6sp
Tags: 0.24.1-1
* New upstream stable release
* debian/copyright: clean up syntax (*.[ch] is unsupported),
  drop deleted files
* debian/watch: only match 0.x versions, 1.0 will be a separate
  source package

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TpSignalledMessage.html
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>telepathy-glib API Reference Manual: TpSignalledMessage</title>
 
5
<title>TpSignalledMessage</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
8
8
<link rel="up" href="ch-client.html" title="Client-side proxies">
9
9
<link rel="prev" href="TpClientMessage.html" title="TpClientMessage">
10
10
<link rel="next" href="telepathy-glib-text-channel.html" title="TpTextChannel">
11
 
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
 
<td width="100%" align="left" class="shortcuts">
17
 
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
18
 
                  <a href="#TpSignalledMessage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
19
 
                  <a href="#TpSignalledMessage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
20
 
                  <a href="#TpSignalledMessage.properties" class="shortcut">Properties</a></span>
21
 
</td>
22
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23
 
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
 
<td><a accesskey="p" href="TpClientMessage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
 
<td><a accesskey="n" href="telepathy-glib-text-channel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26
 
</tr></table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="TpClientMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch-client.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">telepathy-glib API Reference Manual</th>
 
21
<td><a accesskey="n" href="telepathy-glib-text-channel.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#TpSignalledMessage.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#TpSignalledMessage.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#TpSignalledMessage.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#TpSignalledMessage.properties" class="shortcut">Properties</a>
 
31
</td></tr>
 
32
</table>
27
33
<div class="refentry">
28
34
<a name="TpSignalledMessage"></a><div class="titlepage"></div>
29
35
<div class="refnamediv"><table width="100%"><tr>
31
37
<h2><span class="refentrytitle"><a name="TpSignalledMessage.top_of_page"></a>TpSignalledMessage</span></h2>
32
38
<p>TpSignalledMessage — a message received using the Telepathy message interface</p>
33
39
</td>
34
 
<td class="gallery_image" valign="top" align="right"></td>
 
40
<td valign="top" align="right"></td>
35
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="TpSignalledMessage.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">
 
45
#include &lt;telepathy-glib/telepathy-glib.h&gt;
 
46
 
 
47
                    <a class="link" href="TpSignalledMessage.html#TpSignalledMessage-struct" title="TpSignalledMessage">TpSignalledMessage</a>;
 
48
<a class="link" href="telepathy-glib-contact.html#TpContact"><span class="returnvalue">TpContact</span></a> *         <a class="link" href="TpSignalledMessage.html#tp-signalled-message-get-sender" title="tp_signalled_message_get_sender ()">tp_signalled_message_get_sender</a>     (<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);
 
49
</pre>
 
50
</div>
36
51
<div class="refsect1">
37
 
<a name="TpSignalledMessage.functions"></a><h2>Functions</h2>
38
 
<div class="informaltable"><table width="100%" border="0">
39
 
<colgroup>
40
 
<col width="150px" class="functions_return">
41
 
<col class="functions_name">
42
 
</colgroup>
43
 
<tbody><tr>
44
 
<td class="function_type">
45
 
<a class="link" href="telepathy-glib-contact.html#TpContact"><span class="returnvalue">TpContact</span></a> *
46
 
</td>
47
 
<td class="function_name">
48
 
<a class="link" href="TpSignalledMessage.html#tp-signalled-message-get-sender" title="tp_signalled_message_get_sender ()">tp_signalled_message_get_sender</a> <span class="c_punctuation">()</span>
49
 
</td>
50
 
</tr></tbody>
51
 
</table></div>
 
52
<a name="TpSignalledMessage.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
53
<pre class="synopsis">
 
54
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
55
   +----<a class="link" href="TpMessage.html" title="TpMessage">TpMessage</a>
 
56
         +----TpSignalledMessage
 
57
</pre>
52
58
</div>
53
59
<div class="refsect1">
54
60
<a name="TpSignalledMessage.properties"></a><h2>Properties</h2>
55
 
<div class="informaltable"><table border="0">
56
 
<colgroup>
57
 
<col width="150px" class="properties_type">
58
 
<col width="300px" class="properties_name">
59
 
<col width="200px" class="properties_flags">
60
 
</colgroup>
61
 
<tbody><tr>
62
 
<td class="property_type">
63
 
<a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> *</td>
64
 
<td class="property_name"><a class="link" href="TpSignalledMessage.html#TpSignalledMessage--sender" title="The “sender” property">sender</a></td>
65
 
<td class="property_flags">Read / Write / Construct Only</td>
66
 
</tr></tbody>
67
 
</table></div>
68
 
</div>
69
 
<div class="refsect1">
70
 
<a name="TpSignalledMessage.other"></a><h2>Types and Values</h2>
71
 
<div class="informaltable"><table width="100%" border="0">
72
 
<colgroup>
73
 
<col width="150px" class="name">
74
 
<col class="description">
75
 
</colgroup>
76
 
<tbody><tr>
77
 
<td class="datatype_keyword"> </td>
78
 
<td class="function_name"><a class="link" href="TpSignalledMessage.html#TpSignalledMessage-struct" title="TpSignalledMessage">TpSignalledMessage</a></td>
79
 
</tr></tbody>
80
 
</table></div>
81
 
</div>
82
 
<div class="refsect1">
83
 
<a name="TpSignalledMessage.object-hierarchy"></a><h2>Object Hierarchy</h2>
84
 
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
85
 
    <span class="lineart">╰──</span> <a class="link" href="TpMessage.html" title="TpMessage">TpMessage</a>
86
 
        <span class="lineart">╰──</span> TpSignalledMessage
87
 
</pre>
88
 
</div>
89
 
<div class="refsect1">
90
 
<a name="TpSignalledMessage.includes"></a><h2>Includes</h2>
91
 
<pre class="synopsis">#include &lt;telepathy-glib/telepathy-glib.h&gt;
 
61
<pre class="synopsis">
 
62
  "<a class="link" href="TpSignalledMessage.html#TpSignalledMessage--sender" title='The "sender" property'>sender</a>"                   <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a>*            : Read / Write / Construct Only
92
63
</pre>
93
64
</div>
94
65
<div class="refsect1">
95
66
<a name="TpSignalledMessage.description"></a><h2>Description</h2>
96
 
<p><a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a> is used within Telepathy clients to represent a message
 
67
<p>
 
68
<a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a> is used within Telepathy clients to represent a message
97
69
signalled by a connection manager. This can either be a message received from
98
70
someone else, confirmation that a message has been sent by the local user,
99
71
or a delivery report indicating that delivery of a message has
100
 
succeeded or failed.</p>
101
 
</div>
102
 
<div class="refsect1">
103
 
<a name="TpSignalledMessage.functions_details"></a><h2>Functions</h2>
104
 
<div class="refsect2">
105
 
<a name="tp-signalled-message-get-sender"></a><h3>tp_signalled_message_get_sender ()</h3>
106
 
<pre class="programlisting"><a class="link" href="telepathy-glib-contact.html#TpContact"><span class="returnvalue">TpContact</span></a> *
107
 
tp_signalled_message_get_sender (<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);</pre>
108
 
<p>Returns a <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> representing the sender of <em class="parameter"><code>message</code></em>
109
 
 if known, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
110
 
otherwise.</p>
111
 
<div class="refsect3">
112
 
<a name="id-1.4.62.9.2.5"></a><h4>Parameters</h4>
113
 
<div class="informaltable"><table width="100%" border="0">
114
 
<colgroup>
115
 
<col width="150px" class="parameters_name">
116
 
<col class="parameters_description">
117
 
<col width="200px" class="parameters_annotations">
118
 
</colgroup>
119
 
<tbody><tr>
120
 
<td class="parameter_name"><p>message</p></td>
121
 
<td class="parameter_description"><p>a <a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a></p></td>
122
 
<td class="parameter_annotations"> </td>
123
 
</tr></tbody>
124
 
</table></div>
125
 
</div>
126
 
<div class="refsect3">
127
 
<a name="id-1.4.62.9.2.6"></a><h4>Returns</h4>
128
 
<p> the sender of the message. </p>
129
 
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
130
 
</div>
131
 
<p class="since">Since 0.13.9</p>
132
 
</div>
133
 
</div>
134
 
<div class="refsect1">
135
 
<a name="TpSignalledMessage.other_details"></a><h2>Types and Values</h2>
 
72
succeeded or failed.
 
73
</p>
 
74
</div>
 
75
<div class="refsect1">
 
76
<a name="TpSignalledMessage.details"></a><h2>Details</h2>
136
77
<div class="refsect2">
137
78
<a name="TpSignalledMessage-struct"></a><h3>TpSignalledMessage</h3>
138
79
<pre class="programlisting">typedef struct _TpSignalledMessage TpSignalledMessage;</pre>
139
 
<p>Opaque structure representing a received message using the Telepathy
140
 
messages interface</p>
 
80
<p>
 
81
Opaque structure representing a received message using the Telepathy
 
82
messages interface
 
83
</p>
 
84
<p class="since">Since 0.13.9</p>
 
85
</div>
 
86
<hr>
 
87
<div class="refsect2">
 
88
<a name="tp-signalled-message-get-sender"></a><h3>tp_signalled_message_get_sender ()</h3>
 
89
<pre class="programlisting"><a class="link" href="telepathy-glib-contact.html#TpContact"><span class="returnvalue">TpContact</span></a> *         tp_signalled_message_get_sender     (<em class="parameter"><code><a class="link" href="TpMessage.html" title="TpMessage"><span class="type">TpMessage</span></a> *message</code></em>);</pre>
 
90
<p>
 
91
Returns a <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> representing the sender of <em class="parameter"><code>message</code></em> if known, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
92
otherwise.
 
93
</p>
 
94
<div class="variablelist"><table border="0" class="variablelist">
 
95
<colgroup>
 
96
<col align="left" valign="top">
 
97
<col>
 
98
</colgroup>
 
99
<tbody>
 
100
<tr>
 
101
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 
102
<td>a <a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a>
 
103
</td>
 
104
</tr>
 
105
<tr>
 
106
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
107
<td>the sender of the message. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
108
</td>
 
109
</tr>
 
110
</tbody>
 
111
</table></div>
141
112
<p class="since">Since 0.13.9</p>
142
113
</div>
143
114
</div>
144
115
<div class="refsect1">
145
116
<a name="TpSignalledMessage.property-details"></a><h2>Property Details</h2>
146
117
<div class="refsect2">
147
 
<a name="TpSignalledMessage--sender"></a><h3>The <code class="literal">“sender”</code> property</h3>
148
 
<pre class="programlisting">  “sender”                   <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> *</pre>
149
 
<p>A <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> representing the sender of the message, if known, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
150
 
otherwise.</p>
151
 
<p>Flags: Read / Write / Construct Only</p>
 
118
<a name="TpSignalledMessage--sender"></a><h3>The <code class="literal">"sender"</code> property</h3>
 
119
<pre class="programlisting">  "sender"                   <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a>*            : Read / Write / Construct Only</pre>
 
120
<p>
 
121
A <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a> representing the sender of the message, if known, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
122
otherwise.
 
123
</p>
152
124
<p class="since">Since 0.13.9</p>
153
125
</div>
154
126
</div>
155
127
</div>
156
128
<div class="footer">
157
129
<hr>
158
 
          Generated by GTK-Doc V1.20</div>
 
130
          Generated by GTK-Doc V1.19</div>
159
131
</body>
160
132
</html>
 
 
b'\\ No newline at end of file'