Home · All Classes · All Namespaces · Modules · Functions · Files
Public Member Functions | List of all members
Tp::PendingChannel Class Reference

The PendingChannel class represents the parameters of and the reply to an asynchronous channel request. More...

#include <TelepathyQt/PendingChannel>

Inheritance diagram for Tp::PendingChannel:
Inheritance graph
[legend]

Public Member Functions

 ~PendingChannel ()
 
ConnectionPtr connection () const
 
bool yours () const
 
const QStringchannelType () const
 
uint targetHandleType () const
 
uint targetHandle () const
 
QVariantMap immutableProperties () const
 
ChannelPtr channel () const
 
HandledChannelNotifierhandledChannelNotifier () const
 
- Public Member Functions inherited from Tp::PendingOperation
virtual ~PendingOperation ()
 
bool isFinished () const
 
bool isValid () const
 
bool isError () const
 
QString errorName () const
 
QString errorMessage () const
 
- 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 QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval)
 
void killTimer (int id)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QObjectchild (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< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
QObjectparent () 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)
 

Additional Inherited Members

- Signals inherited from Tp::PendingOperation
void finished (Tp::PendingOperation *operation)
 
- 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 Slots inherited from Tp::PendingOperation
void setFinished ()
 
void setFinishedWithError (const QString &name, const QString &message)
 
void setFinishedWithError (const QDBusError &error)
 
- Protected Member Functions inherited from Tp::PendingOperation
 PendingOperation (const SharedPtr< RefCounted > &object)
 
SharedPtr< RefCountedobject () const
 
- Protected Member Functions inherited from QObject
QObjectsender () 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)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

The PendingChannel class represents the parameters of and the reply to an asynchronous channel request.

Instances of this class cannot be constructed directly; the only way to get one is trough Connection or Account.

See Asynchronous Object Model

Constructor & Destructor Documentation

Tp::PendingChannel::~PendingChannel ( )

Class destructor.

Member Function Documentation

ConnectionPtr Tp::PendingChannel::connection ( ) const

Return the connection through which the channel request was made.

Note that if this channel request was created through Account, a null ConnectionPtr will be returned.

Returns
A pointer to the Connection object.
bool Tp::PendingChannel::yours ( ) const

Return whether this channel belongs to this process.

If false, the caller must assume that some other process is handling this channel; if true, the caller should handle it themselves or delegate it to another client.

Returns
true if it belongs, false otherwise.
const QString & Tp::PendingChannel::channelType ( ) const

Return the channel type specified in the channel request.

Returns
The D-Bus interface name for the type of the channel.
uint Tp::PendingChannel::targetHandleType ( ) const

If the channel request has finished, return the handle type of the resulting channel. Otherwise, return the handle type that was requested.

(One example of a request producing a different target handle type is that on protocols like MSN, one-to-one conversations don't really exist, and if you request a text channel with handle type HandleTypeContact, what you will actually get is a text channel with handle type HandleTypeNone, with the requested contact as a member.)

Returns
The target handle type as HandleType.
See also
targetHandle()
uint Tp::PendingChannel::targetHandle ( ) const

If the channel request has finished, return the target handle of the resulting channel. Otherwise, return the target handle that was requested (which might be different in some situations - see targetHandleType()).

Returns
An integer representing the target handle, which is of the type targetHandleType() indicates.
See also
targetHandleType()
QVariantMap Tp::PendingChannel::immutableProperties ( ) const

If this channel request has finished, return the immutable properties of the resulting channel. Otherwise, return an empty map.

The keys and values in this map are defined by the Telepathy specification, or by third-party extensions to that specification. These are the properties that cannot change over the lifetime of the channel; they're announced in the result of the request, for efficiency. This map should be passed to the constructor of Channel or its subclasses (such as TextChannel).

These properties can also be used to process channels in a way that does not require the creation of a Channel object - for instance, a ChannelDispatcher implementation should be able to classify and process channels based on their immutable properties, without needing to create Channel objects.

Returns
The immutable properties as QVariantMap.
ChannelPtr Tp::PendingChannel::channel ( ) const

Return the channel resulting from the channel request.

Returns
A pointer to the Channel object.
HandledChannelNotifier * Tp::PendingChannel::handledChannelNotifier ( ) const

If this channel request has finished and was created through Account, return a HandledChannelNotifier object that will keep track of channel() being re-requested.

Returns
A HandledChannelNotifier instance, or 0 if an error occurred.


Copyright © 2008-2011 Collabora Ltd. and Nokia Corporation
Telepathy-Qt 0.9.6.1