/usr/share/doc/libtelepathy-glib-doc/telepathy-glib/telepathy-glib-connection-requests.html is in libtelepathy-glib-doc 0.24.1-2.
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 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Connection Requests interface: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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="telepathy-glib-connection-location.html" title="Connection Location interface">
<link rel="next" href="telepathy-glib-connection-simple-presence.html" title="Connection SimplePresence interface">
<meta name="generator" content="GTK-Doc V1.25 (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="#telepathy-glib-connection-requests.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="ch-client.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-connection-location.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="telepathy-glib-connection-simple-presence.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-connection-requests"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-connection-requests.top_of_page"></a>Connection Requests interface</span></h2>
<p>Connection Requests interface — client-side wrappers for the Requests interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-call-create-channel" title="tp_cli_connection_interface_requests_call_create_channel ()">tp_cli_connection_interface_requests_call_create_channel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-call-ensure-channel" title="tp_cli_connection_interface_requests_call_ensure_channel ()">tp_cli_connection_interface_requests_call_ensure_channel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-callback-for-create-channel" title="tp_cli_connection_interface_requests_callback_for_create_channel ()">*tp_cli_connection_interface_requests_callback_for_create_channel</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-callback-for-ensure-channel" title="tp_cli_connection_interface_requests_callback_for_ensure_channel ()">*tp_cli_connection_interface_requests_callback_for_ensure_channel</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-connect-to-channel-closed" title="tp_cli_connection_interface_requests_connect_to_channel_closed ()">tp_cli_connection_interface_requests_connect_to_channel_closed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-connect-to-new-channels" title="tp_cli_connection_interface_requests_connect_to_new_channels ()">tp_cli_connection_interface_requests_connect_to_new_channels</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="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-run-create-channel" title="tp_cli_connection_interface_requests_run_create_channel ()">tp_cli_connection_interface_requests_run_create_channel</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="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-run-ensure-channel" title="tp_cli_connection_interface_requests_run_ensure_channel ()">tp_cli_connection_interface_requests_run_ensure_channel</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-signal-callback-channel-closed" title="tp_cli_connection_interface_requests_signal_callback_channel_closed ()">*tp_cli_connection_interface_requests_signal_callback_channel_closed</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-signal-callback-new-channels" title="tp_cli_connection_interface_requests_signal_callback_new_channels ()">*tp_cli_connection_interface_requests_signal_callback_new_channels</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <telepathy-glib/telepathy-glib-dbus.h>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.description"></a><h2>Description</h2>
<p>This interface allows a client to request new channels from a connection,
and to listen to signals indicating that channels have been created and
closed.</p>
<p>This section documents the auto-generated C wrappers for the Requests
interface, used with <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> objects.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-call-create-channel"></a><h3>tp_cli_connection_interface_requests_call_create_channel ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
tp_cli_connection_interface_requests_call_create_channel
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *in_Request</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-callback-for-create-channel" title="tp_cli_connection_interface_requests_callback_for_create_channel ()"><span class="type">tp_cli_connection_interface_requests_callback_for_create_channel</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Start a CreateChannel method call.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that an entirely new channel is created.</p> <tp:rationale> <p>There is deliberately no flag corresponding to the suppress_handler argument to <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.RequestChannel</tp:dbus-ref>, because passing a FALSE value for that argument is deprecated. Requests made using this interface always behave as though suppress_handler was TRUE.</p> </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-call-create-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>the timeout in milliseconds, or -1 to use the
default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Request</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary containing desirable properties, which MUST include <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">ChannelType</tp:dbus-ref>. Some properties are defined such that only an exact match makes sense, and connection managers MUST NOT satisfy a request with a channel where that property does not match; some properties are defined such that the connection manager MAY treat the request as merely a hint, and make a best-effort attempt to satisfy it. This is documented separately for each property.</p> <p>If this dictionary contains a property whose semantics are not known to the connection manager, this method MUST fail without side-effects (in particular it must not create a new channel).</p> <tp:rationale> <p>This is necessary if we want to be able to invent properties in future that, when used in a request, are hard requirements rather than just hints. A connection manager that did not know the semantics of those properties could incorrectly return a new channel that did not satisfy the requirements.</p> </tp:rationale> <p>The connection manager MUST NOT respond successfully, and SHOULD NOT create a new channel or cause any other side-effects, unless it can create a new channel that satisfies the client's requirements.</p> <p>Properties that will be set by this argument need not have write access after the channel has been created - indeed, it is expected that most will be read-only.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-call-create-channel.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-call-ensure-channel"></a><h3>tp_cli_connection_interface_requests_call_ensure_channel ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="returnvalue">TpProxyPendingCall</span></a> *
tp_cli_connection_interface_requests_call_ensure_channel
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *in_Request</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-callback-for-ensure-channel" title="tp_cli_connection_interface_requests_callback_for_ensure_channel ()"><span class="type">tp_cli_connection_interface_requests_callback_for_ensure_channel</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Start a EnsureChannel method call.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that channels are ensured to exist.</p> <tp:rationale> <p>The connection manager is in the best position to determine which existing channels could satisfy which requests.</p> </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-call-ensure-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>the timeout in milliseconds, or -1 to use the
default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Request</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary containing desirable properties, with the same semantics as the corresponding parameter to <tp:member-ref>CreateChannel</tp:member-ref>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>called when the method call succeeds or fails;
may be <code class="literal">NULL</code> to make a "fire and forget" call with no
reply tracking</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data passed to the callback;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>called with the user_data as argument, after the
call has succeeded, failed or been cancelled;
must be <code class="literal">NULL</code> if <em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, a <span class="type">GObject</span> which will be
weakly referenced; if it is destroyed, this call
will automatically be cancelled. Must be <code class="literal">NULL</code> if
<em class="parameter"><code>callback</code></em>
is <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-call-ensure-channel.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxyPendingCall" title="TpProxyPendingCall"><span class="type">TpProxyPendingCall</span></a> representing the call in
progress. It is borrowed from the object, and will become
invalid when the callback is called, the call is
cancelled or the <a class="link" href="telepathy-glib-proxy.html#TpProxy"><span class="type">TpProxy</span></a> becomes invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-callback-for-create-channel"></a><h3>tp_cli_connection_interface_requests_callback_for_create_channel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_requests_callback_for_create_channel<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *out_Channel</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Properties</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Signature of the callback called when a CreateChannel method call
succeeds or fails.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-callback-for-create-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>the proxy on which the call was made</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Channel</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The Channel object, which MUST NOT be signalled with <tp:member-ref>NewChannels</tp:member-ref> until after this method returns.</p> <tp:rationale> <p>This allows the requester to alter its handling of NewChannels by knowing whether one of the channels satisfied a request it made.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Properties</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel that was produced, equivalent to the properties in <tp:type>Channel_Details</tp:type>. Connection managers MUST NOT include properties here whose values can change, for the same reasons as in <tp:type>Channel_Details</tp:type>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> on success, or an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>user-supplied object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-callback-for-ensure-channel"></a><h3>tp_cli_connection_interface_requests_callback_for_ensure_channel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_requests_callback_for_ensure_channel<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> out_Yours</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *out_Channel</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *out_Properties</code></em>,
<em class="parameter"><code>const <span class="type">GError</span> *error</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<div class="warning"><p><code class="literal">tp_cli_connection_interface_requests_callback_for_ensure_channel</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Signature of the callback called when a EnsureChannel method call
succeeds or fails.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-callback-for-ensure-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>the proxy on which the call was made</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Yours</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>If false, the caller of EnsureChannel MUST assume that some other process is handling this channel; if true, the caller of EnsureChannel SHOULD handle it themselves or delegate it to another client.</p> <p>If the creation of a channel makes several calls to EnsureChannel (and no other requests) successful, exactly one of those calls MUST return a true value for this argument.</p> <p>If the creation of a channel makes other requests successful, the value returned for this argument MUST be such that exactly one of the clients making requests ends up responsible for the channel. In particular, if <tp:member-ref>CreateChannel</tp:member-ref> returns a channel <em>C</em>, any EnsureChannel calls that also return <em>C</em> MUST return a false value for this argument.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Channel</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: The Channel object. If it was created as a result of this method call, it MUST NOT be signalled by <tp:member-ref>NewChannels</tp:member-ref> until after this method returns. <tp:rationale> <p>This allows the requester to alter its handling of NewChannels by knowing whether one of the channels satisfied a request it made.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Properties</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <em class="parameter"><code>error</code></em>
is <code class="literal">NULL</code>: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel that was produced, equivalent to the properties in <tp:type>Channel_Details</tp:type>. Connection managers MUST NOT include properties here whose values can change, for the same reasons as in <tp:type>Channel_Details</tp:type>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p><code class="literal">NULL</code> on success, or an error on failure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>user-supplied object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-connect-to-channel-closed"></a><h3>tp_cli_connection_interface_requests_connect_to_channel_closed ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
tp_cli_connection_interface_requests_connect_to_channel_closed
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-signal-callback-channel-closed" title="tp_cli_connection_interface_requests_signal_callback_channel_closed ()"><span class="type">tp_cli_connection_interface_requests_signal_callback_channel_closed</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Connect a handler to the signal ChannelClosed.</p>
<p>Emitted when a channel is closed and hence disappears from the <tp:member-ref>Channels</tp:member-ref> property. <tp:rationale> This is redundant with the <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">Closed</tp:dbus-ref> signal on the channel itself, but it does provide full change notification for the Channels property. </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-connect-to-channel-closed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>Callback to be called when the signal is
received</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data for the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>A <span class="type">GObject</span> which will be weakly referenced;
if it is destroyed, this callback will automatically be
disconnected</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to raise an error if <code class="literal">NULL</code> is
returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-connect-to-channel-closed.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="type">TpProxySignalConnection</span></a> containing all of the
above, which can be used to disconnect the signal; or
<code class="literal">NULL</code> if the proxy does not have the desired interface
or has become invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-connect-to-new-channels"></a><h3>tp_cli_connection_interface_requests_connect_to_new_channels ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="returnvalue">TpProxySignalConnection</span></a> *
tp_cli_connection_interface_requests_connect_to_new_channels
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-signal-callback-new-channels" title="tp_cli_connection_interface_requests_signal_callback_new_channels ()"><span class="type">tp_cli_connection_interface_requests_signal_callback_new_channels</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Connect a handler to the signal NewChannels.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>New channels have been created. The connection manager SHOULD emit a single signal for any group of closely related channels that are created at the same time, so that the channel dispatcher can try to dispatch them to a handler as a unit.</p> <p>In particular, if additional channels are created as a side-effect of a call to <tp:member-ref>CreateChannel</tp:member-ref>, these channels SHOULD appear in the same NewChannels signal as the channel that satisfies the request.</p> <tp:rationale> <p>Joining a MUC Tube in XMPP requires joining the corresponding MUC (chatroom), so a <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.Type">Text</tp:dbus-ref> channel can be created as a side-effect.</p> </tp:rationale> <p>Every time NewChannels is emitted, it MUST be followed by a <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.NewChannel</tp:dbus-ref> signal for each channel.</p> <tp:rationale> <p>The double signal emission is for the benefit of older Telepathy clients, which won't be listening for NewChannels.</p> <p>The more informative NewChannels signal comes first so that clients that did not examine the connection to find out whether Requests is supported will see the more informative signal for each channel first, and then ignore the less informative signal because it announces a new channel of which they are already aware.</p> </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-connect-to-new-channels.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>Callback to be called when the signal is
received</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data for the callback</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>Destructor for the user-supplied data, which
will be called when this signal is disconnected, or
before this function returns <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>A <span class="type">GObject</span> which will be weakly referenced;
if it is destroyed, this callback will automatically be
disconnected</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to raise an error if <code class="literal">NULL</code> is
returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-connect-to-new-channels.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="telepathy-glib-proxy.html#TpProxySignalConnection" title="TpProxySignalConnection"><span class="type">TpProxySignalConnection</span></a> containing all of the
above, which can be used to disconnect the signal; or
<code class="literal">NULL</code> if the proxy does not have the desired interface
or has become invalid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-run-create-channel"></a><h3>tp_cli_connection_interface_requests_run_create_channel ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_cli_connection_interface_requests_run_create_channel
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *in_Request</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **out_Channel</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> **out_Properties</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>,
<em class="parameter"><code><span class="type">GMainLoop</span> **loop</code></em>);</pre>
<div class="warning"><p><code class="literal">tp_cli_connection_interface_requests_run_create_channel</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Call the method CreateChannel and run the main loop
until it returns. Before calling this method, you must
add a reference to any borrowed objects you need to keep,
and generally ensure that everything is in a consistent
state.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that an entirely new channel is created.</p> <tp:rationale> <p>There is deliberately no flag corresponding to the suppress_handler argument to <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.RequestChannel</tp:dbus-ref>, because passing a FALSE value for that argument is deprecated. Requests made using this interface always behave as though suppress_handler was TRUE.</p> </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-run-create-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>Timeout in milliseconds, or -1 for default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Request</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary containing desirable properties, which MUST include <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">ChannelType</tp:dbus-ref>. Some properties are defined such that only an exact match makes sense, and connection managers MUST NOT satisfy a request with a channel where that property does not match; some properties are defined such that the connection manager MAY treat the request as merely a hint, and make a best-effort attempt to satisfy it. This is documented separately for each property.</p> <p>If this dictionary contains a property whose semantics are not known to the connection manager, this method MUST fail without side-effects (in particular it must not create a new channel).</p> <tp:rationale> <p>This is necessary if we want to be able to invent properties in future that, when used in a request, are hard requirements rather than just hints. A connection manager that did not know the semantics of those properties could incorrectly return a new channel that did not satisfy the requirements.</p> </tp:rationale> <p>The connection manager MUST NOT respond successfully, and SHOULD NOT create a new channel or cause any other side-effects, unless it can create a new channel that satisfies the client's requirements.</p> <p>Properties that will be set by this argument need not have write access after the channel has been created - indeed, it is expected that most will be read-only.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Channel</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>The Channel object, which MUST NOT be signalled with <tp:member-ref>NewChannels</tp:member-ref> until after this method returns.</p> <tp:rationale> <p>This allows the requester to alter its handling of NewChannels by knowing whether one of the channels satisfied a request it made.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Properties</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel that was produced, equivalent to the properties in <tp:type>Channel_Details</tp:type>. Connection managers MUST NOT include properties here whose values can change, for the same reasons as in <tp:type>Channel_Details</tp:type>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to return errors if <code class="literal">FALSE</code>
is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>loop</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, set before re-entering
the main loop, to point to a <span class="type">GMainLoop</span>
which can be used to cancel this call with
<code class="function">g_main_loop_quit()</code>, causing a return of
<code class="literal">FALSE</code> with <em class="parameter"><code>error</code></em>
set to <a class="link" href="telepathy-glib-proxy.html#TP-DBUS-ERROR-CANCELLED:CAPS"><code class="literal">TP_DBUS_ERROR_CANCELLED</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-run-create-channel.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE and sets <em class="parameter"><code>error</code></em>
on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-run-ensure-channel"></a><h3>tp_cli_connection_interface_requests_run_ensure_channel ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_cli_connection_interface_requests_run_ensure_channel
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">gint</span> timeout_ms</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *in_Request</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> *out_Yours</code></em>,
<em class="parameter"><code><span class="type">gchar</span> **out_Channel</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> **out_Properties</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>,
<em class="parameter"><code><span class="type">GMainLoop</span> **loop</code></em>);</pre>
<div class="warning"><p><code class="literal">tp_cli_connection_interface_requests_run_ensure_channel</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Call the method EnsureChannel and run the main loop
until it returns. Before calling this method, you must
add a reference to any borrowed objects you need to keep,
and generally ensure that everything is in a consistent
state.</p>
<p><tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Request that channels are ensured to exist.</p> <tp:rationale> <p>The connection manager is in the best position to determine which existing channels could satisfy which requests.</p> </tp:rationale></p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-run-ensure-channel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> or subclass</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout_ms</p></td>
<td class="parameter_description"><p>Timeout in milliseconds, or -1 for default</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_Request</p></td>
<td class="parameter_description"><p>Used to pass an 'in' argument: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>A dictionary containing desirable properties, with the same semantics as the corresponding parameter to <tp:member-ref>CreateChannel</tp:member-ref>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Yours</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>If false, the caller of EnsureChannel MUST assume that some other process is handling this channel; if true, the caller of EnsureChannel SHOULD handle it themselves or delegate it to another client.</p> <p>If the creation of a channel makes several calls to EnsureChannel (and no other requests) successful, exactly one of those calls MUST return a true value for this argument.</p> <p>If the creation of a channel makes other requests successful, the value returned for this argument MUST be such that exactly one of the clients making requests ends up responsible for the channel. In particular, if <tp:member-ref>CreateChannel</tp:member-ref> returns a channel <em>C</em>, any EnsureChannel calls that also return <em>C</em> MUST return a false value for this argument.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Channel</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: The Channel object. If it was created as a result of this method call, it MUST NOT be signalled by <tp:member-ref>NewChannels</tp:member-ref> until after this method returns. <tp:rationale> <p>This allows the requester to alter its handling of NewChannels by knowing whether one of the channels satisfied a request it made.</p> </tp:rationale></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_Properties</p></td>
<td class="parameter_description"><p>Used to return an 'out' argument if <code class="literal">TRUE</code> is returned: <tp:docstring xmlns="http://www.w3.org/1999/xhtml"> <p>Properties of the channel that was produced, equivalent to the properties in <tp:type>Channel_Details</tp:type>. Connection managers MUST NOT include properties here whose values can change, for the same reasons as in <tp:type>Channel_Details</tp:type>.</p></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, used to return errors if <code class="literal">FALSE</code>
is returned</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>loop</p></td>
<td class="parameter_description"><p>If not <code class="literal">NULL</code>, set before re-entering
the main loop, to point to a <span class="type">GMainLoop</span>
which can be used to cancel this call with
<code class="function">g_main_loop_quit()</code>, causing a return of
<code class="literal">FALSE</code> with <em class="parameter"><code>error</code></em>
set to <a class="link" href="telepathy-glib-proxy.html#TP-DBUS-ERROR-CANCELLED:CAPS"><code class="literal">TP_DBUS_ERROR_CANCELLED</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-run-ensure-channel.returns"></a><h4>Returns</h4>
<p> TRUE on success, FALSE and sets <em class="parameter"><code>error</code></em>
on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-signal-callback-channel-closed"></a><h3>tp_cli_connection_interface_requests_signal_callback_channel_closed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_requests_signal_callback_channel_closed<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *arg_Removed</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Represents the signature of a callback for the signal ChannelClosed.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-signal-callback-channel-closed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>The proxy on which <a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-connect-to-channel-closed" title="tp_cli_connection_interface_requests_connect_to_channel_closed ()"><code class="function">tp_cli_connection_interface_requests_connect_to_channel_closed()</code></a>
was called</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg_Removed</p></td>
<td class="parameter_description"><p>The channel which has been removed from the Channels property</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>User-supplied weakly referenced object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-cli-connection-interface-requests-signal-callback-new-channels"></a><h3>tp_cli_connection_interface_requests_signal_callback_new_channels ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tp_cli_connection_interface_requests_signal_callback_new_channels<span class="c_punctuation">)</span>
(<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *proxy</code></em>,
<em class="parameter"><code>const <span class="type">GPtrArray</span> *arg_Channels</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GObject</span> *weak_object</code></em>);</pre>
<p>Represents the signature of a callback for the signal NewChannels.</p>
<div class="refsect3">
<a name="tp-cli-connection-interface-requests-signal-callback-new-channels.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>proxy</p></td>
<td class="parameter_description"><p>The proxy on which <a class="link" href="telepathy-glib-connection-requests.html#tp-cli-connection-interface-requests-connect-to-new-channels" title="tp_cli_connection_interface_requests_connect_to_new_channels ()"><code class="function">tp_cli_connection_interface_requests_connect_to_new_channels()</code></a>
was called</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>arg_Channels</p></td>
<td class="parameter_description"><p>The channels and their details. All channels that are signalled together like this MUST have the same <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel.FUTURE">Bundle</tp:dbus-ref> property, which may either refer to an existing bundle, or establish a new bundle.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User-supplied data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>weak_object</p></td>
<td class="parameter_description"><p>User-supplied weakly referenced object</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="telepathy-glib-connection-requests.see-also"></a><h2>See Also</h2>
<p><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|