diff options
Diffstat (limited to 'telepathy-logger/extensions/Logger.xml')
| -rw-r--r-- | telepathy-logger/extensions/Logger.xml | 153 |
1 files changed, 153 insertions, 0 deletions
diff --git a/telepathy-logger/extensions/Logger.xml b/telepathy-logger/extensions/Logger.xml new file mode 100644 index 000000000..fcfd36de7 --- /dev/null +++ b/telepathy-logger/extensions/Logger.xml @@ -0,0 +1,153 @@ +<?xml version="1.0" ?> +<node name="/Logger" + xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <tp:copyright>Copyright © 2009-2011 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="im.telepathy1.Logger1" + tp:causes-havoc="experimental"> + <tp:added version="0.3">(as a draft)</tp:added> + + <tp:docstring> + An interface for requesting information from the Telepathy Logger + service. + </tp:docstring> + + <method name="GetFavouriteContacts" + tp:name-for-bindings="Get_Favourite_Contacts"> + <arg direction="out" name="Favourite_Contacts" type="a(oas)"> + <tp:docstring> + The favourite contacts, as an array of TpAccounts and their contact + identifiers. + </tp:docstring> + </arg> + + <tp:docstring> + Returns the favourite contacts. + </tp:docstring> + </method> + + <method name="AddFavouriteContact" + tp:name-for-bindings="Add_Favourite_Contact"> + <arg direction="in" name="Account" type="o" tp:type="Account"> + <tp:docstring> + The object path for the TpAccount to which the contact belongs + </tp:docstring> + </arg> + + <arg direction="in" name="Identifier" type="s"> + <tp:docstring> + The favourite contact's identifier + </tp:docstring> + </arg> + + <tp:docstring> + Add a contact's designation as a favourite. + </tp:docstring> + </method> + + <method name="RemoveFavouriteContact" + tp:name-for-bindings="Remove_Favourite_Contact"> + <arg direction="in" name="Account" type="o" tp:type="Account"> + <tp:docstring> + The object path for the TpAccount to which the contact belongs + </tp:docstring> + </arg> + + <arg direction="in" name="Identifier" type="s"> + <tp:docstring> + The favourite contact's identifier + </tp:docstring> + </arg> + + <tp:docstring> + Remove a contact's designation as a favourite. + </tp:docstring> + </method> + + <method name="Clear" + tp:name-for-bindings="Clear"> + <tp:docstring> + Clear all the logs. This will not erase the favourite contacts. + </tp:docstring> + </method> + + <method name="ClearAccount" + tp:name-for-bindings="Clear_Account"> + <arg direction="in" name="Account" type="o" tp:type="Account"> + <tp:docstring> + The object path for the TpAccount in which logs will be cleared. + </tp:docstring> + </arg> + + <tp:docstring> + Clear all logs stored for specified account. + </tp:docstring> + </method> + + <method name="ClearEntity" + tp:name-for-bindings="Clear_Entity"> + <arg direction="in" name="Account" type="o" tp:type="Account"> + <tp:docstring> + The object path for the TpAccount in which logs will be cleared. + </tp:docstring> + </arg> + + <arg direction="in" name="Identifier" type="s"> + <tp:docstring> + The entity identifier. + </tp:docstring> + </arg> + + <arg direction="in" name="Type" type="i"> + <tp:docstring> + The entity type, should be one of TPL_ENTITY_CONTACT (1) or TPL_ENTITY_ROOM (2). + </tp:docstring> + </arg> + + <tp:docstring> + Clear all logs stored for discussions with entity in account. + </tp:docstring> + </method> + + <signal name="FavouriteContactsChanged" + tp:name-for-bindings="Favourite_Contacts_Changed"> + <tp:docstring> + The set of favourite contacts has changed. + </tp:docstring> + + <arg name="Account" type="o" tp:type="Account"> + <tp:docstring> + An account associated with the contact. + </tp:docstring> + </arg> + + <arg name="Added" type="as"> + <tp:docstring> + List of contact identifiers of contacts which are now favourites. + </tp:docstring> + </arg> + + <arg name="Removed" type="as"> + <tp:docstring> + List of contact identifiers of contacts which are no longer favourites. + </tp:docstring> + </arg> + </signal> + + </interface> +</node> +<!-- vim:set sw=2 sts=2 et ft=xml: --> |