[ Module Hierarchy
| Class Hierarchy ]
Module Hierarchy
- bscw.api.FlowFolder.ap_addflow: add a new flow folder
returns id of new flow folder
- bscw.api.SMS.ap_sms: send short message to users
returns exec status
- bscw.api.Secure.ap_set_public_key: Secure Package: set public key
API handler to set public key for user
called by client after public key is uploaded
target_id should refer to user object
public_key_id should refer to new key object (Document)
- bscw.api.Tasks.ap_acceptwbtask: accepts a task
returns id of accepted task
- bscw.api.Tasks.ap_addwbtask: Add a task,
return id of new task.
- bscw.api.Tasks.ap_cancelwbtask: Cancel a task,
return id of cancelled task.
- bscw.api.Tasks.ap_commitwbtask: commits to a task
returns id of committed task
- bscw.api.Tasks.ap_correctwbtask: Request correction of a task,
return id of task.
- bscw.api.Tasks.ap_deadlinewbtask: API to change the deadline of a task.
- bscw.api.Tasks.ap_dowbtask: Finish a task,
return id of finished task.
- bscw.api.Tasks.ap_editwbtask: API to edit a task.
- bscw.api.Tasks.ap_forwardwbtask: forwards a task
returns id of forwarded task
- bscw.api.Tasks.ap_objectwbtask: Object to a task input,
return id of task.
- bscw.api.Tasks.ap_orderwbfields: Reorders task fields;
returns id of reordered task
- bscw.api.Tasks.ap_rejectwbtask: rejects a task
returns id of rejected task
- bscw.api.Tasks.ap_requestwbtask: Request execution of a task,
return id of requested task.
- bscw.api.Tasks.ap_uncommitwbtask: uncommits to a task
returns id of uncommitted task
- bscw.api.Tasks.ap_withdrawreqwbtask: Withdraw the request of a task,
return id of task.
- bscw.api.Tasks.ap_withdrawwbtask: Withdraw the execution of a task,
return id of task withdrawn.
- bscw.api.WebFolder.ap_addindex: Adds a new home page template_name is the name of the sample
template to use (refer to ap_getavsamples) Returns the id of the
new document
- bscw.api.WebFolder.ap_addstyle: Adds a new style doc template_name is the name of the sample
template to use (refer to ap_getavsamples) Returns the id of the
new document
- bscw.api.WebFolder.ap_addtemplate: Adds a new layout page template_name is the name of the sample
template to use (refer to ap_getavsamples) Returns the id of the
new document
- bscw.api.WebFolder.ap_addwebfolder: Adds a new Web Folder Returns the id of the new Web Folder
- bscw.api.WebFolder.ap_getavsamples: Gets av.ailable sample templates for home page, layout page or style def.
- bscw.api.WebFolder.ap_make: Creates a static copy inside of the clipboard allfiles determines
if non-HTML files are copied or left alone Returns a list of error
messages encountered during the static copy
- bscw.api.WebFolder.ap_setwebfolderprop: Sets the properties of a website folder.
- bscw.api.ap_add2cal: add appointment to calendar
status: 0=tentative 1=confirmed 2=cancelled -1=>automatically
category: bitwise or of
1 : 'appointment',
2 : 'business',
4 : 'meeting',
8 : 'phonecall',
32 : 'holiday',
128 : 'private',
256 : 'travel',
512 : 'miscellaneous',
mail is sent to participants if notification is given (not None)
returns object_id of new calendar object
- bscw.api.ap_addapt: Create a new appointment.
- bscw.api.ap_addbmfolder: add a new bookmark folder
returns id of new bookmark folder
- bscw.api.ap_addbookmark: add an url
returns id of new url/bookmark
- bscw.api.ap_addcal: Create a new calendar.
- bscw.api.ap_addcommunity: Community package: add a new community (an UserGroup object)
returns id of new community
Communities can currently only be added at top level.
- bscw.api.ap_addct: adds a new contact
ct_id is object ID of contact list where contact should be added to
- bscw.api.ap_addctlist: adds a new contactlist
returns id of new contactlist
- bscw.api.ap_adddocument: add a doument
returns id of new document
- bscw.api.ap_addfolder: add a new folder
returns id of new folder
- bscw.api.ap_addmember: Add members to a workspace
returns list of member_names
- bscw.api.ap_addnote: creating a new Noteboard
By way of a first Note as annotation to a Document etc,
or as stand-alone Note
returns id of new note
- bscw.api.ap_addrole: Add new role
returns list of action_names
- bscw.api.ap_addurl: add an url
returns id of new url
- bscw.api.ap_allocateMailAddr: Registration of email addresses (and new users)
returns user_id
- bscw.api.ap_applyquery: apply a query
(i.e.
- bscw.api.ap_bouncedMailAddr: Registration of email addresses (and new users)
set bounced
returns mail_address_id
- bscw.api.ap_branch: Change version information of last version
returns id of document
- bscw.api.ap_catchup: Confirms new events for a set of artifacts
event_types is 'read', 'touch', 'both'
returns date of last catchup
- bscw.api.ap_chawpref: Change awareness config of object.
- bscw.api.ap_chdesc: change description
returns description
- bscw.api.ap_chdescr: change description of appointment
category: bitwise or of
1 : 'appointment',
2 : 'business',
4 : 'meeting',
8 : 'phonecall',
32 : 'holiday',
128 : 'private',
256 : 'travel',
512 : 'miscellaneous',
- bscw.api.ap_chdtime: Define/Edit date & time of a calendar-component
mail is sent if notification is given (not None)
returns start
- bscw.api.ap_checkin: Unlock object
returns id of object
- bscw.api.ap_checkout: Lock object
returns id of object
- bscw.api.ap_chloc: change location of appointment
mail is sent to participants if notification is given (not None)
returns xlocation
- bscw.api.ap_chpart: Add/Remove Participants of appointment
mail is sent to participants if notification is given (not None)
returns names of participants (x_attendees)
- bscw.api.ap_chpwd: Changes the password of the given username or (un)locks the (given)
username.
- bscw.api.ap_chrecurrence: Change recurrence of an appointment.
- bscw.api.ap_chreminder: remind attendees of a calendar-component
reset: reset all participants to unconfirmed
mail is sent if notification is given (not None)
returns object_id
- bscw.api.ap_chreminders: Change reminders for an appointment.
- bscw.api.ap_chrole: Change roles of members or list all or assigned roles.
- bscw.api.ap_chseries: Change the series of a recurring appointment.
- bscw.api.ap_chstatus: change status of appointment
status: 0=tentative 1=confirmed 2=cancelled -1=>automatically
returns status
- bscw.api.ap_chsummary: rename appointment
returns name
- bscw.api.ap_chtype: Change mime type of a workspace document
returns type
- bscw.api.ap_chvinfo: Change version information of last version
returns id of document
- bscw.api.ap_copy: Copies (and renames) object between containers returns id of new
object.
- bscw.api.ap_create_addr: Creates new address or changes existing address.
- bscw.api.ap_create_user: Creates (given) username and allocates given address(es).
- bscw.api.ap_deleteMem: Deletes a set of members from a workspace
returns container_id
- bscw.api.ap_deleteObj: Deletes a set of artifacts (moves it to the users waste)
returns id of the container
- bscw.api.ap_destroy: Destructs a set of artifacts
returns id of the container
- bscw.api.ap_drop: Moves selected objects
returns list of object_ids
- bscw.api.ap_editapt: Change an appointment.
- bscw.api.ap_editdetails: Change user's details (struct of attributes)
- bscw.api.ap_editnote: Edit a Note object
returns id of note
- bscw.api.ap_editrole: Edit role
returns list of action_names
- bscw.api.ap_editurl: Edit an url
returns id of url
- bscw.api.ap_es_enter: Database Event Scheduler API
- bscw.api.ap_es_register: Database Event Scheduler API
- bscw.api.ap_es_registrations: Database Event Scheduler API
- bscw.api.ap_es_setscope: Database Event Scheduler API
- bscw.api.ap_es_subscribe: Database Event Scheduler API
- bscw.api.ap_es_subscribe_s: Database Event Scheduler API
- bscw.api.ap_es_subscriptions: Database Event Scheduler API
- bscw.api.ap_es_unregister: Database Event Scheduler API
- bscw.api.ap_es_unsubscribe: Database Event Scheduler API
- bscw.api.ap_es_unsubscribe_s: Database Event Scheduler API
- bscw.api.ap_firstversion: Put document under version control
returns id of document
- bscw.api.ap_forget: Forget version of object
returns id of object
- bscw.api.ap_freeze: Freeze Artifacts, rendering them read-only for all members
All members are assigned role "R1restricted", which cannot be overridden
by later and additional role assignments.
- bscw.api.ap_get_access_rights: get access rights
returns list of actions
- bscw.api.ap_get_access_rights_all: get access rights of all users
returns dictionary of users and their allowed actions
or if get_roles is True
returns dictionary of roles and their members and allowed actions
- bscw.api.ap_get_addressbook: get contact entries (with associated users) from addressbook of
user as list of dictionaries (structs).
- bscw.api.ap_get_api: get api function definition as dict {name: params}
- bscw.api.ap_get_appointment: Get attributes of an appointment.
- bscw.api.ap_get_appointments: get a filtered list of calender entries (as dicts) from 'start' until 'end'
attributes are: name descr start end x_attendees xlocation categ status
If end is not specified start *must not* be specified too and all non
recurring appointments and all series objects are returned.
- bscw.api.ap_get_attributenames: get attributenames of object type as list.
- bscw.api.ap_get_attributes: Get attributes of object (and contained objects until level 'depth') as
list of dictionaries (structs).
- bscw.api.ap_get_bookmarks: get entries in Bookmarks folder of user as list of dictionaries (structs).
- bscw.api.ap_get_communities: Community package: get_communities: return all existing communities...
- bscw.api.ap_get_document: get the contents of a document as xmlrpclib.Binary
- bscw.api.ap_get_events: Get a filtered list of events (as dicts).
- bscw.api.ap_get_groups: get groups related to workspace
- bscw.api.ap_get_mailaddress: Registration of email addresses (and new users)
set pending
returns mail_address, { 'allocated' | 'pending' | 'bounced' }
- bscw.api.ap_get_members: get members of container as list of usernames
for 'recursive' == True members of subfolders are also listed
for 'resolve_groups' == False the list contains the names of users or ids of groups
- bscw.api.ap_get_menu: Returns menus for the given objects (parameter object_ids).
- bscw.api.ap_get_note: get note as dict with { subject, body, type, author, date }
- bscw.api.ap_get_path: Get the path of an object as a list of object ids.
- bscw.api.ap_get_servertime: get server time returns servertime (seconds since UTC) as DateTime
(c) OrbiTeam, 2005
- bscw.api.ap_get_url: get url
- bscw.api.ap_get_user_by_name: get user details as dict
for attribute names see editdetails
'shared_folders' gives a list of folders shared with that user
- bscw.api.ap_get_user_metadata: Get metadata for logged user as dict.
- bscw.api.ap_get_users_by_name: get details of users as list of dicts
for attribute names see editdetails
'shared_folders' gives a list of folders shared with that user
- bscw.api.ap_get_version_info: get version info of object returns list of [ versions, branches ]
of dicts with { vid, vstate, vinfo }
- bscw.api.ap_info_details: Returns 'details' information about the given object (parameter
object_id).
- bscw.api.ap_join_community: Community package: join_community = self-subscribe to a community
community must be open to self-subscription
returns id of community
- bscw.api.ap_license_info: Gets license info.
- bscw.api.ap_list_addr: List (given) address(es).
- bscw.api.ap_list_user: Lists (given) username(s).
- bscw.api.ap_locate: Locates an object, i.e.
- bscw.api.ap_lookup_servers: get configuration data of MILK servers
- bscw.api.ap_lst_entries: Lists container entries (used by portal widgets)
- bscw.api.ap_lst_events: list events (used by portal widgets)
- bscw.api.ap_multiprefs: Switch user preferences on entries via AJAX interface.
- bscw.api.ap_pendingMailAddr: Registration of email addresses (and new users)
set pending
returns mail_address_id
- bscw.api.ap_pubaccess: Moderate a Folder, Notes, or Meeting, making it public and
then setting access rights for anonymous upload
returns list of action_names
- bscw.api.ap_publish: Publish an Artifact
returns container_id
- bscw.api.ap_rate: Rate documents or URLs according to list of pairs (object_id, rating)
with rating: (0=none) (1=poor)...(5=excellent)
returns list of median ratings
- bscw.api.ap_remove_addr: Removes (given) address.
- bscw.api.ap_remove_user: Removes (given) username.
- bscw.api.ap_rename: Rename an artifact
returns new name
- bscw.api.ap_rename_addr: Renames (given) address.
- bscw.api.ap_rename_user: Renames (given) username.
- bscw.api.ap_replace: Replace a document
returns id of document
- bscw.api.ap_replynote: Create a reply to a Note
returns id of new note
- bscw.api.ap_revise: Revise a document
returns version number
- bscw.api.ap_search: Search in object (0: whole system, else: folder_id)
classnames eg: 'Document,Folder,URL,Note' or '*' for all classes
conditions eg: '(name="new" OR name~="neu" OR type~="plain")'
(means name is 'new' or name contains 'neu' or type contains 'plain')
- bscw.api.ap_search_user: Search user in object (0: whole system, else: folder_id)
conditions eg: '(name="klein" OR name~="1")'
returns list of pairs with (name, id)
- bscw.api.ap_send_email: Send email with attached objects
returns recipients on success
- bscw.api.ap_serv_notify: Database Event Scheduler (remote service) API
- bscw.api.ap_service_cmd: Starts/Stops BSCW service_cmds or run BSCW tasks.
- bscw.api.ap_service_status: Gets service status info.
- bscw.api.ap_set_attributes: Set metadata attributes (struct of attribute, value pairs) these
attributes are stored in a MetaData object in a dictionary named
'data' or 'config_data' (md_type '' or 'config_') to remove a
metadata give it a value of '__None__' returns list of names of
metadata
- bscw.api.ap_set_metadata: Set metadata attributes (list of attribute, value pairs).
- bscw.api.ap_set_private: private access to object
remove access rights for 'registered user' and anonynous (R0other and R1anonymous)
returns list of action_names
- bscw.api.ap_set_public: public access to object
give 'info' and 'get' access rights to 'registered user' and anonynous (R0other and R1anonymous)
returns list of action_names
- bscw.api.ap_set_subscribe: Community package: allow/deny self-subscription to a community
true: community is open to self-subscription
false: no self-subscription, invitation by community managers only
returns id of community
- bscw.api.ap_steallock: Steal lock
returns objectId
- bscw.api.ap_swpref: Switches user preferences.
- bscw.api.ap_undelete: Puts artifacts back to old location
returns ids of artifacts
- bscw.api.ap_uploadurl: Transfers the content of an URL into a new BSCW object (document)
returns list of IDs of uploaded urls
- bscw.api.ap_userstate: Change userstate of appointment
state: 1=confirm, 2=decline
returns state
- bscw.api.ap_viewlock: View lock
returns locktext
- bscw.api.blog.ap_addblog: add a new blog
returns id of new blog
- bscw.api.blog.ap_addblogcomment: add a new comment to note in a blog
returns id of new comment
- bscw.api.blog.ap_addblognote: add a new note to a blog
returns id of new note
- bscw.api.blog.ap_blogdelete: Deletes a set of blog entries (moves it to the users waste)
returns id of the container
- bscw.api.moin.ap_authmoin: checks the authentication according the authentication cookies.
- bscw.api.poll.ap_addpoll: add a poll object
returns id of new poll
- bscw.api.poll.ap_addvoting: add a voting object
returns id of new voting
- bscw.api.poll.ap_pollparams: edit a poll object
returns id of new poll
- bscw.api.poll.ap_restartpoll: restart a poll object
returns poll id
- bscw.api.poll.ap_votepoll: edit a poll object
returns id of new poll
- bscw.api.portal.ap_addportal: add a new portal returns id of new portal
- bscw.api.portal.ap_addportlet: add a new portlet returns id of new portlet
- bscw.api.portal.ap_editportlet: Edit a portlet's settings.
- bscw.api.portal.ap_portalpref: save portal layout
- bscw.api.rss.ap_addrss: add a new folder
returns id of new folder
- bscw.api.rss.ap_rss: returns RSS 2.0 formatted events for BSCW objects