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.

$co_name(num)
Evaluates to the name of this conference.  (It can be slower than $cl_name(), but does not depend on whether $cl_list() has been called.)

$set_co_org(num id)
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)
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)
If chg is non-zero, ordinary users may change their responses.  If chg is "0" they may not.

$co_visible(num)
Evaluates to "1" if conference name is visible to non-members in conference lists.  Otherwise "0".

$set_co_visible(num vis)
If vis is non-zero, the conference name is visible.  If vis is "0", the conference is invisible to non-members.

$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)
Set the text of conference num's "userlist" to list.

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

$co_makeorg(num userid)
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...] [userlist])
Create a new conference name, with primary organizer priorg, and secondary organizers org1, org2, etc.  Will only work for managers with permission bit MGR_CRCONF.  Evaluates to:

An optional userlist may be supplied to control the initial access to the conference; the list of secondary organizers is added onto the end of this userlist.  This userlist must be of the form:

      :keyword1
      userid1
      userid2
      ...
      :keyword2
      userid3
      ...

where the keywords must be one of "include", "readonly", "exclude", or "organizer".  The userids must be an actual userid, a wildcard ("*"), or a comment (any line that begins with "#").

If no userlist is supplied, a default is used, which is equivalent to the following call to $create_conf():

$co_rename(cnum newname)   (4.06)
Renames conference cnum to have the name newname.  Will only work for managers with permission bits MGR_CRCONF or MGR_RMCONF.  Evaluates to: