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.
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.
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.
A channel request is an object in the
Its well-known bus name is the same as that of the ChannelDispatcher,
"org.freedesktop.Telepathy.ChannelDispatcher"
.
See
A channel request can be cancelled by any client (not just the one
that requested it). This means that the ChannelDispatcher will
The time at which user action occurred, or 0 if this channel request is for some reason not involving user action.
This property is set when the channel request is created, and can never change.
Either the well-known bus name (starting with
org.freedesktop.Telepathy.Client.
)
of the preferred handler for this
channel, or an empty string to indicate that any handler would be
acceptable.
This property is set when the channel request is created, and can never change.
An array of dictionaries containing desirable properties for the channel or channels to be created.
This is an array so that we could add a CreateChannels method in future without redefining the API of ChannelRequest.
This property is set when the channel request is created, and can never change.
Proceed with the channel request.
The client that created this object calls this method
when it has connected signal handlers for
Clients other than the client which created the ChannelRequest MUST NOT call this method.
This method SHOULD return immediately; on success, the request
might still fail, but this will be indicated asynchronously
by the
Proceed cannot fail, unless clients have got the life-cycle of a ChannelRequest seriously wrong (e.g. a client calls this method twice, or a client that did not create the ChannelRequest calls this method). If it fails, clients SHOULD assume that the whole ChannelRequest has become useless.
Cancel the channel request. The precise effect depends on the current progress of the request.
If the connection manager has not already been asked to create
a channel, then
If the connection manager has already been asked to create a
channel but has not produced one yet (e.g. if
If the connection manager has already returned a channel, but the
channel has not yet been dispatched to a handler
then the channel dispatcher will not dispatch that
channel to a handler. If the channel was newly created for this
request, the channel dispatcher will close it with
If org.freedesktop.Telepathy.Error.Cancelled
.
If the channel has already been dispatched to a handler, then it's too late to call this method, and the channel request will no longer exist.
The channel request has failed. It is no longer present, and further methods must not be called on it.
The name of a D-Bus error. This can come from various sources,
including the error raised by
The channel request has succeeded. It is no longer present, and further methods must not be called on it.
A dictionary of metadata provided by the channel requester, which the handler and other clients MAY choose to interpret. Clients MAY choose to use platform-specific keys for their own purposes, but MUST ignore unknown keys and MUST cope with expected keys being missing. Clients SHOULD namespace hint names by having them start with a reversed domain name, in the same way as D-Bus interface names.
The channel dispatcher does not currently interpret any of these
hints: they are solely for communication between cooperating
clients. If hints that do affect the channel dispatcher are added in
future, their names will start with an appropriate reversed domain
name (e.g. org.freedesktop.Telepathy
for hints defined
by this specification, or an appropriate vendor name for third-party
plugins).
This property may be set when the channel request is created, and
can never change. Since it is immutable, it SHOULD be included in the
dictionary of properties passed to
The following standardised hints are defined:
Variant of the
This signal MUST be emitted if the
The Connection owning the channel.
A subset of the Connection's properties, currently unused. This parameter may be used in future.
The channel which has been created.
The same immutable properties of the Channel that would appear
in a