1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
<?xml version="1.0" ?>
<node name="/Channel_Interface_Subject"
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="im.telepathy1.Channel.Interface.Subject1">
<tp:requires interface="im.telepathy1.Channel"/>
<tp:added version="0.24.0">(version 2)</tp:added>
<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 subjects. Most
of the time this will be implemented by channels implementing
the <tp:dbus-ref
namespace="imt1.Channel.Interface">Room1</tp:dbus-ref>
interface, but some protocols support subjects in 1-to-1 chats
(such as XMPP). Note that this interface is not restricted to
Text channels, and can also be used on Call channels.</p>
</tp:docstring>
<method name="SetSubject" tp:name-for-bindings="Set_Subject">
<arg direction="in" type="s" name="Subject">
<tp:docstring>The new subject.</tp:docstring>
</arg>
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>Set the room's subject. Clients SHOULD look at the subject
flags before calling this method as the user might not have
permission to set the subject.</p>
<p>A successful return of this method indicates a successful
change in subject, but clients should still listen for changes
to the <tp:member-ref>Subject</tp:member-ref> property for
further changes by other users or the server.</p>
</tp:docstring>
<tp:possible-errors>
<tp:error name="im.telepathy1.Error.NotImplemented"/>
<tp:error name="im.telepathy1.Error.PermissionDenied"/>
</tp:possible-errors>
</method>
<property name="Subject" tp:name-for-bindings="Subject"
type="s" access="read">
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
<p>The human-readable subject on the channel such as the topic
in an IRC channel, or the room name in XMPP MUCs.</p>
<tp:rationale>This property replaces the subject Telepathy
property of Text channels, as Telepathy properties are soon to
be deprecated completely.</tp:rationale>
<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 subject, or the empty string if it is not known.</p>
<tp:rationale>This property replaces the subject-contact
Telepathy property of Text channels, as Telepathy properties
are soon to be deprecated completely.</tp:rationale>
</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 subject was last
modified, or <code>INT_MAX64</code> if unknown.</p>
<tp:rationale>This property replaces the subject-timestamp
Telepathy property of Text channels, as Telepathy properties
are soon to be deprecated completely.</tp:rationale>
</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>Subject</tp:member-ref> property
can be set by the user by calling
<tp:member-ref>SetSubject</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>SetSubject</tp:member-ref> can still fail
even with this property set to TRUE.</p>
<tp:rationale>In XMPP it is impossible to know whether an
occupant can set the subject as XMPP server implementations
are wildly inconsistent.</tp:rationale>
</tp:docstring>
</property>
</interface>
</node>
<!-- vim:set sw=2 sts=2 et ft=xml: -->
|
