#include <TelepathyQt/Channel>

Inheritance diagram for Tp::Client::ChannelInterfaceTubeInterface:

Signals
void	TubeChannelStateChanged (uint state)

Signals inherited from Tp::AbstractInterface
void	propertiesChanged (const QVariantMap &changedProperties, const QStringList &invalidatedProperties)

Public Member Functions
	ChannelInterfaceTubeInterface (const QString &busName, const QString &objectPath, QObject *parent=0)

	ChannelInterfaceTubeInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)

	ChannelInterfaceTubeInterface (Tp::DBusProxy *proxy)

	ChannelInterfaceTubeInterface (const Tp::Client::ChannelInterface &mainInterface)

	ChannelInterfaceTubeInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)

Tp::PendingVariant *	requestPropertyParameters () const

Tp::PendingVariant *	requestPropertyState () const

Tp::PendingVariantMap *	requestAllProperties () const

Public Member Functions inherited from Tp::AbstractInterface
virtual	~AbstractInterface ()

bool	isValid () const

QString	invalidationReason () const

QString	invalidationMessage () const

void	setMonitorProperties (bool monitorProperties)

bool	isMonitoringProperties () const

Public Member Functions inherited from QDBusAbstractInterface
virtual	~QDBusAbstractInterface ()

bool	isValid () const

QDBusConnection	connection () const

QString	service () const

QString	path () const

QString	interface () const

QDBusError	lastError () const

void	setTimeout (int timeout)

int	timeout () const

QDBusMessage	call (const QString &method, const QVariant &arg1, const QVariant &arg2, const QVariant &arg3, const QVariant &arg4, const QVariant &arg5, const QVariant &arg6, const QVariant &arg7, const QVariant &arg8)

QDBusMessage	call (QDBus::CallMode mode, const QString &method, const QVariant &arg1, const QVariant &arg2, const QVariant &arg3, const QVariant &arg4, const QVariant &arg5, const QVariant &arg6, const QVariant &arg7, const QVariant &arg8)

QDBusMessage	callWithArgumentList (QDBus::CallMode mode, const QString &method, const QList< QVariant > &args)

bool	callWithCallback (const QString &method, const QList< QVariant > &args, QObject receiver, const char returnMethod, const char *errorMethod)

bool	callWithCallback (const QString &method, const QList< QVariant > &args, QObject receiver, const char slot)

QDBusPendingCall	asyncCall (const QString &method, const QVariant &arg1, const QVariant &arg2, const QVariant &arg3, const QVariant &arg4, const QVariant &arg5, const QVariant &arg6, const QVariant &arg7, const QVariant &arg8)

QDBusPendingCall	asyncCallWithArgumentList (const QString &method, const QList< QVariant > &args)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

virtual const QMetaObject *	metaObject () const

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	signalsBlocked () const

bool	blockSignals (bool block)

QThread *	thread () const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval)

void	killTimer (int id)

T	findChild (const QString &name) const

QList< T >	findChildren (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	destroyed (QObject *obj)

QObject *	parent () const

bool	inherits (const char *className) const

void	deleteLater ()

	QObject (QObject parent, const char name)

void	insertChild (QObject *object)

void	removeChild (QObject *object)

bool	isA (const char *className) const

const char *	className () const

const char *	name () const

const char *	name (const char *defaultName) const

void	setName (const char *name)

Static Public Member Functions
static QLatin1String	staticInterfaceName ()

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

Protected Member Functions
virtual void	invalidate (Tp::DBusProxy *, const QString &, const QString &)

Protected Member Functions inherited from Tp::AbstractInterface
	AbstractInterface (DBusProxy *proxy, const QLatin1String &interface)

	AbstractInterface (const QString &busName, const QString &path, const QLatin1String &interface, const QDBusConnection &connection, QObject *parent)

PendingVariant *	internalRequestProperty (const QString &name) const

PendingOperation *	internalSetProperty (const QString &name, const QVariant &newValue)

PendingVariantMap *	internalRequestAllProperties () const

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

bool	checkConnectArgs (const char signal, const QObject object, const char *method)

Additional Inherited Members
Protected Slots inherited from Tp::AbstractInterface
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

Detailed Description

Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Tube".

Constructor & Destructor Documentation

§ ChannelInterfaceTubeInterface() [1/5]

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.

Parameters

busName	Name of the service the object is on.
objectPath	Path to the object on the service.
parent	Passed to the parent class constructor.

§ ChannelInterfaceTubeInterface() [2/5]

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.

Parameters

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.

§ ChannelInterfaceTubeInterface() [3/5]

Tp::Client::ChannelInterfaceTubeInterface::ChannelInterfaceTubeInterface ( Tp::DBusProxy * proxy )

Creates a ChannelInterfaceTubeInterface associated with the same object as the given proxy.

Parameters

proxy The proxy to use. It will also be the QObject::parent() for this object.

§ ChannelInterfaceTubeInterface() [4/5]

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.

Parameters

mainInterface The proxy to use.

§ ChannelInterfaceTubeInterface() [5/5]

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.

Parameters

mainInterface	The proxy to use.
parent	Passed to the parent class constructor.

Member Function Documentation

§ staticInterfaceName()

static QLatin1String Tp::Client::ChannelInterfaceTubeInterface::staticInterfaceName ( )

inlinestatic

Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Tube", which this class represents.

Returns: The D-Bus interface name.

§ requestPropertyParameters()

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.

Returns: A pending variant which will emit finished when the property has been retrieved.

§ requestPropertyState()

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.

Returns: A pending variant which will emit finished when the property has been retrieved.

§ requestAllProperties()

Tp::PendingVariantMap* Tp::Client::ChannelInterfaceTubeInterface::requestAllProperties ( ) const

inline

Request all of the DBus properties on the interface.

Returns: A pending variant map which will emit finished when the properties have been retrieved.

§ TubeChannelStateChanged

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.

Parameters

state

The new state of the tube.

§ invalidate()

void Tp::Client::ChannelInterfaceTubeInterface::invalidate	(	Tp::DBusProxy *	proxy,
		const QString &	error,
		const QString &	message
	)

protectedvirtual

Reimplemented from Tp::AbstractInterface.

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

§ ChannelInterfaceTubeInterface() [1/5]

§ ChannelInterfaceTubeInterface() [2/5]

§ ChannelInterfaceTubeInterface() [3/5]

§ ChannelInterfaceTubeInterface() [4/5]

§ ChannelInterfaceTubeInterface() [5/5]

Member Function Documentation

§ staticInterfaceName()

§ requestPropertyParameters()

§ requestPropertyState()

§ requestAllProperties()

§ TubeChannelStateChanged

§ invalidate()