| Home · All Classes · All Namespaces · Modules · Functions · Files |
#include <TelepathyQt/Channel>
Inherits Tp::AbstractInterface.
Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Tube".
| Tp::Client::ChannelInterfaceTubeInterface::ChannelInterfaceTubeInterface | ( | const QString & | busName, |
| const QString & | objectPath, | ||
| QObject * | parent = 0 |
||
| ) |
Creates a ChannelInterfaceTubeInterface associated with the given object on the session bus.
| busName | Name of the service the object is on. |
| objectPath | Path to the object on the service. |
| parent | Passed to the parent class constructor. |
| Tp::Client::ChannelInterfaceTubeInterface::ChannelInterfaceTubeInterface | ( | const QDBusConnection & | connection, |
| const QString & | busName, | ||
| const QString & | objectPath, | ||
| QObject * | parent = 0 |
||
| ) |
Creates a ChannelInterfaceTubeInterface associated with the given object on the given bus.
| connection | The bus via which the object can be reached. |
| busName | Name of the service the object is on. |
| objectPath | Path to the object on the service. |
| parent | Passed to the parent class constructor. |
Creates a ChannelInterfaceTubeInterface associated with the same object as the given proxy.
| proxy | The proxy to use. It will also be the QObject::parent() for this object. |
| Tp::Client::ChannelInterfaceTubeInterface::ChannelInterfaceTubeInterface | ( | const Tp::Client::ChannelInterface & | mainInterface | ) | [explicit] |
Creates a ChannelInterfaceTubeInterface associated with the same object as the given proxy. Additionally, the created proxy will have the same parent as the given proxy.
| mainInterface | The proxy to use. |
| Tp::Client::ChannelInterfaceTubeInterface::ChannelInterfaceTubeInterface | ( | const Tp::Client::ChannelInterface & | mainInterface, |
| QObject * | parent | ||
| ) |
Creates a ChannelInterfaceTubeInterface associated with the same object as the given proxy. However, a different parent object can be specified.
| mainInterface | The proxy to use. |
| parent | Passed to the parent class constructor. |
| static QLatin1String Tp::Client::ChannelInterfaceTubeInterface::staticInterfaceName | ( | ) | [inline, static] |
Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Tube", which this class represents.
| Tp::PendingVariant* Tp::Client::ChannelInterfaceTubeInterface::requestPropertyParameters | ( | ) | const [inline] |
Asynchronous getter for the remote object property Parameters of type QVariantMap.
Each tube has a dictionary of arbitrary parameters. Parameters are commonly used to bootstrap legacy protocols where you can't negotiate parameters in-band. The allowable keys, types and values are defined by the service, but connection managers must support the value being a string (D-Bus type 's'), array of bytes (D-Bus type 'ay'), unsigned integer (D-Bus type 'u'), integer (D-Bus type 'i') and boolean (D-Bus type 'b').
When the tube is offered, the parameters are transmitted with the offer and appear as a property of the incoming tube for other participants.
For example, a stream tube for ChannelTypeStreamTubeInterface::Service "smb" (Server Message Block over TCP/IP) might use the following properties, as defined in DNS SRV (RFC 2782) Service Types:
{ 'u': 'some-username',
'p': 'top-secret-password',
'path': '/etc/passwd',
}
When requesting a tube with ConnectionInterfaceRequestsInterface::CreateChannel() , this property MUST NOT be included in the request; instead, it is set when ChannelTypeStreamTubeInterface::Offer() or ChannelTypeDBusTubeInterface::Offer() (as appropriate) is called. Its value is undefined until the tube is offered; once set, its value MUST NOT change.
When receiving an incoming tube, this property is immutable and so advertised in the ConnectionInterfaceRequestsInterface::NewChannels() signal.
| Tp::PendingVariant* Tp::Client::ChannelInterfaceTubeInterface::requestPropertyState | ( | ) | const [inline] |
Asynchronous getter for the remote object property State of type uint.
State of the tube in this channel.
When requesting a tube with ConnectionInterfaceRequestsInterface::CreateChannel() , this property MUST NOT be included in the request.
| Tp::PendingVariantMap* Tp::Client::ChannelInterfaceTubeInterface::requestAllProperties | ( | ) | const [inline] |
Request all of the DBus properties on the interface.
| void Tp::Client::ChannelInterfaceTubeInterface::TubeChannelStateChanged | ( | uint | state | ) | [signal] |
Represents the signal TubeChannelStateChanged on the remote object.
Emitted when the state of the tube channel changes. Valid state transitions are documented with Tube_Channel_State.
| state | The new state of the tube. |
| void Tp::Client::ChannelInterfaceTubeInterface::invalidate | ( | Tp::DBusProxy * | proxy, |
| const QString & | error, | ||
| const QString & | message | ||
| ) | [protected, virtual] |
Reimplemented from Tp::AbstractInterface.
| Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation | Telepathy-Qt 0.9.3 |