Deprecate create_jobject parameter on activity.py - Fixes #3450

As the ticket describe, create a object in the Journal
is no longer optional. The change do not break activities,
because the optional parameter is not removed, just ignored.
This commit is contained in:
Gonzalo Odiard 2015-10-05 00:41:21 -03:00
parent 7c804354a0
commit 1bd8349b84

View File

@ -296,8 +296,9 @@ class Activity(Window, Gtk.Container):
presence service which *may* provide sharing for this
application
create_jobject (boolean)
define if it should create a journal object if we are
not resuming
DEPRECATED: define if it should create a journal object if we are
not resuming. The parameter is ignored, and always will
be created a object in the Journal.
Side effects:
@ -407,7 +408,7 @@ class Activity(Window, Gtk.Container):
self.shared_activity = None
self._join_id = None
if handle.object_id is None and create_jobject:
if handle.object_id is None:
logging.debug('Creating a jobject.')
self._jobject = self._initialize_journal_object()
@ -426,10 +427,6 @@ class Activity(Window, Gtk.Container):
warn_if_none=False)
self._set_up_sharing(mesh_instance, share_scope)
if not create_jobject:
self.set_title(get_bundle_name())
return
if self.shared_activity is not None:
self._jobject.metadata['title'] = self.shared_activity.props.name
self._jobject.metadata['icon-color'] = \
@ -571,8 +568,8 @@ class Activity(Window, Gtk.Container):
int: the activity id of the current instance of your activity.
The activity id is sort-of-like the unix process id (PID). However,
unlike PIDs it is only different for each new instance (with
create_jobject = True set) and stays the same everytime a user
unlike PIDs it is only different for each new instance
and stays the same everytime a user
resumes an activity. This is also the identity of your Activity to
other XOs for use when sharing.
'''