2
<node name="/Channel_Interface_Hold" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3
<tp:copyright> Copyright (C) 2005, 2006 Collabora Limited </tp:copyright>
4
<tp:copyright> Copyright (C) 2005, 2006 Nokia Corporation </tp:copyright>
5
<tp:copyright> Copyright (C) 2006 INdT </tp:copyright>
6
<tp:license xmlns="http://www.w3.org/1999/xhtml">
7
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.
12
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
Library General Public License for more details.
17
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
<tp:enum name="Channel_Hold_State">
22
<tp:enumvalue suffix="None" value="0">
24
Neither the local user and the remote member are on hold, and media
25
is being sent bidirectionally.
28
<tp:enumvalue suffix="Send_Only" value="1">
30
The local user has put the remote member on hold, so is sending
31
media but has arranged not to receive any media streams.
34
<tp:enumvalue suffix="Recv_Only" value="2">
36
The user has been put on hold by the remote member, so is receiving
37
media but has arranged not to send any media streams.
40
<tp:enumvalue suffix="Both" value="3">
42
Both the local user and the remote member have agreed not to send
43
any media streams to each other.
47
<interface name="org.freedesktop.Telepathy.Channel.Interface.Hold">
48
<tp:requires interface="org.freedesktop.Telepathy.Channel"/>
49
<method name="GetHoldState">
50
<arg direction="in" name="member" type="u">
52
The contact handle for a member of the channel
55
<arg direction="out" type="u">
57
The member's current hold state as one of the values of
62
Given a member of the channel, return their current hold state.
65
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
66
<tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
69
<signal name="HoldStateChanged">
70
<arg name="member" type="u">
72
The integer handle of a member of the channel
75
<arg name="state" type="u">
77
An integer representing the new hold state
81
Emitted to indicate that the hold state (as defined in GetHoldState
82
above) has changed for a member of this channel. This may occur as
83
a consequence of you requesting a change with RequestHold, or the
84
state changing as a result of a request from the remote member
88
<method name="RequestHold">
89
<arg direction="in" name="member" type="u">
91
The contact handle for a member of the channel
94
<arg direction="in" name="hold" type="b">
96
A boolean indicating whether or not the user should be on hold
100
Request that a certain member be put on hold (be instructed not to send
101
any media streams to you) or be taken off hold. Success is indicated
102
by the HoldStateChanged signal being emitted.
105
<tp:error name="org.freedesktop.Telepathy.Error.Disconnected"/>
106
<tp:error name="org.freedesktop.Telepathy.Error.NetworkError"/>
107
<tp:error name="org.freedesktop.Telepathy.Error.InvalidHandle"/>
108
</tp:possible-errors>
110
<tp:docstring xmlns="http://www.w3.org/1999/xhtml">
111
<p>THIS INTERFACE IS DEPRECATED AND SHOULD NOT BE USED. Hold functionality
112
should be added to the StreamedMedia channel in due course.</p>
114
<p>Interface for channels where members may put you on hold, or you may put
115
members on hold. This usually only makes sense for channels where you are
116
streaming media to or from the members. Hold is defined as requesting
117
that you are not sent any media streams by another, so these states
118
indicate whether or not you are sending and receiving media streams
119
to each member of the channel.</p>
123
<!-- vim:set sw=2 sts=2 et ft=xml: -->
added
removed
spec/Channel_Interface_Hold.xml
