extensions/Channel_Interface_Credentials_Storage.xml

   1 <?xml version="1.0" ?>
   2 <node name="/Channel_Interface_Credentials_Storage"
   3       xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4   <tp:copyright> Copyright © 2011 Collabora Limited </tp:copyright>
   5   <tp:license xmlns="http://www.w3.org/1999/xhtml">
   6     <p>This library is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU Lesser General Public
   8 License as published by the Free Software Foundation; either
   9 version 2.1 of the License, or (at your option) any later version.</p>
  10
  11 <p>This library is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 Lesser General Public License for more details.</p>
  15
  16 <p>You should have received a copy of the GNU Lesser General Public
  17 License along with this library; if not, write to the Free Software
  18 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
  19   </tp:license>
  20   <interface name="org.freedesktop.Telepathy.Channel.Interface.CredentialsStorage.DRAFT"
  21     tp:causes-havoc="experimental">
  22     <tp:added version="0.21.10">(draft 1)</tp:added>
  23     <tp:requires interface="org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication"/>
  24     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  25       <p>A channel interface for SASL authentication channels that can save the
  26         credentials in the connection manager.</p>
  27
  28       <p>This interface is unlikely to be present for any SASL channels that are
  29         more complex than a simple password prompt (e.g.
  30         <code>X-TELEPATHY-PASSWORD</code> or <code>PLAIN</code>).</p>
  31
  32       <p>In practice, this interface should only be implemented by connection
  33         managers that implement the <tp:dbus-ref
  34           namespace="ofdT">ConnectionManager.Interface.AccountStorage.DRAFT</tp:dbus-ref>
  35         interface. To clear a password that has been saved in this manner, a
  36         client should call <tp:dbus-ref
  37           namespace="ofdT.ConnectionManager.Interface">AccountStorage.DRAFT.ForgetCredentials</tp:dbus-ref>
  38         on the Account.</p>
  39     </tp:docstring>
  40
  41     <method name="StoreCredentials" tp:name-for-bindings="Store_Credentials">
  42       <arg direction="in" name="Store" type="b">
  43         <tp:docstring>
  44           Whether to store the authentication credentials.
  45         </tp:docstring>
  46       </arg>
  47       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  48         <p>This method tells the connection manager whether to store the
  49           authentication response in order to allow the connection manager to
  50           sign-on automatically in the future.</p>
  51         <p>If credentials have been stored in this way, the client SHOULD NOT
  52           attempt to store the credentials locally in a keyring.</p>
  53         <p>This method MUST be called before <tp:dbus-ref
  54             namespace="org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication">AcceptSASL</tp:dbus-ref>
  55           is called or it will have no effect.</p>
  56       </tp:docstring>
  57     </method>
  58   </interface>
  59 </node>