Tp::Client::ChannelInterfaceServicePointInterface Class Reference [Channel proxies]

#include <TelepathyQt4/Channel>

Inherits Tp::AbstractInterface.

List of all members.

Signals

• void ServicePointChanged (const Tp::ServicePoint &servicePoint)

Public Member Functions

• ChannelInterfaceServicePointInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelInterfaceServicePointInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelInterfaceServicePointInterface (Tp::DBusProxy *proxy)
• ChannelInterfaceServicePointInterface (const Tp::Client::ChannelInterface &mainInterface)
• ChannelInterfaceServicePointInterface (const Tp::Client::ChannelInterface &mainInterface, QObject *parent)
• TELEPATHY_QT4_DEPRECATED
  Tp::ServicePoint InitialServicePoint () const
• Tp::PendingVariant * requestPropertyInitialServicePoint () const
• TELEPATHY_QT4_DEPRECATED
  Tp::ServicePoint CurrentServicePoint () const
• Tp::PendingVariant * requestPropertyCurrentServicePoint () const
• Tp::PendingVariantMap * requestAllProperties () const

Static Public Member Functions

• static const char * staticInterfaceName ()

Protected Member Functions

• virtual void invalidate (Tp::DBusProxy *, const QString &, const QString &)

Properties

• Tp::ServicePoint InitialServicePoint
• Tp::ServicePoint CurrentServicePoint

---

Detailed Description

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

---

Constructor & Destructor Documentation

Tp::Client::ChannelInterfaceServicePointInterface::ChannelInterfaceServicePointInterface	(	const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ChannelInterfaceServicePointInterface 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.

Tp::Client::ChannelInterfaceServicePointInterface::ChannelInterfaceServicePointInterface	(	const QDBusConnection &	connection,
		const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ChannelInterfaceServicePointInterface 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.

Tp::Client::ChannelInterfaceServicePointInterface::ChannelInterfaceServicePointInterface

(

Tp::DBusProxy *

proxy

)

Creates a ChannelInterfaceServicePointInterface 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.

Tp::Client::ChannelInterfaceServicePointInterface::ChannelInterfaceServicePointInterface

(

const Tp::Client::ChannelInterface &

mainInterface

)

[explicit]

Creates a ChannelInterfaceServicePointInterface 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.

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

Creates a ChannelInterfaceServicePointInterface 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

static const char* Tp::Client::ChannelInterfaceServicePointInterface::staticInterfaceName

(

)

[inline, static]

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

Returns:

The D-Bus interface name.

TELEPATHY_QT4_DEPRECATED Tp::ServicePoint Tp::Client::ChannelInterfaceServicePointInterface::InitialServicePoint

(

)

const [inline]

Getter for the remote object property "InitialServicePoint".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyInitialServicePoint() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ChannelInterfaceServicePointInterface::requestPropertyInitialServicePoint

(

)

const [inline]

Asynchronous getter for the remote object property "InitialServicePoint" of type Tp::ServicePoint.

This property is used to indicate that the channel target is a well-known service point. Please note that the CM (or lower layers of the stack or network) may forward the connection to other other service points, which the CM SHOULD indicate via <tp:member-ref>ServicePointChanged</tp:member-ref> signal.

This property SHOULD be set for channel requests that are specifically targeting service points.

Returns:

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

TELEPATHY_QT4_DEPRECATED Tp::ServicePoint Tp::Client::ChannelInterfaceServicePointInterface::CurrentServicePoint

(

)

const [inline]

Getter for the remote object property "CurrentServicePoint".

Don't use this: it blocks the main loop. Use the asynchronous requestPropertyCurrentServicePoint() instead.

Returns:

The value of the property, or a default-constructed value if the property is not readable.

Tp::PendingVariant* Tp::Client::ChannelInterfaceServicePointInterface::requestPropertyCurrentServicePoint

(

)

const [inline]

Asynchronous getter for the remote object property "CurrentServicePoint" of type Tp::ServicePoint.

The service point that the channel is connected to. If the channel is not connected to a service point, the CM MUST set the Service_Point_Type field to None; for instance, this will be the case for ordinary calls.

Returns:

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

Tp::PendingVariantMap* Tp::Client::ChannelInterfaceServicePointInterface::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.

void Tp::Client::ChannelInterfaceServicePointInterface::ServicePointChanged

(

const Tp::ServicePoint &

servicePoint

)

[signal]

Represents the signal "ServicePointChanged" on the remote object.

Emitted when a channel changes the service point that it's connected to. This might be a new call being connected to a service, a call connected to a service being routed to a different service (ie, an emergency call being routed from a generic emergency PSAP to a poison control PSAP), or any number of other things. Note that this should be emitted as soon as the CM has been notified of the switch, and has updated its internal state. The CM MAY still be in the process of connecting to the new service point.

Parameters:

servicePoint

The new service point that is being used.

void Tp::Client::ChannelInterfaceServicePointInterface::invalidate	(	Tp::DBusProxy *	proxy,
		const QString &	error,
		const QString &	message
	)			[protected, virtual]

Reimplemented from Tp::AbstractInterface.

---

Property Documentation

Tp::ServicePoint Tp::Client::ChannelInterfaceServicePointInterface::InitialServicePoint [read]

Represents property "InitialServicePoint" on the remote object.

This property is used to indicate that the channel target is a well-known service point. Please note that the CM (or lower layers of the stack or network) may forward the connection to other other service points, which the CM SHOULD indicate via <tp:member-ref>ServicePointChanged</tp:member-ref> signal.

This property SHOULD be set for channel requests that are specifically targeting service points.

Tp::ServicePoint Tp::Client::ChannelInterfaceServicePointInterface::CurrentServicePoint [read]

Represents property "CurrentServicePoint" on the remote object.

The service point that the channel is connected to. If the channel is not connected to a service point, the CM MUST set the Service_Point_Type field to None; for instance, this will be the case for ordinary calls.