libtelepathy-logger-doc 0.4.0-0ubuntu1 / usr / share / doc / libtelepathy-logger-doc / telepathy-logger / TplEvent.html

This file is indexed.

/usr/share/doc/libtelepathy-logger-doc/telepathy-logger/TplEvent.html is in libtelepathy-logger-doc 0.4.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TplEvent</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="telepathy-logger Reference Manual">
<link rel="up" href="ch-public.html" title="libtelepathy-logger API">
<link rel="prev" href="TplLogManager.html" title="TplLogManager">
<link rel="next" href="TplTextEvent.html" title="TplTextEvent">
<meta name="generator" content="GTK-Doc V1.18 (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="TplLogManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-public.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-logger Reference Manual</th>
<td><a accesskey="n" href="TplTextEvent.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#TplEvent.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#TplEvent.description" class="shortcut">Description</a>
                   | 
                  <a href="#TplEvent.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#TplEvent.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="TplEvent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="TplEvent.top_of_page"></a>TplEvent</span></h2>
<p>TplEvent — Abstract representation of a log event</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="TplEvent.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="TplEvent.html#TplEvent-struct" title="TplEvent">TplEvent</a>;
                    <a class="link" href="TplEvent.html#TplEventClass" title="TplEventClass">TplEventClass</a>;
                    <a class="link" href="TplEvent.html#TplEventPriv" title="TplEventPriv">TplEventPriv</a>;
