Tp::Client::ChannelRequestInterface Class Reference [ChannelRequest proxies]

#include <TelepathyQt4/ChannelRequest>

Inherits Tp::AbstractInterface.

List of all members.

Public Slots

• QDBusPendingReply Proceed ()
• QDBusPendingReply Cancel ()

Signals

• void Failed (const QString &error, const QString &message)
• void Succeeded ()

Public Member Functions

• ChannelRequestInterface (const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelRequestInterface (const QDBusConnection &connection, const QString &busName, const QString &objectPath, QObject *parent=0)
• ChannelRequestInterface (Tp::DBusProxy *proxy)
• TELEPATHY_QT4_DEPRECATED
  QDBusObjectPath Account () const
• Tp::PendingVariant * requestPropertyAccount () const
• TELEPATHY_QT4_DEPRECATED qlonglong UserActionTime () const
• Tp::PendingVariant * requestPropertyUserActionTime () const
• TELEPATHY_QT4_DEPRECATED QString PreferredHandler () const
• Tp::PendingVariant * requestPropertyPreferredHandler () const
• TELEPATHY_QT4_DEPRECATED
  Tp::QualifiedPropertyValueMapList Requests () const
• Tp::PendingVariant * requestPropertyRequests () const
• TELEPATHY_QT4_DEPRECATED
  QStringList Interfaces () const
• Tp::PendingVariant * requestPropertyInterfaces () 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

• QDBusObjectPath Account
• qlonglong UserActionTime
• QString PreferredHandler
• Tp::QualifiedPropertyValueMapList Requests
• QStringList Interfaces

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

Creates a ChannelRequestInterface 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::ChannelRequestInterface::ChannelRequestInterface	(	const QDBusConnection &	connection,
		const QString &	busName,
		const QString &	objectPath,
		QObject *	parent = 0
	)

Creates a ChannelRequestInterface 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::ChannelRequestInterface::ChannelRequestInterface

(

Tp::DBusProxy *

proxy

)

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

---

Member Function Documentation

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

(

)

[inline, static]

Returns the name of the interface "org.freedesktop.Telepathy.ChannelRequest", which this class represents.

Returns:

The D-Bus interface name.

TELEPATHY_QT4_DEPRECATED QDBusObjectPath Tp::Client::ChannelRequestInterface::Account

(

)

const [inline]

Getter for the remote object property "Account".

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

Returns:

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

Tp::PendingVariant* Tp::Client::ChannelRequestInterface::requestPropertyAccount

(

)

const [inline]

Asynchronous getter for the remote object property "Account" of type QDBusObjectPath.

The Account on which this request was made. This property cannot change.

Returns:

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

TELEPATHY_QT4_DEPRECATED qlonglong Tp::Client::ChannelRequestInterface::UserActionTime

(

)

const [inline]

Getter for the remote object property "UserActionTime".

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

Returns:

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

Tp::PendingVariant* Tp::Client::ChannelRequestInterface::requestPropertyUserActionTime

(

)

const [inline]

Asynchronous getter for the remote object property "UserActionTime" of type qlonglong.

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.

Returns:

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

TELEPATHY_QT4_DEPRECATED QString Tp::Client::ChannelRequestInterface::PreferredHandler

(

)

const [inline]

Getter for the remote object property "PreferredHandler".

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

Returns:

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

Tp::PendingVariant* Tp::Client::ChannelRequestInterface::requestPropertyPreferredHandler

(

)

const [inline]

Asynchronous getter for the remote object property "PreferredHandler" of type QString.

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.

Returns:

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

TELEPATHY_QT4_DEPRECATED Tp::QualifiedPropertyValueMapList Tp::Client::ChannelRequestInterface::Requests

(

)

const [inline]

Getter for the remote object property "Requests".

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

Returns:

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

Tp::PendingVariant* Tp::Client::ChannelRequestInterface::requestPropertyRequests

(

)

const [inline]

Asynchronous getter for the remote object property "Requests" of type Tp::QualifiedPropertyValueMapList.

An array of dictionaries containing desirable properties for the channel or channels to be created.

<tp:rationale>

This is an array so that we could add a CreateChannels method in future without redefining the API of ChannelRequest. </tp:rationale>

This property is set when the channel request is created, and can never change.

Returns:

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

TELEPATHY_QT4_DEPRECATED QStringList Tp::Client::ChannelRequestInterface::Interfaces

(

)

const [inline]

Getter for the remote object property "Interfaces".

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

Returns:

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

Tp::PendingVariant* Tp::Client::ChannelRequestInterface::requestPropertyInterfaces

(

)

const [inline]

Asynchronous getter for the remote object property "Interfaces" of type QStringList.

A list of the extra interfaces provided by this channel request. This property cannot change.

Returns:

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

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

QDBusPendingReply Tp::Client::ChannelRequestInterface::Proceed

(

)

[inline, slot]

Begins a call to the D-Bus method "Proceed" on the remote object.

Proceed with the channel request.

<tp:rationale>

The client that created this object calls this method when it has connected signal handlers for <tp:member-ref>Succeeded</tp:member-ref> and <tp:member-ref>Failed</tp:member-ref>. </tp:rationale>

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 <tp:member-ref>Failed</tp:member-ref> signal.

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.

QDBusPendingReply Tp::Client::ChannelRequestInterface::Cancel

(

)

[inline, slot]

Begins a call to the D-Bus method "Cancel" on the remote object.

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 <tp:member-ref>Failed</tp:member-ref> is emitted immediately, and the channel request is removed.

If the connection manager has already been asked to create a channel but has not produced one yet (e.g. if <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection.Interface.Requests.CreateChannel</tp:dbus-ref> has been called, but has not yet returned), then the ChannelDispatcher will remember that the request has been cancelled. When the channel appears, it will be closed (if it was newly created and can be closed), and will not be dispatched to a handler.

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 <tp:dbus-ref namespace="org.freedesktop.Telepathy.Channel">Close</tp:dbus-ref>; otherwise, the channel dispatcher will ignore it. In either case, <tp:member-ref>Failed</tp:member-ref> will be emitted when processing has been completed.

If <tp:member-ref>Failed</tp:member-ref> is emitted in response to this method, the error SHOULD be 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.

void Tp::Client::ChannelRequestInterface::Failed	(	const QString &	error,
		const QString &	message
	)			[signal]

Represents the signal "Failed" on the remote object.

The channel request has failed. It is no longer present, and further methods must not be called on it.

Parameters:

error

The name of a D-Bus error. This can come from various sources, including the error raised by <tp:dbus-ref namespace="org.freedesktop.Telepathy.Connection.Interface.Requests">CreateChannel</tp:dbus-ref>, or an error generated to represent failure to establish the <tp:dbus-ref namespace="org.freedesktop.Telepathy">Connection</tp:dbus-ref>.

Parameters:

message

If the first argument of the D-Bus error message was a string, that string. Otherwise, an empty string.

void Tp::Client::ChannelRequestInterface::Succeeded

(

)

[signal]

Represents the signal "Succeeded" on the remote object.

The channel request has succeeded. It is no longer present, and further methods must not be called on it.

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

Reimplemented from Tp::AbstractInterface.

---

Property Documentation

QDBusObjectPath Tp::Client::ChannelRequestInterface::Account [read]

Represents property "Account" on the remote object.

The Account on which this request was made. This property cannot change.

qlonglong Tp::Client::ChannelRequestInterface::UserActionTime [read]

Represents property "UserActionTime" on the remote object.

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.

QString Tp::Client::ChannelRequestInterface::PreferredHandler [read]

Represents property "PreferredHandler" on the remote object.

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.

Tp::QualifiedPropertyValueMapList Tp::Client::ChannelRequestInterface::Requests [read]

Represents property "Requests" on the remote object.

An array of dictionaries containing desirable properties for the channel or channels to be created.

<tp:rationale>

This is an array so that we could add a CreateChannels method in future without redefining the API of ChannelRequest. </tp:rationale>

This property is set when the channel request is created, and can never change.

QStringList Tp::Client::ChannelRequestInterface::Interfaces [read]

Represents property "Interfaces" on the remote object.

A list of the extra interfaces provided by this channel request. This property cannot change.