extensions/Logger.xml

   1 <?xml version="1.0" ?>
   2 <node name="/Logger"
   3   xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4   <tp:copyright>Copyright © 2009 Collabora Ltd.</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.Logger.DRAFT"
  21     tp:causes-havoc="experimental">
  22     <tp:added version="0.1">(as a draft)</tp:added>
  23
  24     <tp:docstring>
  25       An interface for requesting information from the Telepathy Logger
  26       service.
  27     </tp:docstring>
  28
  29     <tp:struct name="Chat_Message" array-name="Chat_Message_List">
  30       <tp:member type="s" name="Sender">
  31         <tp:docstring>
  32           The identifier of the contact who originated this message.
  33         </tp:docstring>
  34       </tp:member>
  35
  36       <tp:member type="s" name="Message">
  37         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  38         The body of the message sent to a 1-1 Chat or a Chat Room.
  39         </tp:docstring>
  40       </tp:member>
  41
  42       <tp:member type="x" name="Timestamp" tp:type="Unix_Timestamp64">
  43         <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  44         Unix timestamp for the log entry
  45         </tp:docstring>
  46       </tp:member>
  47
  48       <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  49         <p>It represents a single message, received or sent.</p>
  50         <p>The receiver is implicit in the request: if the sender is the user,
  51         the receiver is the identifier in chat_id paramenter, if the sender is
  52         not the user, the user is consequently the receiver of the message</p>
  53       </tp:docstring>
  54     </tp:struct>
  55
  56     <method name="GetRecentMessages"
  57             tp:name-for-bindings="Get_Recent_Messages">
  58       <arg direction="in" name="Account" type="o" tp:type="Account">
  59         <tp:docstring>
  60         The account path for the TpAccount to which the conversation is related
  61         </tp:docstring>
  62       </arg>
  63
  64       <arg direction="in" name="Identifier" type="s">
  65         <tp:docstring>
  66         The buddy's identifier for the conversation
  67         </tp:docstring>
  68       </arg>
  69
  70       <arg direction="in" name="Is_Chatroom" type="b">
  71         <tp:docstring>
  72         Whether the conversation is a chatroom (i.e., XMPP MUC) or not
  73         </tp:docstring>
  74       </arg>
  75
  76       <arg direction="in" name="Lines" type="u">
  77         <tp:docstring>
  78         how many entries will be returned.
  79
  80         NOTE: to retreive information that would generate high traffic, use
  81         the library API approach instead of DBus.
  82         </tp:docstring>
  83       </arg>
  84
  85       <arg direction="out" name="Messages" type="a(ssx)"
  86            tp:type="Chat_Message[]" />
  87
  88       <tp:docstring>
  89         Request the last Lines entries of logs for the specified couple
  90         Account+Identifier.
  91       </tp:docstring>
  92     </method>
  93
  94     <method name="GetFavouriteContacts"
  95             tp:name-for-bindings="Get_Favourite_Contacts">
  96       <arg direction="out" name="Favourite_Contacts" type="a(oas)">
  97         <tp:docstring>
  98         The favourite contacts, as an array of TpAccounts and their contact
  99         identifiers.
 100         </tp:docstring>
 101       </arg>
 102
 103       <tp:docstring>
 104         Returns the favourite contacts.
 105       </tp:docstring>
 106     </method>
 107
 108     <method name="AddFavouriteContact"
 109             tp:name-for-bindings="Add_Favourite_Contact">
 110       <arg direction="in" name="Account" type="o" tp:type="Account">
 111         <tp:docstring>
 112         The object path for the TpAccount to which the contact belongs
 113         </tp:docstring>
 114       </arg>
 115
 116       <arg direction="in" name="Identifier" type="s">
 117         <tp:docstring>
 118         The favourite contact's identifier
 119         </tp:docstring>
 120       </arg>
 121
 122       <tp:docstring>
 123         Add a contact's designation as a favourite. This method may not be
 124         called until the service is ready. See the <tp:dbus-ref
 125         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsReady</tp:dbus-ref> signal and <tp:dbus-ref
 126         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsIsReady</tp:dbus-ref> property.
 127       </tp:docstring>
 128     </method>
 129
 130     <method name="RemoveFavouriteContact"
 131             tp:name-for-bindings="Remove_Favourite_Contact">
 132       <arg direction="in" name="Account" type="o" tp:type="Account">
 133         <tp:docstring>
 134         The object path for the TpAccount to which the contact belongs
 135         </tp:docstring>
 136       </arg>
 137
 138       <arg direction="in" name="Identifier" type="s">
 139         <tp:docstring>
 140         The favourite contact's identifier
 141         </tp:docstring>
 142       </arg>
 143
 144       <tp:docstring>
 145         Remove a contact's designation as a favourite. This method may not be
 146         called until the service is ready. See the <tp:dbus-ref
 147         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsReady</tp:dbus-ref> signal and <tp:dbus-ref
 148         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsIsReady</tp:dbus-ref> property.
 149       </tp:docstring>
 150     </method>
 151
 152     <signal name="FavouriteContactsChanged"
 153       tp:name-for-bindings="Favourite_Contacts_Changed">
 154       <tp:docstring>
 155         The set of favourite contacts has changed.
 156       </tp:docstring>
 157
 158       <arg name="Account" type="o" tp:type="Account">
 159         <tp:docstring>
 160           An account associated with the contact.
 161         </tp:docstring>
 162       </arg>
 163
 164       <arg name="Added" type="as">
 165         <tp:docstring>
 166         List of contact identifiers of contacts which are now favourites.
 167         </tp:docstring>
 168       </arg>
 169
 170       <arg name="Removed" type="as">
 171         <tp:docstring>
 172         List of contact identifiers of contacts which are no longer favourites.
 173         </tp:docstring>
 174       </arg>
 175     </signal>
 176
 177   </interface>
 178 </node>
 179 <!-- vim:set sw=2 sts=2 et ft=xml: -->