Package bscw ::
Package api ::
Module ap_get_events
|
|
Module ap_get_events
Get a filtered list of events (as dicts). See get_events() for a description.
API definition:
API = (('object_id', 'ASCII string', 1),
('etype', 'ASCII string', 1),
('nested', 'boolean', 0),
('time', 'dateTime.iso8601', 0),
('service_id', 'int', 0))
Fraunhofer FIT and OrbiTeam Software, (c) 2002-2009
|
param_def()
return the parameter definition |
|
|
|
return_def()
return the result definition (NOT for "show_history" or
nested=True) |
|
|
|
do_it(request,
object_id,
etype,
nested=False,
time=None,
service_id=0)
see above |
|
|
list
|
get_events(request,
obj,
etype,
nested=False,
time=None,
service_id=0)
Get a filtered list of events for a given object ID. |
|
|
|
event_list(events,
context=None) |
|
|
|
object_events(obj,
user_prefs=None,
etype=None,
time=None) |
|
|
|
touch_events(obj,
user_prefs,
etype=None,
time=None,
nested=0,
service_id=0) |
|
|
|
|
|
log_api = logging.getLogger('api')
|
|
ignore_CantCommit = True
|
|
subst_objref = 0
|
|
__package__ = ' bscw.api '
|
get_events(request,
obj,
etype,
nested=False,
time=None,
service_id=0)
|
|
Get a filtered list of events for a given object ID. The returned list
can be altered by using the following options:
- Parameters:
etype (str) - string with the following values:
-
'show_history' : show complete history (default)
-
'show_touches' : show only non-read (touch)
events
-
'show_readers' : show only read events
-
'show_all' : show non-read (touch) and read
events
-
<event-type> : show only events of given
event type, <event-type> ::=
{ChangeEvent|MoveEvent|NewEvent|ReadEvent|TouchEvent} .
nested (bool) - consider nested sub folders, if True . The result
list will contain an additional entry with the name and ID of the
sub folder.
time (dateTime) - if provided, only events after the given time are considered.
service_id (int) - if provided, the specified users' event filter is used as filter;
known filter service IDs' are:
-
1 : event icon filter
-
2 : email report filter
-
3 : direct email notification filter
-
4 : external awareness services filter
-
5 : external RSS news feed (package) filter
- Returns: list
- list of event dictionaries
|