libgfbgraph-doc 0.2.3-1 / usr / share / gtk-doc / html / gfbgraph-0.2 / gfbgraph-GFBGraphConnectable.html

This file is indexed.

/usr/share/gtk-doc/html/gfbgraph-0.2/gfbgraph-GFBGraphConnectable.html is in libgfbgraph-doc 0.2.3-1.

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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GFBGraphConnectable: GFBGraph 0.2
 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GFBGraph 0.2 Reference Manual">
<link rel="up" href="ch02.html" title="Nodes">
<link rel="prev" href="GFBGraphAlbum.html" title="GFBGraphAlbum">
<link rel="next" href="GFBGraphNode.html" title="GFBGraphNode">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gfbgraph-GFBGraphConnectable.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GFBGraphAlbum.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GFBGraphNode.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gfbgraph-GFBGraphConnectable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gfbgraph-GFBGraphConnectable.top_of_page"></a>GFBGraphConnectable</span></h2>
<p>GFBGraphConnectable — Connectable interface for nodes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-get-connection-post-params" title="gfbgraph_connectable_get_connection_post_params ()">gfbgraph_connectable_get_connection_post_params</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-parse-connected-data" title="gfbgraph_connectable_parse_connected_data ()">gfbgraph_connectable_parse_connected_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-is-connectable-to" title="gfbgraph_connectable_is_connectable_to ()">gfbgraph_connectable_is_connectable_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-get-connection-path" title="gfbgraph_connectable_get_connection_path ()">gfbgraph_connectable_get_connection_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-default-parse-connected-data" title="gfbgraph_connectable_default_parse_connected_data ()">gfbgraph_connectable_default_parse_connected_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gfbgraph-GFBGraphConnectable.html#GFBGraphConnectableInterface" title="struct GFBGraphConnectableInterface">GFBGraphConnectableInterface</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;gfbgraph/gfbgraph.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.description"></a><h2>Description</h2>
<p><span class="type">GFBGraphConnectable</span> interface allow the connection between nodes.
You can see the posible (not necesary implemented) connections in
the section "Connections" in any node object in the</p>
<a class="ulink" href="https://developers.facebook.com/docs/reference/api/" target="_top">Facebook Graph API documentation</a>
</div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gfbgraph-connectable-get-connection-post-params"></a><h3>gfbgraph_connectable_get_connection_post_params ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
gfbgraph_connectable_get_connection_post_params
                               (<em class="parameter"><code><span class="type">GFBGraphConnectable</span> *self</code></em>,
                                <em class="parameter"><code><span class="type">GType</span> node_type</code></em>);</pre>
<p>Get the params to be inserted in a request to the Facebook Graph API
in order to append the node <em class="parameter"><code>self</code></em>
 to a node of type <em class="parameter"><code>node_type</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.3.7.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <span class="type">GFBGraphConnectable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node_type</p></td>
