[Telepathy-commits] [telepathy-doc/master] docs/book/C/telepathy.xml: Channel: Deal with TODOs, mentioning Capabilities and TpChannel.

Murray Cumming murrayc at murrayc.com
Tue Feb 10 09:12:46 PST 2009


---
 ChangeLog                 |    5 +++++
 docs/book/C/telepathy.xml |   28 ++++++++++++++--------------
 2 files changed, 19 insertions(+), 14 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 24d5fa3..d516410 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2009-02-06  Murray Cumming  <murrayc at openismus.com>
 
+	* docs/book/C/telepathy.xml: Channel: Deal with TODOs, mentioning 
+	Capabilities and TpChannel.
+
+2009-02-06  Murray Cumming  <murrayc at openismus.com>
+
 	* docs/book/C/telepathy.xml: Text Channel: Wrote a little text and 
 	added (unfinished) Sending and Receiving subsections.
 
diff --git a/docs/book/C/telepathy.xml b/docs/book/C/telepathy.xml
index fe7ca85..ef747d4 100644
--- a/docs/book/C/telepathy.xml
+++ b/docs/book/C/telepathy.xml
@@ -554,11 +554,6 @@ AC_SUBST(EXAMPLE_LIBS)
          </listitem>
        </varlistentry>
 
-       <!-- TODO: Mention this when it is out of draft: - A new <ulink url="&url_spec_base;Connection.Interface.ContactCapabilities.DRAFT">ContactCapabilities</ulink> interface will allow retrieving of multiple 
-     types of information at once (string of handle, alias, avatar, presence, etc), 
-     which is more efficient.
-       -->
-
     </variablelist>
 
   </sect1>
@@ -609,15 +604,22 @@ AC_SUBST(EXAMPLE_LIBS)
   <!-- TODO: Mention that the base Channel interface provides channel type, handle and Interfaces 
      properties, and Close method, Closed signal? Only if we can say how it might be used. -->
 
-  <para>TODO:
-   Notes:
-   - You'd need two channels for two types of communication with the same 
-     contact. (At least with the new API.)
-   - Has capabilities. (API will change).
-     - Tells me what type of channel I can open on a connection/contact. 
-       For instance, text/media/tube.
+  <para><literal>telepathy-glib</literal> provides the <ulink url="&url_telepathy_glib_base;connection-requests.html"><classname>TpChannel</classname></ulink> proxy object, which can be created via <ulink url="&url_telepathy_glib_base;channel.html#tp-channel-new"><function>tp_channel_new()</function></ulink> with the object path provided, for instance, by the call to  <ulink url="&url_telepathy_glib_base;connection-requests.html#tp-cli-connection-interface-requests-call-create-channel"><function>tp_cli_connection_interface_requests_call_create_channel()</function></ulink>.</para>
+
+  <!-- TODO: This seems superflous, but it was in the original ToC notes so somebody might think it's worth saying. murrayc -->
+  <para>Of course, you would need two channels for two types of communication with the same contact, for instance if a user is simultaneously exchanging instant messages while in an audio call with the contaact.
   </para>
 
+  <para>Some Connection Managers, such as <literal>telepathy-gabble</literal>, provide the   <indexterm><primary>Capabilities</primary></indexterm><ulink url="&url_spec_base;Connection.Interface.Requests.CreateChannel"><interfacename>Capabilities</interfacename></ulink> interface on the <interfacename>Connection</interfacename> object. The <methodname>GetCapabilities()</methodname> allows the client application to discover what channel types may be created for a particular contact. The capabilities may be limited by the protocol or the feature set of the remote contact's client software. For instance, not all clients are able to handle video calls, so you may not be able to create a <interfacename>StreamedMedia</interfacename> Channel to that contact.</para>
+  <!-- TODO: Mention this replacement for Capabilities when it is out of draft: - A new <ulink url="&url_spec_base;Connection.Interface.ContactCapabilities.DRAFT">ContactCapabilities</ulink> interface will allow retrieving of multiple 
+     types of information at once (string of handle, alias, avatar, presence, etc), 
+     which is more efficient.
+  -->
+
+
+
+
+
   <sect1 id="sec-channel-requesting">
     <title>Requesting Channels</title>
 
@@ -782,9 +784,7 @@ AC_SUBST(EXAMPLE_LIBS)
 
 <!-- TODO:
 Wait for the new specs (2008, Q3):
-   - Capabilities interface(s) on Connection
    - Channel Dispatching
-   - Channel Requesting
    - Client interfaces
 -->
 
-- 
1.5.6.5



More information about the telepathy-commits mailing list