Be more compatible with Facebook emoticon codes
[empathy.git] / 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-2011 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.3">(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     <method name="GetFavouriteContacts"
30             tp:name-for-bindings="Get_Favourite_Contacts">
31       <arg direction="out" name="Favourite_Contacts" type="a(oas)">
32         <tp:docstring>
33         The favourite contacts, as an array of TpAccounts and their contact
34         identifiers.
35         </tp:docstring>
36       </arg>
37
38       <tp:docstring>
39         Returns the favourite contacts.
40       </tp:docstring>
41     </method>
42
43     <method name="AddFavouriteContact"
44             tp:name-for-bindings="Add_Favourite_Contact">
45       <arg direction="in" name="Account" type="o" tp:type="Account">
46         <tp:docstring>
47         The object path for the TpAccount to which the contact belongs
48         </tp:docstring>
49       </arg>
50
51       <arg direction="in" name="Identifier" type="s">
52         <tp:docstring>
53         The favourite contact's identifier
54         </tp:docstring>
55       </arg>
56
57       <tp:docstring>
58         Add a contact's designation as a favourite. This method may not be
59         called until the service is ready. See the <tp:dbus-ref
60         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsReady</tp:dbus-ref> signal and <tp:dbus-ref
61         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsIsReady</tp:dbus-ref> property.
62       </tp:docstring>
63     </method>
64
65     <method name="RemoveFavouriteContact"
66             tp:name-for-bindings="Remove_Favourite_Contact">
67       <arg direction="in" name="Account" type="o" tp:type="Account">
68         <tp:docstring>
69         The object path for the TpAccount to which the contact belongs
70         </tp:docstring>
71       </arg>
72
73       <arg direction="in" name="Identifier" type="s">
74         <tp:docstring>
75         The favourite contact's identifier
76         </tp:docstring>
77       </arg>
78
79       <tp:docstring>
80         Remove a contact's designation as a favourite. This method may not be
81         called until the service is ready. See the <tp:dbus-ref
82         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsReady</tp:dbus-ref> signal and <tp:dbus-ref
83         namespace="org.freedesktop.Telepathy.Logger.DRAFT">FavouriteContactsIsReady</tp:dbus-ref> property.
84       </tp:docstring>
85     </method>
86
87     <method name="Clear"
88             tp:name-for-bindings="Clear">
89       <tp:docstring>
90         Clear all the logs. This will not erase the favourite contacts.
91       </tp:docstring>
92     </method>
93
94     <method name="ClearAccount"
95             tp:name-for-bindings="Clear_Account">
96       <arg direction="in" name="Account" type="o" tp:type="Account">
97         <tp:docstring>
98         The object path for the TpAccount in which logs will be cleared.
99         </tp:docstring>
100       </arg>
101
102       <tp:docstring>
103         Clear all logs stored for specified account.
104       </tp:docstring>
105     </method>
106
107     <method name="ClearEntity"
108             tp:name-for-bindings="Clear_Entity">
109       <arg direction="in" name="Account" type="o" tp:type="Account">
110         <tp:docstring>
111         The object path for the TpAccount in which logs will be cleared.
112         </tp:docstring>
113       </arg>
114
115       <arg direction="in" name="Identifier" type="s">
116         <tp:docstring>
117         The entity identifier.
118         </tp:docstring>
119       </arg>
120
121       <arg direction="in" name="Type" type="i">
122         <tp:docstring>
123         The entity type, should be one of TPL_ENTITY_CONTACT (1) or TPL_ENTITY_ROOM (2).
124         </tp:docstring>
125       </arg>
126
127       <tp:docstring>
128         Clear all logs stored for discussions with entity in account.
129       </tp:docstring>
130     </method>
131
132     <signal name="FavouriteContactsChanged"
133       tp:name-for-bindings="Favourite_Contacts_Changed">
134       <tp:docstring>
135         The set of favourite contacts has changed.
136       </tp:docstring>
137
138       <arg name="Account" type="o" tp:type="Account">
139         <tp:docstring>
140           An account associated with the contact.
141         </tp:docstring>
142       </arg>
143
144       <arg name="Added" type="as">
145         <tp:docstring>
146         List of contact identifiers of contacts which are now favourites.
147         </tp:docstring>
148       </arg>
149
150       <arg name="Removed" type="as">
151         <tp:docstring>
152         List of contact identifiers of contacts which are no longer favourites.
153         </tp:docstring>
154       </arg>
155     </signal>
156
157   </interface>
158 </node>
159 <!-- vim:set sw=2 sts=2 et ft=xml: -->