summaryrefslogtreecommitdiff
path: root/spec
diff options
context:
space:
mode:
authorDanielle Madeley <danielle.madeley@collabora.co.uk>2011-11-07 22:28:57 +1100
committerDanielle Madeley <danielle.madeley@collabora.co.uk>2011-11-07 22:28:57 +1100
commitee528117e702687d2735405dacdb215a772326f5 (patch)
tree1e7bf50814dda9fcfe88347c1f1068b70252914c /spec
parentac4ec7d761609c4958688b171f45f9bfbec43c06 (diff)
parent1ccc4d5392b89cbc67f85c9ae630f183bdc59d29 (diff)
Merge branch 'roomconfig-42653'
Diffstat (limited to 'spec')
-rw-r--r--spec/spec/Account_Interface_Avatar.xml3
-rw-r--r--spec/spec/Channel_Interface_Password.xml7
-rw-r--r--spec/spec/Channel_Interface_Picture.xml198
-rw-r--r--spec/spec/Channel_Interface_Room.xml31
-rw-r--r--spec/spec/Channel_Interface_Room_Config.xml19
-rw-r--r--spec/spec/all.xml1
6 files changed, 259 insertions, 0 deletions
diff --git a/spec/spec/Account_Interface_Avatar.xml b/spec/spec/Account_Interface_Avatar.xml
index a8b78c8a2..a6c516727 100644
--- a/spec/spec/Account_Interface_Avatar.xml
+++ b/spec/spec/Account_Interface_Avatar.xml
@@ -40,6 +40,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
<tp:struct name="Avatar">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>A struct containing avatar data marked with its MIME type.</p>
+
+ <p>May be set to an empty byte-array and an empty string, indicating
+ no avatar.</p>
</tp:docstring>
<tp:member type="ay" name="Avatar_Data"/>
<tp:member type="s" name="MIME_Type"/>
diff --git a/spec/spec/Channel_Interface_Password.xml b/spec/spec/Channel_Interface_Password.xml
index 8aec20015..57991aad2 100644
--- a/spec/spec/Channel_Interface_Password.xml
+++ b/spec/spec/Channel_Interface_Password.xml
@@ -29,6 +29,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
called now for the user to join the channel
</tp:docstring>
</tp:flag>
+ <tp:flag suffix="Hint" value="4">
+ <tp:added version="UNRELEASED"/>
+ <tp:docstring>
+ The <tp:dbus-ref namespace="ofdT.Channel.Interface">RoomConfig1.PasswordHint</tp:dbus-ref>
+ contains a hint for the password.
+ </tp:docstring>
+ </tp:flag>
</tp:flags>
<method name="GetPasswordFlags" tp:name-for-bindings="Get_Password_Flags">
<arg direction="out" type="u" tp:type="Channel_Password_Flags"
diff --git a/spec/spec/Channel_Interface_Picture.xml b/spec/spec/Channel_Interface_Picture.xml
new file mode 100644
index 000000000..883878e25
--- /dev/null
+++ b/spec/spec/Channel_Interface_Picture.xml
@@ -0,0 +1,198 @@
+<?xml version="1.0" ?>
+<node name="/Channel_Interface_Picture"
+ xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+
+ <tp:copyright>Copyright © 2010–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="org.freedesktop.Telepathy.Channel.Interface.Picture1"
+ tp:causes-havoc="draft">
+ <tp:requires interface="org.freedesktop.Telepathy.Channel"/>
+ <tp:added version="UNRELEASED"/>
+ <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal"
+ value="true"/>
+
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>An interface channels can implement to support a picture. Most
+ of the time this will be implemented by channels implementing
+ the <tp:dbus-ref
+ namespace="ofdT.Channel.Interface">Room2</tp:dbus-ref>
+ interface. Note that this interface is not restricted to
+ Text channels, and can also be used on Call channels.</p>
+
+ <tp:rationale>
+ This is a separate interface from
+ <tp:dbus-ref namespace="ofdT.Channel.Interface">RoomConfig1</tp:dbus-ref>
+ because (a) it's possible some protocol might support pictures for
+ 1:1 chats; and (b) it avoids downloading an unwanted picture in a
+ GetAll request.
+ </tp:rationale>
+ </tp:docstring>
+
+ <method name="SetPicture" tp:name-for-bindings="Set_Picture">
+ <arg direction="in" type="ay" name="Picture">
+ <tp:docstring>The new picture.</tp:docstring>
+ </arg>
+ <arg direction="in" type="s" name="MIME_Type">
+ <tp:docstring>The MIME type.</tp:docstring>
+ </arg>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>Set the room's picture. Clients SHOULD look at the picture
+ flags before calling this method as the user might not have
+ permission to set the picture.</p>
+
+ <p>A successful return of this method indicates a successful
+ change in picture, but clients should still listen for changes
+ to the <tp:member-ref>Picture</tp:member-ref> property for
+ further changes by other users or the server.</p>
+ </tp:docstring>
+ <tp:possible-errors>
+ <tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"/>
+ <tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
+ <tp:docstring>
+ Picture is somehow invalid: e.g. unsupported MIME type,
+ too big, etc.
+ </tp:docstring>
+ </tp:error>
+ <tp:error name="org.freedesktop.Telepathy.Error.PermissionDenied"/>
+ </tp:possible-errors>
+ </method>
+
+ <property name="Picture" tp:name-for-bindings="Picture"
+ type="(ays)" tp:type="Avatar" access="read">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The picture representing this channel.</p>
+
+ <p>This property may change during the lifetime of the channel and
+ MUST not be included in a channel request.</p>
+ </tp:docstring>
+ </property>
+
+ <property name="Actor" tp:name-for-bindings="Actor"
+ type="s" access="read">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The normalized contact ID representing who last modified
+ the picture, or the empty string if it is not known.</p>
+ </tp:docstring>
+ </property>
+
+ <property name="ActorHandle" tp:name-for-bindings="Actor_Handle"
+ type="u" tp:type="Contact_Handle" access="read">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>The handle corresponding to <tp:member-ref>Actor</tp:member-ref>,
+ or 0 if the <tp:member-ref>Actor</tp:member-ref> is unknown.</p>
+ </tp:docstring>
+ </property>
+
+ <property name="Timestamp" tp:name-for-bindings="Timestamp"
+ type="x" tp:type="Unix_Timestamp64" access="read">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>A unix timestamp indicating when the picture was last
+ modified, or <code>INT_MAX64</code> if unknown.</p>
+ </tp:docstring>
+ </property>
+
+ <property name="CanSet" tp:name-for-bindings="Can_Set"
+ type="b" access="read">
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>TRUE if the <tp:member-ref>Picture</tp:member-ref> property
+ can be set by the user by calling
+ <tp:member-ref>SetPicture</tp:member-ref>, otherwise
+ FALSE.</p>
+
+ <p>If implementations are unsure of what this value should be
+ it SHOULD still be set to what it believes the value
+ is. As a result, clients should be aware that
+ <tp:member-ref>SetPicture</tp:member-ref> can still fail
+ even with this property set to TRUE.</p>
+ </tp:docstring>
+ </property>
+
+ <property name="SupportedMIMETypes"
+ tp:name-for-bindings="Supported_MIME_Types"
+ type="as" access="read" tp:immutable="yes">
+ <tp:docstring>
+ An array of supported MIME types (e.g. "image/jpeg").
+ Clients MAY assume that the first type in this array is preferred.
+ </tp:docstring>
+ </property>
+
+ <property name="MinimumHeight"
+ tp:name-for-bindings="Minimum_Height"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The minimum height in pixels of the picture, which MAY be 0.
+ </tp:docstring>
+ </property>
+
+ <property name="MinimumWidth"
+ tp:name-for-bindings="Minimum_Width"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The minimum width in pixels of the picture, which MAY be 0.
+ </tp:docstring>
+ </property>
+
+ <property name="RecommendedHeight"
+ tp:name-for-bindings="Recommended_Height"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The recommended height in pixels of the picture, or 0 if
+ there is no preferred height.
+ </tp:docstring>
+ </property>
+
+ <property name="RecommendedWidth"
+ tp:name-for-bindings="Recommended_Width"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The recommended width in pixels of the picture, or 0 if
+ there is no preferred width.
+ </tp:docstring>
+ </property>
+
+ <property name="MaximumHeight"
+ tp:name-for-bindings="Maximum_Height"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The maximum height in pixels of the picture, or 0 if
+ there is no limit.
+ </tp:docstring>
+ </property>
+
+ <property name="MaximumWidth"
+ tp:name-for-bindings="Maximum_Width"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The maximum width in pixels of the picture, or 0 if
+ there is no limit.
+ </tp:docstring>
+ </property>
+
+ <property name="MaximumBytes"
+ tp:name-for-bindings="Maximum_Bytes"
+ type="u" access="read" tp:immutable="yes">
+ <tp:docstring>
+ The maximum size in bytes of the picture, or 0 if
+ there is no limit.
+ </tp:docstring>
+ </property>
+
+ </interface>
+</node>
+<!-- vim:set sw=2 sts=2 et ft=xml: -->
diff --git a/spec/spec/Channel_Interface_Room.xml b/spec/spec/Channel_Interface_Room.xml
index 8f3d3c150..6b3c6c891 100644
--- a/spec/spec/Channel_Interface_Room.xml
+++ b/spec/spec/Channel_Interface_Room.xml
@@ -332,6 +332,37 @@
and only if non-empty values are supported.</p>
</tp:docstring>
</property>
+
+ <property name="Creator" tp:name-for-bindings="Creator"
+ type="s" access="read" tp:immutable="yes">
+ <tp:added version="UNRELEASED"/>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ The normalized contact ID representing who created the room; or
+ the empty string if unknown.
+ </tp:docstring>
+ </property>
+
+ <property name="CreatorHandle" tp:name-for-bindings="Creator_Handle"
+ type="u" tp:type="Contact_Handle" access="read"
+ tp:immutable="yes">
+ <tp:added version="UNRELEASED"/>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ The handle corresponding to <tp:member-ref>Creator</tp:member-ref>;
+ or 0 if <tp:member-ref>Creator</tp:member-ref> is unknown.
+ </tp:docstring>
+ </property>
+
+ <property name="CreationTimestamp"
+ tp:name-for-bindings="Creation_Timestamp"
+ type="x" tp:type="Unix_Timestamp64" access="read"
+ tp:immutable="yes">
+ <tp:added version="UNRELEASED"/>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ A unix timestamp indicating when the room was created; or
+ <code>INT_MAX64</code> if unknown.
+ </tp:docstring>
+ </property>
+
</interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->
diff --git a/spec/spec/Channel_Interface_Room_Config.xml b/spec/spec/Channel_Interface_Room_Config.xml
index 2ae7f1fd8..4ceec3f2b 100644
--- a/spec/spec/Channel_Interface_Room_Config.xml
+++ b/spec/spec/Channel_Interface_Room_Config.xml
@@ -132,6 +132,25 @@
</tp:docstring>
</property>
+ <property name="PasswordHint" tp:name-for-bindings="Password_Hint"
+ type="s" access="read">
+ <tp:added version="UNRELEASED"/>
+ <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+ <p>If <tp:member-ref>PasswordProtected</tp:member-ref> is
+ <code>True</code>, an optional hint for the password.</p>
+
+ <p>On protocols supporting PasswordHint (indicated by its presence
+ in <tp:member-ref>MutableProperties</tp:member-ref>),
+ <tp:member-ref>Password</tp:member-ref> and PasswordHint MUST be
+ set in a single call to
+ <tp:member-ref>UpdateConfiguration</tp:member-ref>.</p>
+
+ <tp:rationale>
+ Skype requires that the password and its hint be supplied together.
+ </tp:rationale>
+ </tp:docstring>
+ </property>
+
<property name="CanUpdateConfiguration" type="b" access="read"
tp:name-for-bindings="Can_Update_Configuration">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
diff --git a/spec/spec/all.xml b/spec/spec/all.xml
index 4a2ab1456..dfa1cb474 100644
--- a/spec/spec/all.xml
+++ b/spec/spec/all.xml
@@ -171,6 +171,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</
<xi:include href="Channel_Interface_Securable.xml"/>
<xi:include href="Channel_Interface_Service_Point.xml"/>
<xi:include href="Channel_Interface_Subject.xml"/>
+ <xi:include href="Channel_Interface_Picture.xml"/>
<xi:include href="Channel_Interface_Tube.xml"/>
<tp:section name="Text-specific interfaces">