2
<node name="/Channel_Interface_Picture"
3
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
5
<tp:copyright>Copyright © 2010–2011 Collabora Ltd.</tp:copyright>
6
<tp:license xmlns="http://www.w3.org/1999/xhtml">
7
<p>This library is free software; you can redistribute it and/or
8
modify it under the terms of the GNU Lesser General Public
9
License as published by the Free Software Foundation; either
10
version 2.1 of the License, or (at your option) any later version.</p>
12
<p>This library is distributed in the hope that it will be useful,
13
but WITHOUT ANY WARRANTY; without even the implied warranty of
14
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
Lesser General Public License for more details.</p>
17
<p>You should have received a copy of the GNU Lesser General Public
18
License along with this library; if not, write to the Free Software
19
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23
<interface name="org.freedesktop.Telepathy.Channel.Interface.Picture1"
24
tp:causes-havoc="draft">
25
<tp:requires interface="org.freedesktop.Telepathy.Channel"/>
26
<tp:added version="0.25.0"/>
27
<annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal"
30
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
31
<p>An interface channels can implement to support a picture. Most
32
of the time this will be implemented by channels implementing
34
namespace="ofdT.Channel.Interface">Room2</tp:dbus-ref>
35
interface. Note that this interface is not restricted to
36
Text channels, and can also be used on Call channels.</p>
39
This is a separate interface from
40
<tp:dbus-ref namespace="ofdT.Channel.Interface">RoomConfig1</tp:dbus-ref>
41
because (a) it's possible some protocol might support pictures for
42
1:1 chats; and (b) it avoids downloading an unwanted picture in a
47
<method name="SetPicture" tp:name-for-bindings="Set_Picture">
48
<arg direction="in" type="ay" name="Picture">
49
<tp:docstring>The new picture.</tp:docstring>
51
<arg direction="in" type="s" name="MIME_Type">
52
<tp:docstring>The MIME type.</tp:docstring>
54
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
55
<p>Set the room's picture. Clients SHOULD look at the picture
56
flags before calling this method as the user might not have
57
permission to set the picture.</p>
59
<p>A successful return of this method indicates a successful
60
change in picture, but clients should still listen for changes
61
to the <tp:member-ref>Picture</tp:member-ref> property for
62
further changes by other users or the server.</p>
65
<tp:error name="org.freedesktop.Telepathy.Error.NotImplemented"/>
66
<tp:error name="org.freedesktop.Telepathy.Error.InvalidArgument">
68
Picture is somehow invalid: e.g. unsupported MIME type,
72
<tp:error name="org.freedesktop.Telepathy.Error.PermissionDenied"/>
76
<property name="Picture" tp:name-for-bindings="Picture"
77
type="(ays)" tp:type="Avatar" access="read">
78
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
79
<p>The picture representing this channel.</p>
81
<p>This property may change during the lifetime of the channel and
82
MUST not be included in a channel request.</p>
86
<property name="Actor" tp:name-for-bindings="Actor"
87
type="s" access="read">
88
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
89
<p>The normalized contact ID representing who last modified
90
the picture, or the empty string if it is not known.</p>
94
<property name="ActorHandle" tp:name-for-bindings="Actor_Handle"
95
type="u" tp:type="Contact_Handle" access="read">
96
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
97
<p>The handle corresponding to <tp:member-ref>Actor</tp:member-ref>,
98
or 0 if the <tp:member-ref>Actor</tp:member-ref> is unknown.</p>
102
<property name="Timestamp" tp:name-for-bindings="Timestamp"
103
type="x" tp:type="Unix_Timestamp64" access="read">
104
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
105
<p>A unix timestamp indicating when the picture was last
106
modified, or <code>INT_MAX64</code> if unknown.</p>
110
<property name="CanSet" tp:name-for-bindings="Can_Set"
111
type="b" access="read">
112
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
113
<p>TRUE if the <tp:member-ref>Picture</tp:member-ref> property
114
can be set by the user by calling
115
<tp:member-ref>SetPicture</tp:member-ref>, otherwise
118
<p>If implementations are unsure of what this value should be
119
it SHOULD still be set to what it believes the value
120
is. As a result, clients should be aware that
121
<tp:member-ref>SetPicture</tp:member-ref> can still fail
122
even with this property set to TRUE.</p>
126
<property name="SupportedMIMETypes"
127
tp:name-for-bindings="Supported_MIME_Types"
128
type="as" access="read" tp:immutable="yes">
130
An array of supported MIME types (e.g. "image/jpeg").
131
Clients MAY assume that the first type in this array is preferred.
135
<property name="MinimumHeight"
136
tp:name-for-bindings="Minimum_Height"
137
type="u" access="read" tp:immutable="yes">
139
The minimum height in pixels of the picture, which MAY be 0.
143
<property name="MinimumWidth"
144
tp:name-for-bindings="Minimum_Width"
145
type="u" access="read" tp:immutable="yes">
147
The minimum width in pixels of the picture, which MAY be 0.
151
<property name="RecommendedHeight"
152
tp:name-for-bindings="Recommended_Height"
153
type="u" access="read" tp:immutable="yes">
155
The recommended height in pixels of the picture, or 0 if
156
there is no preferred height.
160
<property name="RecommendedWidth"
161
tp:name-for-bindings="Recommended_Width"
162
type="u" access="read" tp:immutable="yes">
164
The recommended width in pixels of the picture, or 0 if
165
there is no preferred width.
169
<property name="MaximumHeight"
170
tp:name-for-bindings="Maximum_Height"
171
type="u" access="read" tp:immutable="yes">
173
The maximum height in pixels of the picture, or 0 if
178
<property name="MaximumWidth"
179
tp:name-for-bindings="Maximum_Width"
180
type="u" access="read" tp:immutable="yes">
182
The maximum width in pixels of the picture, or 0 if
187
<property name="MaximumBytes"
188
tp:name-for-bindings="Maximum_Bytes"
189
type="u" access="read" tp:immutable="yes">
191
The maximum size in bytes of the picture, or 0 if
198
<!-- vim:set sw=2 sts=2 et ft=xml: -->
added
removed
spec/Channel_Interface_Picture.xml
