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

Module ap_chrecurrence

Change recurrence of an appointment.

API definition:

API = (('object_id', 'ASCII string', 0),
       ('params', 'struct', 1, [('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)])]))

(c) OrbiTeam Software GmbH, 2005


Version: $Rev: 24619 $

Functions [hide private]
 
param_def()
return the parameter definition
 
do_it(request, object_id, params)
see above
 
do_it2(request, obj, **params)
 
do_it3(request, obj, rrules=None, rdates=None, exrules=None, exdates=None)
Variables [hide private]
  __package__ = None
Function Details [hide private]

param_def()

 

return the parameter definition

The default for items in params is to leave obj untouched. Use [] to remove all items. If freq is not 'YEARLY' byweekno must not occur. Either count or until may occur. For further details refer to RFC2445.