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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpSignalledMessage</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="TpClientMessage.html" title="TpClientMessage">
<link rel="next" href="telepathy-glib-text-channel.html" title="TpTextChannel">
<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="TpClientMessage.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-text-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="#TpSignalledMessage.synopsis" class="shortcut">Top</a>
|
<a href="#TpSignalledMessage.description" class="shortcut">Description</a>
|
<a href="#TpSignalledMessage.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#TpSignalledMessage.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="TpSignalledMessage"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TpSignalledMessage.top_of_page"></a>TpSignalledMessage</span></h2>
<p>TpSignalledMessage — a message received using the Telepathy message interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TpSignalledMessage.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
<a class="link" href="TpSignalledMessage.html#TpSignalledMessage-struct" title="TpSignalledMessage">TpSignalledMessage</a>;
<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>);
</pre>
</div>
<div class="refsect1">
<a name="TpSignalledMessage.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>
+----TpSignalledMessage
</pre>
</div>
<div class="refsect1">
<a name="TpSignalledMessage.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<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
</pre>
</div>
<div class="refsect1">
<a name="TpSignalledMessage.description"></a><h2>Description</h2>
<p>
<a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a> is used within Telepathy clients to represent a message
signalled by a connection manager. This can either be a message received from
someone else, confirmation that a message has been sent by the local user,
or a delivery report indicating that delivery of a message has
succeeded or failed.
</p>
</div>
<div class="refsect1">
<a name="TpSignalledMessage.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpSignalledMessage-struct"></a><h3>TpSignalledMessage</h3>
<pre class="programlisting">typedef struct _TpSignalledMessage TpSignalledMessage;</pre>
<p>
Opaque structure representing a received message using the Telepathy
messages interface
</p>
<p class="since">Since 0.13.9</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-signalled-message-get-sender"></a><h3>tp_signalled_message_get_sender ()</h3>
<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>
<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> if known, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
otherwise.
</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>message</code></em> :</span></p></td>
<td>a <a class="link" href="TpSignalledMessage.html" title="TpSignalledMessage"><span class="type">TpSignalledMessage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<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>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.9</p>
</div>
</div>
<div class="refsect1">
<a name="TpSignalledMessage.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpSignalledMessage--sender"></a><h3>The <code class="literal">"sender"</code> property</h3>
<pre class="programlisting"> "sender" <a class="link" href="telepathy-glib-contact.html#TpContact"><span class="type">TpContact</span></a>* : Read / Write / Construct Only</pre>
<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>
otherwise.
</p>
<p class="since">Since 0.13.9</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|