path: root/extensions/Debug.xml

<?xml version="1.0" ?>
<node name="/Debug"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <tp:copyright>Copyright (C) 2009 Collabora Ltd.</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="org.freedesktop.Telepathy.Debug">

    <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
      <p>An interface for providing debug messages.

         This interface is primarily provided by one object per
         service, at the path <tt>/org/freedesktop/Telepathy/debug</tt>.
      </p>
    </tp:docstring>

    <property name="Enabled" type="b" access="readwrite">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>TRUE if the NewDebugMessage signal should be emitted when a new
           debug message is generated.</p>
      </tp:docstring>
    </property>

    <method name="GetMessages">
      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
        <p>Retrieve buffered debug messages.</p>
      </tp:docstring>

      <arg direction="out" name="messages" type="a(dsus)">
         <tp:docstring>
          A list of timestamped debug messages.
        </tp:docstring>
      </arg>
    </method>

    <signal name="NewDebugMessage" tp:name-for-bindings="New_Debug_Message">
      <tp:docstring>
        Emitted when a debug messages is generated if the Enabled property is
        set.
      </tp:docstring>

      <arg name="time" type="d">
        <tp:docstring>
          Message timestamp
        </tp:docstring>
      </arg>
      <arg name="domain" type="s">
    <tp:docstring>
      Message domain
    </tp:docstring>
      </arg>
      <arg name="level" type="u" tp:type="Debug_Level">
    <tp:docstring>
      Message level
    </tp:docstring>
      </arg>
      <arg name="message" type="s">
        <tp:docstring>
          Message
        </tp:docstring>
      </arg>
    </signal>

    <tp:enum name="Debug_Level" type="u">
      <tp:enumvalue suffix="Error" value="0">
    <tp:docstring>
      error
    </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="Critical" value="1">
    <tp:docstring>
      criticla
    </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="Warning" value="2">
    <tp:docstring>
      warning
    </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="Message" value="3">
    <tp:docstring>
      message
    </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="Info" value="4">
    <tp:docstring>
      info
    </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="Debug" value="5">
    <tp:docstring>
      debug
    </tp:docstring>
      </tp:enumvalue>
    </tp:enum>

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