CML Reference Guide

Chapter 4.9:  Conference Organizer Information

[TOP] [UP] [PREV] [NEXT]

Another family of functions relates to information about a conference that gets set (or changed) by the conference organizer.  In all of these functions, num is the conference number.

$co_org(num)
Evaluates to the userid of the primary organizer of the conference.

Change the primary organizer of conference num to userid id.  The caller must already be the primary organizer, or else have the MGR_BEORG manager bit.

$co_greet(num)
Evaluates to the text of the "greeting" for the conference.  In the original (text) Caucus interface, the greeting was displayed every time a person entered a conference.

$co_intro(num)
Evaluates to the text of the "introduction" for the conference.  In the original Caucus, the introduction was displayed when a person tried to join a conference for the very first time.

The introduction offers more information about the conference, to help a person decide if they really wish to join the conference.

$co_add(num)
Evaluates to "1" if ordinary users can add an item, or "0" otherwise.

$set_co_add(num add)        {protected}
If add is non-zero, ordinary users may add new items.  If add is "0", they may not.

$co_change(num)
Evalutes to "1" if ordinary users can change their own responses.  Otherwise "0".

$set_co_change(num chg)        {protected}
If chg is non-zero, ordinary users may change their responses.  If chg is "0" they may not.

$co_userlist(num)
Evaluates to the text of the conference "userlist".  The text of a simple userlist might look like:

   :include
*
:organizer
smith

$set_co_userlist(num list)        {protected}
Set the text of conference num's "userlist" to list.

$co_remove(num)        {protected}
Completely and permanently remove (delete) conference num.  Will only work for managers with permission bit MGR_RMCONF.

$co_makeorg(num userid)        {protected}
Immediately add userid as an organizer to conference num.  Will only work for managers with permission bit MGR_BEORG.

$create_conf(name priorg org1 [org2...])        {protected}
Create a new conference name, with primary organizer priorg, and secondary organizers org1, org2, etc.  Will only work for users in manager group conferenceCreate.  Evaluates to:
      new conference number on success
      0 if user does not have permission
    -1 if name already exists
    -2 priorg not supplied
    -3 internal database error
    -4 if name is bad


$co_rename(cnum newname)        {protected}
Renames conference cnum to have the name newname.  Will only work for managers with permission bits MGR_CRCONF or MGR_RMCONF.  Evaluates to:
      1 on success
      0 if the user doesn't have manager permission
    -1 if newname is bad
    -2 if cnum doesn't exist
    -3 if newname already exists!