Package bscw :: Package api :: Module ap_editapt
[hide private]

Module ap_editapt

Change an appointment. If the appointment is part of a series (not the series object itself) the parameter 'recurrence' must not be present.

API definition:

API = (('object_id', 'ASCII string', 1),
       ('params', 'struct', 1, [('name', 'Unicode string', 0),
       ('description', 'Unicode string', 0),
       ('location', 'Unicode string', 0),
       ('categ', 'array', 0, [('item', 'Unicode string', 1)]),
       ('status', 'int', 0),
       ('participants', 'array', 0, [('item', 'ASCII string', 1)]),
       ('tzid', 'ASCII string', 0),
       ('start', 'dateTime.iso8601', 0),
       ('end', 'dateTime.iso8601', 0),
       ('recurrence', 'struct', 0, [('rrules', 'array', 0, [('rule', 'struct', 1, [('freq', 'ASCII string', 1),
       ('interv', 'int', 0),
       ('wkst', 'ASCII string', 0),
       ('count', 'int', 0),
       ('expire', 'dateTime.iso8601', 0),
       ('bysetpos', 'array', 0, [('item', 'int', 1)]),
       ('bymonth', 'array', 0, [('item', 'int', 1)]),
       ('byweekno', 'array', 0, [('item', 'int', 1)]),
       ('byyearday', 'array', 0, [('item', 'int', 1)]),
       ('bymoday', 'array', 0, [('item', 'int', 1)]),
       ('byday', 'array', 0, [('item', 'ASCII string', 1)]),
       ('byhour', 'array', 0, [('item', 'int', 0)]),
       ('byminute', 'array', 0, [('item', 'int', 0)])])]),
       ('rdates', 'array', 0, [('date', 'dateTime.iso8601', 1)]),
       ('exrules', 'array', 0, [('rule', 'struct', 1, [('freq', 'ASCII string', 1),
       ('interv', 'int', 0),
       ('wkst', 'ASCII string', 0),
       ('count', 'int', 0),
       ('expire', 'dateTime.iso8601', 0),
       ('bysetpos', 'array', 0, [('item', 'int', 1)]),
       ('bymonth', 'array', 0, [('item', 'int', 1)]),
       ('byweekno', 'array', 0, [('item', 'int', 1)]),
       ('byyearday', 'array', 0, [('item', 'int', 1)]),
       ('bymoday', 'array', 0, [('item', 'int', 1)]),
       ('byday', 'array', 0, [('item', 'ASCII string', 1)]),
       ('byhour', 'array', 0, [('item', 'int', 0)]),
       ('byminute', 'array', 0, [('item', 'int', 0)])])]),
       ('exdates', 'array', 0, [('date', 'dateTime.iso8601', 1)])]),
       ('reminders', 'array', 0, [('reminder', 'struct', 1, [('secs_before', 'double', 1),
       ('repeat_count', 'int', 0),
       ('repeat_secs', 'double', 0),
       ('recipients', 'array', 1, [('item', 'ASCII string', 1)]),
       ('message', 'Unicode string', 0)])]),
       ('notification', 'Unicode string', 0),
       ('categnum', 'int', 0),
       ('priostr', 'ASCII string', 0)]))

(c) OrbiTeam Software GmbH & Co. KG, 2005


Version: $Rev: 24619 $

Functions [hide private]
 
param_def()
return the parameter definition
 
set_categ(obj, request, categ=None, xcateg=None)
 
ap_set_categ(obj, request, categ=None, xcateg=None)
 
do_it(request, object_id, params)
see above
 
do_it2(request, obj, **params)
 
do_it3(request, obj, name=None, description=None, start=None, end=None, tzid=None, participants=None, location=None, status=None, categ=None, recurrence=None, reminders=None, notification=None, categnum=None, priostr=None)
Variables [hide private]
  __package__ = None
Function Details [hide private]

param_def()

 

return the parameter definition

The value for 'name' must not be empty. The default for items in 'recurrence' is to leave obj untouched. Use [] to remove all items.