[next] telepathy-spec: Logger1.xml: copy from tp-logger
Guillaume Desmottes
gdesmott at kemper.freedesktop.org
Fri Feb 7 03:05:45 PST 2014
Module: telepathy-spec
Branch: next
Commit: 70f2e642f5e9feafcf798d98f0552305625201bc
URL: http://cgit.freedesktop.org/telepathy/telepathy-spec/commit/?id=70f2e642f5e9feafcf798d98f0552305625201bc
Author: Guillaume Desmottes <guillaume.desmottes at collabora.co.uk>
Date: Tue Feb 4 15:26:48 2014 +0100
Logger1.xml: copy from tp-logger
Raw copy, no change yet.
---
spec/Logger1.xml | 153 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
spec/all.xml | 4 ++
2 files changed, 157 insertions(+)
diff --git a/spec/Logger1.xml b/spec/Logger1.xml
new file mode 100644
index 0000000..9c3afdf
--- /dev/null
+++ b/spec/Logger1.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.telepathy.v1.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: -->
diff --git a/spec/all.xml b/spec/all.xml
index d9257b8..a9daae5 100644
--- a/spec/all.xml
+++ b/spec/all.xml
@@ -293,6 +293,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<xi:include href="Client_Interface_Requests.xml"/>
</tp:section>
+<tp:section name="Logger">
+ <xi:include href="Logger1.xml"/>
+</tp:section>
+
<xi:include href="errors.xml"/>
<xi:include href="generic-types.xml"/>
More information about the telepathy-commits
mailing list