path: root/spec/Channel_Dispatcher.xml

<?xml version="1.0" ?>
<node name="/Channel_Dispatcher"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">

  <tp:copyright>Copyright © 2008-2009 Collabora Ltd.</tp:copyright>
  <tp:copyright>Copyright © 2008-2009 Nokia Corporation</tp:copyright>
  <tp:license xmlns="http://www.w3.org/1999/xhtml">
    <p>This library is free software; you can redistribute it and/or
      modify it under the terms of the GNU Lesser General Public
      License as published by the Free Software Foundation; either
      version 2.1 of the License, or (at your option) any later version.</p>

    <p>This library is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      Lesser General Public License for more details.</p>

    <p>You should have received a copy of the GNU Lesser General Public
      License along with this library; if not, write to the Free Software
      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
      USA.</p>
  </tp:license>

  <interface name="im.telepathy1.ChannelDispatcher">
    <tp:added version="0.17.26">(as a stable interface)</tp:added>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>The channel dispatcher is responsible for responding to new
        channels and launching client processes to handle them. It also
        provides functionality for client processes to request that new
        channels are created.</p>

      <p>If a channel dispatcher is running, it is responsible for dispatching
        new channels on all
        <tp:dbus-ref namespace="im.telepathy1">Connection</tp:dbus-ref>s
        created by the
        <tp:dbus-ref namespace="im.telepathy1">AccountManager</tp:dbus-ref>.
        Connections not created by the AccountManager are outside the scope
        of the channel dispatcher.</p>

      <tp:rationale>
        <p>Connections created by standalone Telepathy clients
          that do not intend to interact with the channel dispatcher
          should be ignored - otherwise, the channel dispatcher would try
          to launch handlers for channels that the standalone client
          was already handling internally.</p>
      </tp:rationale>

      <p>The current channel dispatcher is defined to be the process that
        owns the well-known bus name
        <code>im.telepathy1.ChannelDispatcher</code> on
        the session bus. This process MUST export an object with this
        interface at the object path
        <code>/im/telepathy1/ChannelDispatcher</code>.</p>

      <p>Until a mechanism exists for making a reasonable automatic choice
        of ChannelDispatcher implementation, implementations SHOULD NOT
        register as an activatable service for the ChannelDispatcher's
        well-known bus name. Instead, it is RECOMMENDED that some component
        of the user's session will select and activate a particular
        implementation, and that other Telepathy-enabled programs
        can detect whether channel request/dispatch functionality is available
        by checking whether the ChannelDispatcher's well-known name is in use
        at runtime.</p>

      <p>There are three categories of client process defined by this
        specification:</p>

      <dl>
        <dt><tp:dbus-ref
            namespace="im.telepathy1.Client">Observer</tp:dbus-ref></dt>
        <dd><p>Observers monitor the creation of new channels. This
            functionality can be used for things like message logging.
            All observers are notified simultaneously.</p></dd>

        <dt><tp:dbus-ref
            namespace="im.telepathy1.Client">Approver</tp:dbus-ref></dt>
        <dd>
          <p>Approvers notify the user that new channels have been created,
            and also select which channel handler will be used for the channel,
            either by asking the user or by choosing the most appropriate
            channel handler.</p>
        </dd>

        <dt><tp:dbus-ref
            namespace="im.telepathy1.Client">Handler</tp:dbus-ref></dt>
        <dd>
          <p>Each new channel or set of channels is passed to exactly one
            handler as its final destination. A typical channel handler is a
            user interface process handling channels of a particular type.</p>
        </dd>
      </dl>
    </tp:docstring>

    <property name="Interfaces" tp:name-for-bindings="Interfaces"
      type="as" access="read" tp:type="DBus_Interface[]">
      <tp:docstring>
        A list of the extra interfaces provided by this channel dispatcher.
      </tp:docstring>
    </property>

    <method name="CreateChannel"
            tp:name-for-bindings="Create_Channel">
      <tp:added version="0.21.5"/>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Start a request to create a channel. This initially just creates a
          <tp:dbus-ref namespace="im.telepathy1">ChannelRequest</tp:dbus-ref>
          object, which can be used to continue the request and track its
          success or failure.</p>

        <tp:rationale>
          <p>The request can take a long time - in the worst case, the
            channel dispatcher has to ask the account manager to put the
            account online, the account manager has to ask the operating
            system to obtain an Internet connection, and the operating
            system has to ask the user whether to activate an Internet
            connection using an on-demand mechanism like dialup.</p>

          <p>This means that using a single D-Bus method call and response
            to represent the whole request will tend to lead to that call
            timing out, which is not the behaviour we want.</p>
        </tp:rationale>

        <p>If this method is called for an Account that is disabled, invalid
          or otherwise unusable, no error is signalled until
          <tp:dbus-ref
            namespace="im.telepathy1">ChannelRequest.Proceed</tp:dbus-ref>
          is called, at which point
          <tp:dbus-ref
            namespace="im.telepathy1">ChannelRequest.Failed</tp:dbus-ref>
          is emitted with an appropriate error.</p>

        <tp:rationale>
          <p>This means there's only one code path for errors, apart from
            InvalidArgument for "that request makes no sense".</p>

          <p>It also means that the request will proceed if the account is
            enabled after calling CreateChannel, but before calling
            Proceed.</p>
        </tp:rationale>
      </tp:docstring>

      <arg direction="in" name="Account" type="o">
        <tp:docstring>
          The
            <tp:dbus-ref namespace="im.telepathy1">Account</tp:dbus-ref>
          for which the new channel is to be created.
        </tp:docstring>
      </arg>

      <arg direction="in" name="Requested_Properties" type="a{sv}"
        tp:type="Qualified_Property_Value_Map">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>A dictionary containing desirable properties. This has the same
            semantics as the corresponding parameter to
            <tp:dbus-ref namespace="im.telepathy1">Connection.Interface.Requests.CreateChannel</tp:dbus-ref>.
          </p>

          <p>Certain properties will not necessarily make sense in this
            dictionary: for instance,
            <tp:dbus-ref namespace="im.telepathy1.Channel">TargetHandle</tp:dbus-ref>
            can only be given if the requester is able to interact with a
            <tp:dbus-ref namespace="im.telepathy1">Connection</tp:dbus-ref>
            to the desired account.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="User_Action_Time" type="x"
        tp:type="User_Action_Timestamp">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The time at which user action occurred, or 0 if this channel
            request is for some reason not involving user action.
            The <tp:dbus-ref
              namespace="im.telepathy1.ChannelRequest">UserActionTime</tp:dbus-ref>
            property will be set to this value, and it will eventually be
            passed as the <code>User_Action_Time</code> parameter of <tp:dbus-ref
              namespace="im.telepathy1.Client.Handler">HandleChannels</tp:dbus-ref>.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="Preferred_Handler" type="s"
        tp:type="DBus_Well_Known_Name">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>Either the well-known bus name (starting with
            <code>im.telepathy1.Client.</code>)
            of the preferred handler for this
            channel, or an empty string to indicate that any handler would be
            acceptable. The channel dispatcher SHOULD dispatch as many as
            possible of the resulting channels (ideally, all of them)
            to that handler—irrespective of whether that handler's <tp:dbus-ref
              namespace="im.telepathy1.Client.Handler">HandlerChannelFilter</tp:dbus-ref>
            matches the channel—and SHOULD remember the preferred handler
            so it can try to dispatch subsequent channels in the same bundle
            to the same handler.</p>

          <tp:rationale>
            <p>This must be the well-known bus name, not the unique name,
              to ensure that all handlers do indeed have the Client API,
              and the Client object on the handler can be located easily.</p>

            <p>This is partly so the channel dispatcher can call
              <tp:dbus-ref
                namespace="im.telepathy1.Client.Handler">HandleChannels</tp:dbus-ref>
              on it, and partly so the channel dispatcher
              can recover state if it crashes and is restarted.</p>

            <p>The filter should be disregarded for ease of use of this
              interface: clients will usually use this argument to request
              channels be sent to themself, and this should trump the filter
              not matching. This also allows a client to become the handler
              for a channel produced by one of its own requests, while not
              being a candidate to handle other channels of that type.</p>
          </tp:rationale>

          <p>If this is a well-known bus name and the handler has the
            Requests interface, the channel dispatcher SHOULD
            call <tp:dbus-ref
              namespace="im.telepathy1.Client.Interface.Requests">AddRequest</tp:dbus-ref>
            on that Handler after this method has returned.</p>

          <tp:rationale>
            <p>This ordering allows a Handler which calls CreateChannel with
              itself as the preferred handler to associate the call to
              AddRequest with that call.</p>
          </tp:rationale>

          <p>This is copied to the ChannelRequest that is returned,
            as the <tp:dbus-ref
              namespace="im.telepathy1.ChannelRequest">PreferredHandler</tp:dbus-ref>
            property.</p>
        </tp:docstring>

        <tp:changed version="0.19.0">
          Previously, the spec didn't say that this should disregard the
          handler's filter. This has been implemented since
          telepathy-mission-control 5.3.2.
        </tp:changed>
      </arg>

      <arg direction="in" name="Hints" type="a{sv}">
        <tp:docstring>
          <p>Additional information about the channel request, which will be
            used as the value for the resulting request's <tp:dbus-ref
              namespace="imt1.ChannelRequest">Hints</tp:dbus-ref>
            property.</p>

          <tp:rationale>
            <p>See the <tp:dbus-ref
              namespace="imt1.ChannelRequest">Hints</tp:dbus-ref>
              property's documentation for rationale.</p>
          </tp:rationale>
        </tp:docstring>
      </arg>

      <arg direction="out" name="Request" type="o">
        <tp:docstring>
          A
          <tp:dbus-ref namespace="im.telepathy1">ChannelRequest</tp:dbus-ref>
          object.
        </tp:docstring>
      </arg>

      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.InvalidArgument">
          <tp:docstring>
            The <var>Preferred_Handler</var> is syntactically invalid or does
            not start with <code>im.telepathy1.Client.</code>,
            the <var>Account</var> does not exist, or one of the
            <var>Requested_Properties</var> is invalid
          </tp:docstring>
        </tp:error>
      </tp:possible-errors>

    </method>

    <method name="EnsureChannel"
            tp:name-for-bindings="Ensure_Channel">
      <tp:added version="0.21.5"/>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Start a request to ensure that a channel exists, creating it if
          necessary.  This initially just creates a <tp:dbus-ref
            namespace="im.telepathy1">ChannelRequest</tp:dbus-ref>
          object, which can be used to continue the request and track its
          success or failure.</p>

        <p>If this method is called for an Account that is disabled, invalid
          or otherwise unusable, no error is signalled until
          <tp:dbus-ref
            namespace="im.telepathy1">ChannelRequest.Proceed</tp:dbus-ref>
          is called, at which point
          <tp:dbus-ref
            namespace="im.telepathy1">ChannelRequest.Failed</tp:dbus-ref>
          is emitted with an appropriate error.</p>

        <tp:rationale>
          <p>The rationale is as for <tp:dbus-ref
              namespace='im.telepathy1.ChannelDispatcher'>CreateChannel</tp:dbus-ref>.</p>
        </tp:rationale>
      </tp:docstring>

      <arg direction="in" name="Account" type="o">
        <tp:docstring>
          The
            <tp:dbus-ref namespace="im.telepathy1">Account</tp:dbus-ref>
          for which the new channel is to be created.
        </tp:docstring>
      </arg>

      <arg direction="in" name="Requested_Properties" type="a{sv}"
        tp:type="Qualified_Property_Value_Map">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>A dictionary containing desirable properties. This has the same
            semantics as the corresponding parameter to
            <tp:dbus-ref namespace="im.telepathy1">Connection.Interface.Requests.EnsureChannel</tp:dbus-ref>.
          </p>

          <p>Certain properties will not necessarily make sense in this
            dictionary: for instance,
            <tp:dbus-ref namespace="im.telepathy1.Channel">TargetHandle</tp:dbus-ref>
            can only be given if the requester is able to interact with a
            <tp:dbus-ref namespace="im.telepathy1">Connection</tp:dbus-ref>
            to the desired account.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="User_Action_Time" type="x"
        tp:type="User_Action_Timestamp">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The time at which user action occurred, or 0 if this channel
            request is for some reason not involving user action.</p>

          <p>This parameter is used in the same way as the corresponding
            parameter to
            <tp:member-ref>CreateChannel</tp:member-ref>.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="Preferred_Handler" type="s"
        tp:type="DBus_Well_Known_Name">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>Either the well-known bus name (starting with
            <code>im.telepathy1.Client.</code>)
            of the preferred handler for this
            channel, or an empty string to indicate that any handler would be
            acceptable. The behaviour and rationale are the same as for the
            corresponding parameter to
            <tp:member-ref>CreateChannel</tp:member-ref>, except
            as noted here.</p>

          <p>If any new channels are created in response to this
            request, the channel dispatcher SHOULD dispatch as many as
            possible of the resulting channels (ideally, all of them)
            to that handler, and SHOULD remember the preferred handler
            so it can try to dispatch subsequent channels in the same bundle
            to the same handler. If the requested channel already exists (that
            is, <tp:dbus-ref
              namespace="im.telepathy1">Connection.Interface.Requests.EnsureChannel</tp:dbus-ref>
            returns <code>Yours=False</code>) then the channel dispatcher
            SHOULD re-dispatch the channel to its existing handler, and MUST
            NOT dispatch it to this client (unless it is the existing handler);
            the request is still deemed to have succeeded in this case.</p>

          <tp:rationale>
            <p>An address book application, for example, might call <tp:dbus-ref
                namespace='im.telepathy1.ChannelDispatcher'>EnsureChannel</tp:dbus-ref>
              to ensure that a text channel with a particular contact is
              displayed to the user; it does not care whether a new channel was
              made. An IM client might call <tp:dbus-ref
                namespace='im.telepathy1.ChannelDispatcher'>EnsureChannel</tp:dbus-ref>
              in response to the user double-clicking an entry in the contact
              list, with itself as the <code>Preferred_Handler</code>; if the
              user already has a conversation with that contact in another
              application, they would expect the existing window to be
              presented, rather than their double-click leading to an error
              message.  So the request should succeed, even if its
              <code>Preferred_Handler</code> is not used.</p>
          </tp:rationale>

        </tp:docstring>
      </arg>

      <arg direction="in" name="Hints" type="a{sv}">
        <tp:docstring>
          Additional information about the channel request, which will be used
          as the value for the resulting request's <tp:dbus-ref
          namespace="imt1.ChannelRequest">Hints</tp:dbus-ref>
          property.</tp:docstring>
      </arg>

      <arg direction="out" name="Request" type="o">
        <tp:docstring>
          A
          <tp:dbus-ref namespace="im.telepathy1">ChannelRequest</tp:dbus-ref>
          object.
        </tp:docstring>
      </arg>

      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.InvalidArgument">
          <tp:docstring>
            The <var>Preferred_Handler</var> is syntactically invalid or does
            not start with <code>im.telepathy1.Client.</code>,
            the <var>Account</var> does not exist, or one of the
            <var>Requested_Properties</var> is invalid
          </tp:docstring>
        </tp:error>
      </tp:possible-errors>

    </method>

    <method name="DelegateChannels"
            tp:name-for-bindings="Delegate_Channels">
      <tp:added version="0.23.1">
        Implemented since telepathy-mission-control 5.7.12.
      </tp:added>
      <tp:changed version="0.23.2">This method now returns
        <var>Delegated</var> and <var>Not_Delegated</var> instead of nothing.
        <tp:dbus-ref namespace="imt1.Client.Handler">HandleChannels</tp:dbus-ref>
        is now called once per <var>Channel</var> in <var>Channels</var>.
      </tp:changed>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Called by a
        <tp:dbus-ref namespace="im.telepathy1.Client">Handler</tp:dbus-ref>
          to redispatch a bunch of channels it is currently handling.</p>

        <p>For each <var>Channel</var> in <var>Channels</var>, if another
          <tp:dbus-ref namespace="imt1.Client">Handler</tp:dbus-ref>
          can be found,
          <tp:dbus-ref namespace="imt1.Client.Handler">HandleChannels</tp:dbus-ref>
          will be called on it until a
          <tp:dbus-ref namespace="imt1.Client">Handler</tp:dbus-ref>
          accepts it.</p>

        <p>This method returns once all the <var>Channels</var> have either
          been accepted or rejected by Handlers.</p>

        <p>If this method fails, the original
          <tp:dbus-ref namespace="im.telepathy1.Client">Handler</tp:dbus-ref>
          is still handling the channels.</p>

      </tp:docstring>

      <arg direction="in" name="Channels" type="ao">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The list of channels to redispatch. The caller has to be the current
            <tp:dbus-ref namespace="im.telepathy1.Client">Handler</tp:dbus-ref>
            of all of these channels
          </p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="User_Action_Time" type="x"
        tp:type="User_Action_Timestamp">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The time at which user action occurred, or 0 if this channels
            delegation is for some reason not involving user action.</p>

          <p>This parameter is used in the same way as the corresponding
            parameter to
            <tp:member-ref>CreateChannel</tp:member-ref>.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="Preferred_Handler" type="s"
        tp:type="DBus_Well_Known_Name">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>Either the well-known bus name (starting with
            <code>im.telepathy1.Client.</code>)
            of the preferred new handler for these
            channels, or an empty string to indicate that any handler would be
            acceptable. The behaviour and rationale are the same as for the
            corresponding parameter to
            <tp:member-ref>CreateChannel</tp:member-ref>.</p>

        </tp:docstring>
      </arg>

      <arg direction="out" name="Delegated" type="ao">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The list of channels which have been delegated; the caller is no
          longer handling these channels.</p>

          <p>The client should remove these channels from its
          <tp:dbus-ref namespace="imt1.Client.Handler">HandledChannels</tp:dbus-ref>
          property.</p>
        </tp:docstring>
      </arg>

      <arg direction="out" name="Not_Delegated" type="a{o(ss)}"
       tp:type="Not_Delegated_Map">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The list of channels which have NOT been delegated; the caller is still
          handling these channels.</p>
        </tp:docstring>
      </arg>

      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.InvalidArgument">
          <tp:docstring>
            The Preferred_Handler is syntactically invalid or does
            not start with <code>im.telepathy1.Client.</code>.
          </tp:docstring>
        </tp:error>

        <tp:error name="im.telepathy1.Error.NotYours">
          <tp:docstring>
            At least one <var>Channel</var> in <var>Channels</var> is not
            currently handled by the caller. No <var>Channel</var> has been
            delegated.
          </tp:docstring>
        </tp:error>
      </tp:possible-errors>

    </method>

    <tp:mapping name="Not_Delegated_Map">
      <tp:docstring>
        A mapping associating not delegated channel with an error.
      </tp:docstring>

      <tp:member type="o" name="Channel">
        <tp:docstring>
          The path of the channel
        </tp:docstring>
      </tp:member>
      <tp:member type="(ss)" name="Error" tp:type="Not_Delegated_Error">
        <tp:docstring>
          An error describing why the channel has not be delegated
        </tp:docstring>
      </tp:member>
    </tp:mapping>

    <tp:struct name="Not_Delegated_Error">
      <tp:member type="s" name="Error_Name" tp:type="DBus_Error_Name">
        <tp:docstring>
          the name of a D-Bus error describing what went wrong.
        </tp:docstring>
      </tp:member>
      <tp:member type="s" name="Error_Message">
        <tp:docstring>
          a human-readable informative error message.
        </tp:docstring>
      </tp:member>
    </tp:struct>

    <method name="PresentChannel"
            tp:name-for-bindings="Present_Channel">
      <tp:added version="0.23.1">
        Implemented since telepathy-mission-control 5.7.12.
      </tp:added>
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Equivalent of calling
        <tp:dbus-ref namespace="im.telepathy1.ChannelDispatcher">EnsureChannel</tp:dbus-ref>
        with a <var>Requested_Properties</var> which would result in ensuring
        <var>Channel</var>.</p>

         <p>If <var>Channel</var> is handled, its handler will be asked to present it the user
         (e.g. bring it into the foreground).</p>
      </tp:docstring>

      <arg direction="in" name="Channel" type="o">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The channel to present.</p>
        </tp:docstring>
      </arg>

      <arg direction="in" name="User_Action_Time" type="x"
        tp:type="User_Action_Timestamp">
        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
          <p>The time at which user action occurred, or 0 if this channel
            request is for some reason not involving user action.</p>

          <p>This parameter is used in the same way as the corresponding
            parameter to
            <tp:member-ref>EnsureChannel</tp:member-ref>.</p>
        </tp:docstring>
      </arg>

      <tp:possible-errors>
        <tp:error name="im.telepathy1.Error.InvalidArgument">
          <tp:docstring>
            The Account does not exist, the Channel does not exist or it
            does not belong to the Account.
          </tp:docstring>
        </tp:error>

      </tp:possible-errors>
    </method>

  </interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->