<td class="parameter_description"><p>a <span class="type">GType</span>, required a <span class="type">GFBGRAPH_TYPE_NODE</span> or children.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.2.6"></a><h4>Returns</h4>
<p> A string based <span class="type">GHashTable</span> with the params and his values or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gfbgraph-connectable-parse-connected-data"></a><h3>gfbgraph_connectable_parse_connected_data ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
gfbgraph_connectable_parse_connected_data
                               (<em class="parameter"><code><span class="type">GFBGraphConnectable</span> *self</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *payload</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Parse the response contained in <em class="parameter"><code>payload</code></em>
 when a <a class="link" href="GFBGraphNode.html#gfbgraph-node-get-connection-nodes" title="gfbgraph_node_get_connection_nodes ()"><code class="function">gfbgraph_node_get_connection_nodes()</code></a> was
executed.</p>
<div class="refsect3">
<a name="id-1.3.3.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <span class="type">GFBGraphConnectable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>payload</p></td>
<td class="parameter_description"><p>a const <span class="type">gchar</span> with the response string from the Facebook Graph API.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> a <span class="type">GError</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.3.6"></a><h4>Returns</h4>
<p> a newly-allocated <span class="type">GList</span> of <a class="link" href="GFBGraphNode.html" title="GFBGraphNode"><span class="type">GFBGraphNode</span></a> created from the <em class="parameter"><code>payload</code></em>
or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GFBGraphNode][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gfbgraph-connectable-is-connectable-to"></a><h3>gfbgraph_connectable_is_connectable_to ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gfbgraph_connectable_is_connectable_to
                               (<em class="parameter"><code><span class="type">GFBGraphConnectable</span> *self</code></em>,
                                <em class="parameter"><code><span class="type">GType</span> node_type</code></em>);</pre>
<p>Check if <em class="parameter"><code>self</code></em>
 object, normally a <a class="link" href="GFBGraphNode.html" title="GFBGraphNode"><span class="type">GFBGraphNode</span></a> implementing the <span class="type">GFBGraphConnectable</span> interface,
has the possibility to be connected to another node of type <em class="parameter"><code>node_type</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.3.7.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <span class="type">GFBGraphConnectable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node_type</p></td>
<td class="parameter_description"><p>a <span class="type">GType</span>, required a <span class="type">GFBGRAPH_TYPE_NODE</span> or children.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.4.6"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> in case that the <em class="parameter"><code>self</code></em>
object can be connected to a node of type <em class="parameter"><code>node_type</code></em>
,
<code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gfbgraph-connectable-get-connection-path"></a><h3>gfbgraph_connectable_get_connection_path ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
gfbgraph_connectable_get_connection_path
                               (<em class="parameter"><code><span class="type">GFBGraphConnectable</span> *self</code></em>,
                                <em class="parameter"><code><span class="type">GType</span> node_type</code></em>);</pre>
<p>Get the Facebook Graph API function path to retrieve the nodes connected with <em class="parameter"><code>node_type</code></em>

managed by the <span class="type">GFBGraphConnectable</span> object.</p>
<div class="refsect3">
<a name="id-1.3.3.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <span class="type">GFBGraphConnectable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>node_type</p></td>
<td class="parameter_description"><p>a <span class="type">GType</span>, required a <span class="type">GFBGRAPH_TYPE_NODE</span> or children.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.5.6"></a><h4>Returns</h4>
<p> a const <span class="type">gchar</span> with the function path or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gfbgraph-connectable-default-parse-connected-data"></a><h3>gfbgraph_connectable_default_parse_connected_data ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
gfbgraph_connectable_default_parse_connected_data
                               (<em class="parameter"><code><span class="type">GFBGraphConnectable</span> *self</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *payload</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>In most cases, <span class="type">GFBGraphConnectable</span> implementers can use this function in order to parse
the response when a <a class="link" href="GFBGraphNode.html#gfbgraph-node-get-connection-nodes" title="gfbgraph_node_get_connection_nodes ()"><code class="function">gfbgraph_node_get_connection_nodes()</code></a> is executed and the
<a class="link" href="gfbgraph-GFBGraphConnectable.html#gfbgraph-connectable-parse-connected-data" title="gfbgraph_connectable_parse_connected_data ()"><code class="function">gfbgraph_connectable_parse_connected_data()</code></a> was called.</p>
<p>Normally, Facebook Graph API returns the connections in the same way, using JSON objects,
with a root object called "data".</p>
<div class="refsect3">
<a name="id-1.3.3.7.6.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <span class="type">GFBGraphConnectable</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>payload</p></td>
<td class="parameter_description"><p>a const <span class="type">gchar</span> with the response string from the Facebook Graph API.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.6.7"></a><h4>Returns</h4>
<p> a newly-allocated <span class="type">GList</span> of <a class="link" href="GFBGraphNode.html" title="GFBGraphNode"><span class="type">GFBGraphNode</span></a> with the same <span class="type">GType</span> as <em class="parameter"><code>self</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GFBGraphNode][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gfbgraph-GFBGraphConnectable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GFBGraphConnectableInterface"></a><h3>struct GFBGraphConnectableInterface</h3>
<pre class="programlisting">struct GFBGraphConnectableInterface {
        GTypeInterface parent;

        GHashTable *connections;

        GHashTable   *(*get_connection_post_params) (GFBGraphConnectable *self, GType node_type);
        GList        *(*parse_connected_data) (GFBGraphConnectable *self, const gchar *payload, GError **error);
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.