From 4853beb4fbd0e618007649ffa1dc2a4b059af2ac Mon Sep 17 00:00:00 2001 From: Morgan Collett Date: Tue, 2 Oct 2007 10:56:36 +0100 Subject: [PATCH] Document get_channels --- sugar/presence/activity.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/sugar/presence/activity.py b/sugar/presence/activity.py index 8e536af0..ad5c4ca2 100644 --- a/sugar/presence/activity.py +++ b/sugar/presence/activity.py @@ -244,9 +244,13 @@ class Activity(gobject.GObject): def get_channels(self): """Retrieve communications channel descriptions for the activity - Returns (bus name, connection, channels) for the activity - - XXX what are those values? + Returns a tuple containing: + - the D-Bus well-known service name of the connection + (FIXME: this is redundant; in Telepathy it can be derived + from that of the connection) + - the D-Bus object path of the connection + - a list of D-Bus object paths representing the channels + associated with this activity """ (bus_name, connection, channels) = self._activity.GetChannels() return bus_name, connection, channels