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

Module ap_addmember

Add members to a workspace
   returns list of member_names

API definition::

 API = (('container_id', 'ASCII string', 1),
        ('members', 'array', 1, [('item', 'ASCII string', 1)]),
        ('invitation_text', 'Unicode string', 0),
        ('language', 'ASCII string', 0),
        ('role', 'ASCII string', 0),
        ('mailto_all', 'boolean', 0))

(c) Fraunhofer FIT, 2002


Version: $Rev: 20112 $

Functions [hide private]
 
param_def()
return the parameter definition
 
do_it(request, container_id, members, invitation_text='', language='', role='', mailto_all=True)
see above
 
add_mem(target, artifact, request, members, invitation_text, language, role, mailto_all)
Add members to a workspace.
Variables [hide private]
  __package__ = 'bscw.api'
Function Details [hide private]

add_mem(target, artifact, request, members, invitation_text, language, role, mailto_all)

 
Add members to a workspace.
members: registered users or email addresses to be registered.
invitation_text: which is prepended to the
    automated invitation message to register (for email addresses only).
    Default: ''.
language: natural language of the automated invitation to register.
    Default: language of authenticated user, e.g. 'en' or 'de'.
role: role in which new members are invited.
    Default: 'R2member'.
mailto_all:
    If TRUE: send invitation_text (if any) to both registered users and to email addresses
    If FALSE: send invitation_text (if any) only to email addresses, omit registered users.
    Default: TRUE.