[Telepathy-commits] [telepathy-spec/master] C.I.Group: add MembersChangedDetails signal

Will Thompson will.thompson at collabora.co.uk
Fri Dec 5 03:30:11 PST 2008


---
 spec/Channel_Interface_Group.xml |   67 ++++++++++++++++++++++++++++++++++++++
 1 files changed, 67 insertions(+), 0 deletions(-)

diff --git a/spec/Channel_Interface_Group.xml b/spec/Channel_Interface_Group.xml
index 08fa461..43ddefd 100644
--- a/spec/Channel_Interface_Group.xml
+++ b/spec/Channel_Interface_Group.xml
@@ -690,6 +690,73 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
       </tp:docstring>
     </signal>
 
+    <signal name="MembersChangedDetails"
+      tp:name-for-bindings="Members_Changed_Details">
+      <arg name="Added" type="au" tp:type="Contact_Handle[]">
+        <tp:docstring>
+          A list of members added to the channel
+        </tp:docstring>
+      </arg>
+      <arg name="Removed" type="au" tp:type="Contact_Handle[]">
+        <tp:docstring>
+          A list of members removed from the channel
+        </tp:docstring>
+      </arg>
+      <arg name="Local_Pending" type="au" tp:type="Contact_Handle[]">
+        <tp:docstring>
+          A list of members who are pending local approval
+        </tp:docstring>
+      </arg>
+      <arg name="Remote_Pending" type="au" tp:type="Contact_Handle[]">
+        <tp:docstring>
+          A list of members who are pending remote approval
+        </tp:docstring>
+      </arg>
+      <arg name="Details" type="a{sv}" tp:type="String_Variant_Map">
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+          <p>Information about the change, which may include the following
+            well-known keys:</p>
+
+          <dl>
+            <dt>actor (u — <tp:type>Contact_Handle</tp:type>)</dt>
+            <dd>The contact handle of the person who made the change; 0 or
+              omitted if unknown or not applicable.</dd>
+
+            <dt>change-reason (u — <tp:type>Channel_Group_Change_Reason</tp:type>)</dt>
+            <dd>A reason for the change.</dd>
+
+            <dt>message (s)</dt>
+            <dd>A string message from the server regarding the change</dd>
+
+            <dt>error (s — <tp:type>DBus_Error_Name</tp:type>)</dt>
+            <dd>A (possibly implementation-specific) DBus error describing the
+              change, providing more specific information than the
+              <tp:type>Channel_Group_Change_Reason</tp:type> enum allows. If
+              this key is present, 'change-reason' MUST be set to the closest
+              available reason.</dd>
+
+            <dt>debug-message (s)</dt>
+            <dd>Debugging information on the change. SHOULD NOT be shown to
+              users in normal circumstances.</dd>
+          </dl>
+        </tp:docstring>
+      </arg>
+      <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+        <p>Emitted when contacts join any of the three lists (members, local
+          pending or remote pending) or when they leave any of the three
+          lists.</p>
+
+        <p>All channel-specific handles that are mentioned in this signal
+          MUST be represented in the value of the HandleOwners property.
+          In practice, this will mean that HandleOwnersChanged is
+          emitted <em>before</em> emitting a MembersChanged signal in which
+          channel-specific handles are added, but that it is emitted
+          <em>after</em> emitting a MembersChanged signal in which
+          channel-specific handles are removed.</p>
+      </tp:docstring>
+      <tp:added version="0.17.UNRELEASED"/>
+    </signal>
+
     <method name="RemoveMembers" tp:name-for-bindings="Remove_Members">
       <arg direction="in" name="Contacts" type="au" tp:type="Contact_Handle[]">
         <tp:docstring>
-- 
1.5.6.5




More information about the Telepathy-commits mailing list