~ubuntu-branches/ubuntu/feisty/libtelepathy/feisty

<?xml version="1.0" ?>

<node name="/Channel_Interface_Password" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">

  <tp:copyright>

Copyright (C) 2005, 2006 Collabora Limited

Copyright (C) 2005, 2006 Nokia Corporation

Copyright (C) 2006 INdT

  </tp:copyright>

  <tp:license>

    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.

 

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

Library General Public License for more details.

 

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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  </tp:license>

  <interface name="org.freedesktop.Telepathy.Channel.Interface.Password">

    <tp:requires interface="org.freedesktop.Telepathy.Channel"/>

    <tp:flags name="Channel_Password_Flags" value-prefix="Channel_Password_Flag">

      <tp:flag suffix="Provide" value="8">

        <tp:docstring>

          The ProvidePassword method must be called now for the user to join

          the channel

        </tp:docstring>

      </tp:flag>

    </tp:flags>

    <method name="GetPasswordFlags">

      <arg direction="out" type="u">

        <tp:docstring>

          An integer with the logical OR of all the flags set

          (values of ChannelPasswordFlags)

        </tp:docstring>

      </arg>

      <tp:docstring>

        Returns the bitwise-OR of the flags relevant to the password on this

        channel.  The user interface can use this to present information about

        which operations are currently valid.

      </tp:docstring>

      <tp:possible-errors>

        <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>

        <tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/>

      </tp:possible-errors>

    </method>

    <signal name="PasswordFlagsChanged">

      <arg name="added" type="u">

        <tp:docstring>

          A bitwise OR of the flags which have been set

        </tp:docstring>

      </arg>

      <arg name="removed" type="u">

        <tp:docstring>

          A bitwise OR of the flags which have been cleared

        </tp:docstring>

      </arg>

      <tp:docstring>

        Emitted when the flags as returned by GetPasswordFlags are changed.

        The user interface should be updated as appropriate.

      </tp:docstring>

    </signal>

    <method name="ProvidePassword">

      <arg direction="in" name="password" type="s">

        <tp:docstring>

          The password

        </tp:docstring>

      </arg>

      <arg direction="out" type="b">

        A boolean indicating whether or not the password was correct

      </arg>

      <tp:docstring>

        Provide the password so that the channel can be joined. Must be

        called with the correct password in order for channel joining to

        proceed if the 'provide' password flag is set.

      </tp:docstring>

      <tp:possible-errors>

        <tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>

        <tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/>

        <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument"/>

      </tp:possible-errors>

    </method>

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">

      <p>Interface for channels that may have a password set that users need

    to provide before being able to join, or may be able to view or change

    once they have joined the channel.</p>

 

    <p>The GetPasswordFlags method and the associated PasswordFlagsChanged

    signal indicate whether the channel has a password, whether the user

    must now provide it to join, and whether it can be viewed or changed

    by the user.</p>

    </tp:docstring>

  </interface>

</node>

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