sugarlabs/sugar-toolkit-gtk3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve docs for sugar3.activity.activityhandle

Browse Source
This commit is contained in:
radicalonion 2015-12-28 22:50:11 -05:00
parent 0af1ce7b97
commit 28053c83b1
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/sugar3/activity/activityhandle.py
View File

@ -15,49 +15,49 @@
# Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA. # Boston, MA 02111-1307, USA.
""" '''
STABLE. Provides a class for storing activity metadata such as activity id's,
""" journal object id's,
'''
class ActivityHandle(object): class ActivityHandle(object):
"""Data structure storing simple activity metadata""" '''
Data structure storing simple activity metadata
def __init__(self, activity_id=None, object_id=None, uri=None, Args:
invited=False): activity_id (string): unique id for the activity to be
"""Initialise the handle from activity_id
activity_id -- unique id for the activity to be
created created
object_id -- identity of the journal object
associated with the activity. It was used by object_id (string): identity of the journal object
the journal prototype implementation, might associated with the activity.
change when we do the real one.
When you resume an activity from the journal When you resume an activity from the journal
the object_id will be passed in. It's optional the object_id will be passed in. It is optional
since new activities does not have an since new activities does not have an
associated object (yet). associated object.
XXX Not clear how this relates to the activity uri (string): URI associated with the activity. Used when
id yet, i.e. not sure we really need both. TBF
uri -- URI associated with the activity. Used when
opening an external file or resource in the opening an external file or resource in the
activity, rather than a journal object activity, rather than a journal object
(downloads stored on the file system for (downloads stored on the file system for
example or web pages) example or web pages)
invited -- the activity is being launched for handling an invite
from the network invited (bool): True if the activity is being
""" launched for handling an invite from the network
'''
def __init__(self, activity_id=None, object_id=None, uri=None,
invited=False):
self.activity_id = activity_id self.activity_id = activity_id
self.object_id = object_id self.object_id = object_id
self.uri = uri self.uri = uri
self.invited = invited self.invited = invited
def get_dict(self): def get_dict(self):
"""Retrieve our settings as a dictionary""" '''Returns activity settings as a dictionary in format
result = {'activity_id': self.activity_id, {activity_id:XXXX, object_id:XXXX, uri:XXXX, invited:BOOL}'''
'invited': self.invited} result = {'activity_id': self.activity_id, 'invited': self.invited}
if self.object_id: if self.object_id:
result['object_id'] = self.object_id result['object_id'] = self.object_id
if self.uri: if self.uri:
@ -67,7 +67,7 @@ class ActivityHandle(object):
def create_from_dict(handle_dict): def create_from_dict(handle_dict):
"""Create a handle from a dictionary of parameters""" '''Returns an activity handle from a dictionary of parameters'''
result = ActivityHandle(handle_dict['activity_id'], result = ActivityHandle(handle_dict['activity_id'],
object_id=handle_dict.get('object_id'), object_id=handle_dict.get('object_id'),
uri=handle_dict.get('uri'), uri=handle_dict.get('uri'),