[Telepathy-commits] [telepathy-qt4/master] Add details of changes to Channel::close() to API Docs.
george.goldberg at collabora.co.uk
Wed Nov 5 06:34:07 PST 2008
TelepathyQt4/cli-channel.h | 6 ++++++
1 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/TelepathyQt4/cli-channel.h b/TelepathyQt4/cli-channel.h
index 1142b2c..b775cbf 100644
@@ -195,6 +195,12 @@ public Q_SLOTS:
* to know if an error occurs when closing the channel, then you should
* use the returned object.
+ * A channel can be closed if its Readiness is ReadinessJustCreated or
+ * ReadinessFull. It cannot be closed if its Readiness is already
+ * ReadinessDead. If this method is called on a channel which is already
+ * in the ReadinessDead state, a DBus error of type
+ * TELEPATHY_ERROR_NOT_AVAILABLE will be returned.
* \return QDBusPendingReply object for the call to Close() on the Channel
More information about the Telepathy-commits