<span class="returnvalue">gboolean</span>            <a class="link" href="TplEvent.html#tpl-event-equal" title="tpl_event_equal ()">tpl_event_equal</a>                     (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *data</code></em>);
<span class="returnvalue">TpAccount</span> *         <a class="link" href="TplEvent.html#tpl-event-get-account" title="tpl_event_get_account ()">tpl_event_get_account</a>               (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="TplEvent.html#tpl-event-get-account-path" title="tpl_event_get_account_path ()">tpl_event_get_account_path</a>          (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);
<a class="link" href="TplEntity.html" title="TplEntity"><span class="returnvalue">TplEntity</span></a> *         <a class="link" href="TplEvent.html#tpl-event-get-receiver" title="tpl_event_get_receiver ()">tpl_event_get_receiver</a>              (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);
<a class="link" href="TplEntity.html" title="TplEntity"><span class="returnvalue">TplEntity</span></a> *         <a class="link" href="TplEvent.html#tpl-event-get-sender" title="tpl_event_get_sender ()">tpl_event_get_sender</a>                (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);
<span class="returnvalue">gint64</span>              <a class="link" href="TplEvent.html#tpl-event-get-timestamp" title="tpl_event_get_timestamp ()">tpl_event_get_timestamp</a>             (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="TplEvent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----TplEvent
         +----TplCallEvent
         +----<a class="link" href="TplTextEvent.html" title="TplTextEvent">TplTextEvent</a>
</pre>
</div>
<div class="refsect1">
<a name="TplEvent.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="TplEvent.html#TplEvent--account" title='The "account" property'>account</a>"                  <span class="type">TpAccount</span>*            : Read / Write / Construct Only
  "<a class="link" href="TplEvent.html#TplEvent--account-path" title='The "account-path" property'>account-path</a>"             <span class="type">gchar</span>*                : Read
  "<a class="link" href="TplEvent.html#TplEvent--channel-path" title='The "channel-path" property'>channel-path</a>"             <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="TplEvent.html#TplEvent--receiver" title='The "receiver" property'>receiver</a>"                 <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a>*            : Read / Write / Construct Only
  "<a class="link" href="TplEvent.html#TplEvent--sender" title='The "sender" property'>sender</a>"                   <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a>*            : Read / Write / Construct Only
  "<a class="link" href="TplEvent.html#TplEvent--timestamp" title='The "timestamp" property'>timestamp</a>"                <span class="type">gint64</span>                : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="TplEvent.description"></a><h2>Description</h2>
<p>
The TPLogger log event represents a generic log event, which will be
specialized by subclasses of <a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a>.
</p>
</div>
<div class="refsect1">
<a name="TplEvent.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TplEvent-struct"></a><h3>TplEvent</h3>
<pre class="programlisting">typedef struct _TplEvent TplEvent;</pre>
<p>
An object representing a generic log event.
</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEventClass"></a><h3>TplEventClass</h3>
<pre class="programlisting">typedef struct _TplEventClass TplEventClass;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEventPriv"></a><h3>TplEventPriv</h3>
<pre class="programlisting">typedef struct _TplEventPriv TplEventPriv;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-equal"></a><h3>tpl_event_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            tpl_event_equal                     (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>,
                                                         <em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *data</code></em>);</pre>
<p>
Checks if two instances of TplEvent represent the same data
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>TplEvent subclass instance</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>an instance of the same TplEvent subclass of <em class="parameter"><code>self</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>data</code></em> is the same type of <em class="parameter"><code>self</code></em> and they hold the same
data, <code class="literal">FALSE</code> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-get-account"></a><h3>tpl_event_get_account ()</h3>
<pre class="programlisting"><span class="returnvalue">TpAccount</span> *         tpl_event_get_account               (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);</pre>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the same account as the <a class="link" href="TplEvent.html#TplEvent--account" title='The "account" property'><span class="type">"account"</span></a> property. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-get-account-path"></a><h3>tpl_event_get_account_path ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       tpl_event_get_account_path          (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-get-receiver"></a><h3>tpl_event_get_receiver ()</h3>
<pre class="programlisting"><a class="link" href="TplEntity.html" title="TplEntity"><span class="returnvalue">TplEntity</span></a> *         tpl_event_get_receiver              (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the same <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a> as the <a class="link" href="TplEvent.html#TplEvent--receiver" title='The "receiver" property'><span class="type">"receiver"</span></a> property. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-get-sender"></a><h3>tpl_event_get_sender ()</h3>
<pre class="programlisting"><a class="link" href="TplEntity.html" title="TplEntity"><span class="returnvalue">TplEntity</span></a> *         tpl_event_get_sender                (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the same <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a> as the <a class="link" href="TplEvent.html#TplEvent--sender" title='The "sender" property'><span class="type">"sender"</span></a> property. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="tpl-event-get-timestamp"></a><h3>tpl_event_get_timestamp ()</h3>
<pre class="programlisting"><span class="returnvalue">gint64</span>              tpl_event_get_timestamp             (<em class="parameter"><code><a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a> *self</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="TplEvent.html" title="TplEvent"><span class="type">TplEvent</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the same timestamp as the <a class="link" href="TplEvent.html#TplEvent--timestamp" title='The "timestamp" property'><span class="type">"timestamp"</span></a> property</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="TplEvent.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TplEvent--account"></a><h3>The <code class="literal">"account"</code> property</h3>
<pre class="programlisting">  "account"                  <span class="type">TpAccount</span>*            : Read / Write / Construct Only</pre>
<p>The TpAccount to which the log event is related.</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEvent--account-path"></a><h3>The <code class="literal">"account-path"</code> property</h3>
<pre class="programlisting">  "account-path"             <span class="type">gchar</span>*                : Read</pre>
<p>The account path of the TpAccount to which the log event is related.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEvent--channel-path"></a><h3>The <code class="literal">"channel-path"</code> property</h3>
<pre class="programlisting">  "channel-path"             <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>The channel path of the TpChannel to which the log event is related.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEvent--receiver"></a><h3>The <code class="literal">"receiver"</code> property</h3>
<pre class="programlisting">  "receiver"                 <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a>*            : Read / Write / Construct Only</pre>
<p>TplEntity instance destination for the log event (may be NULL with some log stores).</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEvent--sender"></a><h3>The <code class="literal">"sender"</code> property</h3>
<pre class="programlisting">  "sender"                   <a class="link" href="TplEntity.html" title="TplEntity"><span class="type">TplEntity</span></a>*            : Read / Write / Construct Only</pre>
<p>TplEntity instance who originated the log event.</p>
</div>
<hr>
<div class="refsect2">
<a name="TplEvent--timestamp"></a><h3>The <code class="literal">"timestamp"</code> property</h3>
<pre class="programlisting">  "timestamp"                <span class="type">gint64</span>                : Read / Write / Construct Only</pre>
<p>The timestamp (gint64) for the log event.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="TplEvent.see-also"></a><h2>See Also</h2>
<a class="link" href="TplTextEvent.html" title="TplTextEvent"><span class="type">TplTextEvent</span></a> and other subclasses when they'll exist
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.