/usr/share/gtk-doc/html/libinfinity-0.6/InfcBrowser.html is in libinfinity-0.6-doc 0.6.7-1~deb8u1.
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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libinfinity-0.6 Reference Manual: InfcBrowser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="ch04.html" title="Libinfinity client side API">
<link rel="next" href="libinfinity-0.6-InfcNotePlugin.html" title="InfcNotePlugin">
<meta name="generator" content="GTK-Doc V1.21 (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="#InfcBrowser.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfcBrowser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfcBrowser.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfcBrowser.properties" class="shortcut">Properties</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinity-0.6-InfcNotePlugin.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfcBrowser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfcBrowser.top_of_page"></a>InfcBrowser</span></h2>
<p>InfcBrowser — Browse remote directories</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfcBrowser.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfcBrowser.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">
<a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="returnvalue">InfcBrowser</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-new" title="infc_browser_new ()">infc_browser_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-get-communication-manager" title="infc_browser_get_communication_manager ()">infc_browser_get_communication_manager</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-get-connection" title="infc_browser_get_connection ()">infc_browser_get_connection</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="InfcBrowser.html#infc-browser-add-plugin" title="infc_browser_add_plugin ()">infc_browser_add_plugin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a class="link" href="libinfinity-0.6-InfcNotePlugin.html#InfcNotePlugin" title="struct InfcNotePlugin"><span class="returnvalue">InfcNotePlugin</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-lookup-plugin" title="infc_browser_lookup_plugin ()">infc_browser_lookup_plugin</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-iter-save-session" title="infc_browser_iter_save_session ()">infc_browser_iter_save_session</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="returnvalue">InfcSessionProxy</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-iter-get-sync-in" title="infc_browser_iter_get_sync_in ()">infc_browser_iter_get_sync_in</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-iter-get-sync-in-requests" title="infc_browser_iter_get_sync_in_requests ()">infc_browser_iter_get_sync_in_requests</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="InfcBrowser.html#infc-browser-iter-is-valid" title="infc_browser_iter_is_valid ()">infc_browser_iter_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-subscribe-chat" title="infc_browser_subscribe_chat ()">infc_browser_subscribe_chat</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-get-subscribe-chat-request" title="infc_browser_get_subscribe_chat_request ()">infc_browser_get_subscribe_chat_request</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="returnvalue">InfcSessionProxy</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcBrowser.html#infc-browser-get-chat-session" title="infc_browser_get_chat_session ()">infc_browser_get_chat_session</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcBrowser.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> *</td>
<td class="property_name"><a class="link" href="InfcBrowser.html#InfcBrowser--chat-session" title="The “chat-session” property">chat-session</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *</td>
<td class="property_name"><a class="link" href="InfcBrowser.html#InfcBrowser--communication-manager" title="The “communication-manager” property">communication-manager</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</td>
<td class="property_name"><a class="link" href="InfcBrowser.html#InfcBrowser--connection" title="The “connection” property">connection</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</td>
<td class="property_name"><a class="link" href="InfcBrowser.html#InfcBrowser--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcBrowser.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="InfcBrowser.html#InfcBrowser-struct" title="struct InfcBrowser">InfcBrowser</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfcBrowser.html#InfcBrowserClass" title="struct InfcBrowserClass">InfcBrowserClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcBrowser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfcBrowser
</pre>
</div>
<div class="refsect1">
<a name="InfcBrowser.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfcBrowser implements
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a> and <a class="link" href="InfBrowser.html" title="InfBrowser">InfBrowser</a>.</p>
</div>
<div class="refsect1">
<a name="InfcBrowser.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/client/infc-browser.h>
</pre>
</div>
<div class="refsect1">
<a name="InfcBrowser.description"></a><h2>Description</h2>
<p>The <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> is used to browse a remote directory and can be used
to subscribe to sessions. <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> implements the <a class="link" href="InfBrowser.html" title="InfBrowser"><span class="type">InfBrowser</span></a>
interface, through which most operations are performed.</p>
</div>
<div class="refsect1">
<a name="InfcBrowser.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infc-browser-new"></a><h3>infc_browser_new ()</h3>
<pre class="programlisting"><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="returnvalue">InfcBrowser</span></a> *
infc_browser_new (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *comm_manager</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Creates a new <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.2.11.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>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used to schedule timeouts.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>comm_manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> to register the server connection
and which forwards incoming data to the browser or running sessions.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>Connection to the server.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.2.6"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-get-communication-manager"></a><h3>infc_browser_get_communication_manager ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="returnvalue">InfCommunicationManager</span></a> *
infc_browser_get_communication_manager
(<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
<p>Returns the communication manager of this browser.</p>
<div class="refsect3">
<a name="id-1.5.2.11.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.3.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-get-connection"></a><h3>infc_browser_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
infc_browser_get_connection (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
<p>Returns the connection to the server.</p>
<div class="refsect3">
<a name="id-1.5.2.11.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.4.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-add-plugin"></a><h3>infc_browser_add_plugin ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infc_browser_add_plugin (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <a class="link" href="libinfinity-0.6-InfcNotePlugin.html#InfcNotePlugin" title="struct InfcNotePlugin"><span class="type">InfcNotePlugin</span></a> *plugin</code></em>);</pre>
<p>Adds <em class="parameter"><code>plugin</code></em>
to <em class="parameter"><code>browser</code></em>
. This allows the browser to create sessions of
the plugin's type. Only one plugin of each type can be added to the
directory.</p>
<div class="refsect3">
<a name="id-1.5.2.11.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plugin</p></td>
<td class="parameter_description"><p>A <a class="link" href="libinfinity-0.6-InfcNotePlugin.html#InfcNotePlugin" title="struct InfcNotePlugin"><span class="type">InfcNotePlugin</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.5.6"></a><h4>Returns</h4>
<p> Whether the plugin was added successfully.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-lookup-plugin"></a><h3>infc_browser_lookup_plugin ()</h3>
<pre class="programlisting">const <a class="link" href="libinfinity-0.6-InfcNotePlugin.html#InfcNotePlugin" title="struct InfcNotePlugin"><span class="returnvalue">InfcNotePlugin</span></a> *
infc_browser_lookup_plugin (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *note_type</code></em>);</pre>
<p>Returns a previously registered plugin (see <a class="link" href="InfcBrowser.html#infc-browser-add-plugin" title="infc_browser_add_plugin ()"><code class="function">infc_browser_add_plugin()</code></a>) for
the given note type, or <code class="literal">NULL</code> if there is no such plugin.</p>
<div class="refsect3">
<a name="id-1.5.2.11.6.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>note_type</p></td>
<td class="parameter_description"><p>A note type, such as "InfText".</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.6.6"></a><h4>Returns</h4>
<p> A <a class="link" href="libinfinity-0.6-InfcNotePlugin.html#InfcNotePlugin" title="struct InfcNotePlugin"><span class="type">InfcNotePlugin</span></a>, or <code class="literal">NULL</code>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-iter-save-session"></a><h3>infc_browser_iter_save_session ()</h3>
<pre class="programlisting"><a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
infc_browser_iter_save_session (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <a class="link" href="InfBrowserIter.html" title="InfBrowserIter"><span class="type">InfBrowserIter</span></a> *iter</code></em>,
<em class="parameter"><code><a class="link" href="InfRequest.html#InfRequestFunc" title="InfRequestFunc ()"><span class="type">InfRequestFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Requests that the server saves the note pointed to by <em class="parameter"><code>iter</code></em>
into its
background storage. Normally, the server only does this when it is either
shut down or when the there are no more subscriptions to the note. Note that
this is merely a request and the server might decide not to save the
session for whatever reason.</p>
<p>The request might either finish during the call to this function, in which
case <em class="parameter"><code>func</code></em>
will be called and <code class="literal">NULL</code> being returned. If the request does not
finish within the function call, a <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> object is returned,
where <em class="parameter"><code>func</code></em>
has been installed for the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal,
so that it is called as soon as the request finishes.</p>
<div class="refsect3">
<a name="id-1.5.2.11.7.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>A <span class="type">InfcBrowserIter</span> pointing to a note in <em class="parameter"><code>browser</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>The function to be called when the request finishes, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.7.7"></a><h4>Returns</h4>
<p> A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> that may be used to get notified when
the request finishes or fails.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-iter-get-sync-in"></a><h3>infc_browser_iter_get_sync_in ()</h3>
<pre class="programlisting"><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="returnvalue">InfcSessionProxy</span></a> *
infc_browser_iter_get_sync_in (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <a class="link" href="InfBrowserIter.html" title="InfBrowserIter"><span class="type">InfBrowserIter</span></a> *iter</code></em>);</pre>
<p>Returns the <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> that is used to synchronize the note <em class="parameter"><code>iter</code></em>
points to to the server. Such a node is created by
<a class="link" href="InfBrowser.html#inf-browser-add-note" title="inf_browser_add_note ()"><code class="function">inf_browser_add_note()</code></a> with non-<code class="literal">NULL</code> <em class="parameter"><code>session</code></em>
parameter. If the client is
subscribed to this note, then this returns the same session as
<a class="link" href="InfBrowser.html#inf-browser-get-session" title="inf_browser_get_session ()"><code class="function">inf_browser_get_session()</code></a>. However, it is possible that we
synchronize this node to the server without being subscribed to it. In
this case, this function returns the session that does the synchronization,
while <a class="link" href="InfBrowser.html#inf-browser-get-session" title="inf_browser_get_session ()"><code class="function">inf_browser_get_session()</code></a> would return <code class="literal">NULL</code>.</p>
<div class="refsect3">
<a name="id-1.5.2.11.8.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>A <span class="type">InfcBrowserIter</span> pointing to a note in <em class="parameter"><code>browser</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.8.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>, or <code class="literal">NULL</code> if we are currently not
synchronizing this node to the server.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-iter-get-sync-in-requests"></a><h3>infc_browser_iter_get_sync_in_requests ()</h3>
<pre class="programlisting"><span class="returnvalue">GSList</span> *
infc_browser_iter_get_sync_in_requests
(<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <a class="link" href="InfBrowserIter.html" title="InfBrowserIter"><span class="type">InfBrowserIter</span></a> *iter</code></em>);</pre>
<p>Returns a list of all <span class="type">InfcNodeRequest</span> created with
<a class="link" href="InfBrowser.html#inf-browser-add-note" title="inf_browser_add_note ()"><code class="function">inf_browser_add_note()</code></a> with the node <em class="parameter"><code>iter</code></em>
points to as
parent. Such requests begin a synchronization to the server when they
have finished.</p>
<div class="refsect3">
<a name="id-1.5.2.11.9.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>A <span class="type">InfcBrowserIter</span> pointing to a subdirectory node in <em class="parameter"><code>browser</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.9.6"></a><h4>Returns</h4>
<p> A list of <span class="type">InfcNodeRequest</span>s. Free with <code class="function">g_slist_free()</code>
when done.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-iter-is-valid"></a><h3>infc_browser_iter_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infc_browser_iter_is_valid (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code>const <a class="link" href="InfBrowserIter.html" title="InfBrowserIter"><span class="type">InfBrowserIter</span></a> *iter</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>iter</code></em>
points to a valid node in <em class="parameter"><code>browser</code></em>
. This is
generally the case for any <span class="type">InfcBrowserIter</span> returned by one of the
InfcBrowser functions, it gets invalid however as soon as the node it
points to is removed.</p>
<div class="refsect3">
<a name="id-1.5.2.11.10.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>A <span class="type">InfcBrowserIter</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.10.6"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>iter</code></em>
points to a node in <em class="parameter"><code>browser</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-subscribe-chat"></a><h3>infc_browser_subscribe_chat ()</h3>
<pre class="programlisting"><a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
infc_browser_subscribe_chat (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>,
<em class="parameter"><code><a class="link" href="InfRequest.html#InfRequestFunc" title="InfRequestFunc ()"><span class="type">InfRequestFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Attempts to subscribe to the server's chat. When the operation finishes
<a class="link" href="InfcBrowser.html#infc-browser-get-chat-session" title="infc_browser_get_chat_session ()"><code class="function">infc_browser_get_chat_session()</code></a> will return a <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>
representing the chat session. It can be used to read the chat's content.
The request can fail in case the server chat is disabled.</p>
<p>The request might either finish during the call to this function, in which
case <em class="parameter"><code>func</code></em>
will be called and <code class="literal">NULL</code> being returned. If the request does not
finish within the function call, a <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> object is returned,
where <em class="parameter"><code>func</code></em>
has been installed for the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal,
so that it is called as soon as the request finishes.</p>
<div class="refsect3">
<a name="id-1.5.2.11.11.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>The function to be called when the request finishes, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data to pass to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.11.7"></a><h4>Returns</h4>
<p> A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> that may be used to get notified when
the request finishes or fails.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-get-subscribe-chat-request"></a><h3>infc_browser_get_subscribe_chat_request ()</h3>
<pre class="programlisting"><a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
infc_browser_get_subscribe_chat_request
(<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
<p>Returns the <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> that represests the request sent to the server
which attempts to subscribe to its chat. If there is no such request
running, then the function returns <code class="literal">NULL</code>. After such a request finishes,
call <a class="link" href="InfcBrowser.html#infc-browser-get-chat-session" title="infc_browser_get_chat_session ()"><code class="function">infc_browser_get_chat_session()</code></a> to get the <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> for the
chat session. To initiate the request, call <a class="link" href="InfcBrowser.html#infc-browser-subscribe-chat" title="infc_browser_subscribe_chat ()"><code class="function">infc_browser_subscribe_chat()</code></a>.</p>
<div class="refsect3">
<a name="id-1.5.2.11.12.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.12.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a>, or <code class="literal">NULL</code>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-browser-get-chat-session"></a><h3>infc_browser_get_chat_session ()</h3>
<pre class="programlisting"><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="returnvalue">InfcSessionProxy</span></a> *
infc_browser_get_chat_session (<em class="parameter"><code><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> *browser</code></em>);</pre>
<p>Returns the <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> representing the running chat session if the
local client is subscribed to it, or <code class="literal">NULL</code> otherwise.</p>
<div class="refsect3">
<a name="id-1.5.2.11.13.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>browser</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.11.13.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> for the chat, or <code class="literal">NULL</code>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfcBrowser.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfcBrowser-struct"></a><h3>struct InfcBrowser</h3>
<pre class="programlisting">struct InfcBrowser;</pre>
<p><a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> is an opaque data type. You should only access it via the
public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcBrowserClass"></a><h3>struct InfcBrowserClass</h3>
<pre class="programlisting">struct InfcBrowserClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfcBrowser.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfcBrowser--chat-session"></a><h3>The <code class="literal">“chat-session”</code> property</h3>
<pre class="programlisting"> “chat-session” <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> *</pre>
<p>Active chat session.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcBrowser--communication-manager"></a><h3>The <code class="literal">“communication-manager”</code> property</h3>
<pre class="programlisting"> “communication-manager” <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a> *</pre>
<p>The communication manager for the browser.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcBrowser--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
<pre class="programlisting"> “connection” <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</pre>
<p>Connection to the server exposing the directory to browse.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcBrowser--io"></a><h3>The <code class="literal">“io”</code> property</h3>
<pre class="programlisting"> “io” <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</pre>
<p>The InfIo to schedule timeouts.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfcBrowser.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a></p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|