[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /obj/handlers/board_handler.c</h2>
Keeps track of all the bulletin board notes and related information.
<p>Written by Pinkfish
<h2>Includes</h2>
This class includes the following files /include/clubs.h, /include/player_handler.h, /include/mail.h, /include/am_time.h and /include/board.h<h2>Class Index</h2>
<ul><li><a href="#class_newsrc">newsrc</a>
<li><a href="#class_read_access_cache">read_access_cache</a>
</ul><h2>Method index</h2>
<ul>
<li><a href="#add_admin_only_board">add_admin_only_board</a>(string)<br/>
This method adds the board to the list of admin only boards.
<li><a href="#add_allowed">add_allowed</a>(string, string)<br/>
Adds a member into the security array for a board.
<li><a href="#add_idiot">add_idiot</a>(string, int)<br/>
This method adds an idiot to the current list of idiots.
<li><a href="#add_message">add_message</a>(string, string, string, string, int, class reply_type)<br/>
Adds a new message onto the board.
<li><a href="#can_delete_message">can_delete_message</a>(string, int, string)<br/>
Check to see if the named person can delete the message.
<li><a href="#clean_cache">clean_cache</a>()<li><a href="#create_board">create_board</a>(string, int, string)<br/>
Create a new board.
<li><a href="#delete_board">delete_board</a>(string)<br/>
Complete erase a board.
<li><a href="#delete_message">delete_message</a>(string, int, string)<br/>
Remove a message from a board.
<li><a href="#edit_message">edit_message</a>(string, string, string, int, int)<br/>
Edits a new message on the board.
<li><a href="#expire_boards">expire_boards</a>()<br/>
This method runs through all the messages and expires any which are
too old.
<li><a href="#force_board_method_access_restricted">force_board_method_access_restricted</a>(string)<br/>
This method changes the type of the board to be a method access call
access restriction, instead of whatever it had before.
<li><a href="#get_message">get_message</a>(string, int, string)<br/>
Get the text of a specific message.
<li><a href="#get_subjects">get_subjects</a>(string, string)<br/>
Get the subjects for the specifed board.
<li><a href="#is_board">is_board</a>(string)<br/>
This method tests to see if the board exists.
<li><a href="#is_idiot">is_idiot</a>(string)<br/>
This method checks to see if the specified person is an idiot or
not.
<li><a href="#list_killfile">list_killfile</a>(string)<br/>
Retrieve a players killfile list

<li><a href="#list_of_boards">list_of_boards</a>()<br/>
The names of all the boards.
<li><a href="#query_archive">query_archive</a>(string)<br/>
Return the archive file location for the board.
<li><a href="#query_board_order">query_board_order</a>(string)<br/>
Retrieve someones chosen board order.
<li><a href="#query_boards">query_boards</a>()<br/>
Returns the names of all the boards.
<li><a href="#query_cache">query_cache</a>()<li><a href="#query_idiot">query_idiot</a>(string)<br/>
This method returns if they are an idiot and when their period of
idiocy runs out.
<li><a href="#query_killfile">query_killfile</a>(string, string)<br/>
Find out if a given board is in a player killfile

<li><a href="#query_maximum">query_maximum</a>(string)<br/>
Return the maximum number of message allowed on the board.
<li><a href="#query_minimum">query_minimum</a>(string)<br/>
Return the minimum number of message allowed on the board.
<li><a href="#query_newsrc">query_newsrc</a>(string)<br/>
Get someones newsrc

<li><a href="#query_no_inform">query_no_inform</a>(string)<br/>
This method checks to see if the board is in a no inform mode.
<li><a href="#query_num">query_num</a>()<br/>The current max board number.
<li><a href="#query_prevent_shadow">query_prevent_shadow</a>()<br/>Prevents the object from being shadowed.
<li><a href="#query_privilage">query_privilage</a>(string)<br/>
This method returns the current privilage level of the board in
question.
<li><a href="#query_read_only">query_read_only</a>(string)<br/>
This method checks to see if the board is in a read only mode.
<li><a href="#query_restricted_access">query_restricted_access</a>(string)<br/>
This method checks to see if the board is in restricted access mode.
<li><a href="#query_restricted_access_file">query_restricted_access_file</a>(string)<br/>
This method checkes to see if the board is in restricted access file
mode.
<li><a href="#query_security">query_security</a>(string)<br/>
Returns the security array for the given board.
<li><a href="#query_timeout">query_timeout</a>(string)<br/>
Return the timeout time of the board.
<li><a href="#remove_admin_only_board">remove_admin_only_board</a>(string)<br/>
This method removes the board from the list of admin only boards.
<li><a href="#remove_allowed">remove_allowed</a>(string, string)<br/>
Remove someone from the allowed array of the board.
<li><a href="#remove_killfile">remove_killfile</a>(string, string)<li><a href="#save_me">save_me</a>()<br/>
Saves the state of the object.
<li><a href="#set_archive">set_archive</a>(string, string)<br/>
Set the archive file location.
<li><a href="#set_board_order">set_board_order</a>(string, string *)<br/>
Set the order boards should be shown in for a given player.
<li><a href="#set_killfile">set_killfile</a>(string, string)<br/>
Add a board to someones killfile

<li><a href="#set_maximum">set_maximum</a>(string, int)<br/>
Set the maximum number of message before they start being auto deleted
when someone posts to the board.
<li><a href="#set_method_access_call">set_method_access_call</a>(string, string, string)<br/>
This method sets the method to call to check for allowed postings
to a board setup as an method controlled post board.
<li><a href="#set_minimum">set_minimum</a>(string, int)<br/>
Sets the minimum number of message to keep on a board.
<li><a href="#set_newsrc">set_newsrc</a>(string, mapping)<br/>
Set someones newsrc

<li><a href="#set_timeout">set_timeout</a>(string, int)<br/>
Change the time before a message automatic gets deleted off a
board.
<li><a href="#show_flags">show_flags</a>(string)<li><a href="#test_can_delete">test_can_delete</a>(string, object, string)<br/>
Check to see if delete is allowed.
<li><a href="#test_can_read">test_can_read</a>(string, object, string)<br/>
Check to see if read access is allowed.
<li><a href="#test_can_write">test_can_write</a>(string, object, string)<br/>
Check to see if write access is allowed.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_admin_only_board">
add_admin_only_board</a><pre class="autodocfuncdef">
void add_admin_only_board(string board)
</pre><dd><br />
This method adds the board to the list of admin only boards.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to add to the list
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_allowed">
add_allowed</a><pre class="autodocfuncdef">
int add_allowed(string board,
                string name)
</pre><dd><br />
Adds a member into the security array for a board.  This allows
certain people to read boards they may not normaly have
access to.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to change the access on<br />
name - the name of the person to add to the array<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure, 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_idiot">
add_idiot</a><pre class="autodocfuncdef">
void add_idiot(string idiot,
               int length)
</pre><dd><br />
This method adds an idiot to the current list of idiots.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
idiot - the idiot to add<br />
length - the amount of days to add them for
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_message">
add_message</a><pre class="autodocfuncdef">
int add_message(string board,
                string cap_name,
                string subject,
                string body,
                int reply_to,
                class reply_type bing)
</pre><dd><br />
Adds a new message onto the board.  This call can only be done from
verified source, like the bulletin oard objects themselves.  The
number used as a reply to should be the message number itself, not
the logical index.  If the reply_to is 0 then it is not
replying to anything at all.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to add the message to<br />
cap_name - the name ofthe person posting<br />
subject - the subject of the message<br />
body - the main section of the text<br />
reply_to - the note the message is replying to<br />
<br />
<dd><b>Returns:</b>
<br />the note number, or 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="can_delete_message">
can_delete_message</a><pre class="autodocfuncdef">
int can_delete_message(string board,
                       int off,
                       string pname)
</pre><dd><br />
Check to see if the named person can delete the message.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
pname - the player name<br />
board - the board name<br />
off - the offset to delete<br />
<br />
<dd><b>See also:</b>
<br /><a href="#delete_message">delete_message()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="clean_cache">
clean_cache</a><pre class="autodocfuncdef">
void clean_cache()
</pre>
<dt class="autodocfuncname"><a name="create_board">
create_board</a><pre class="autodocfuncdef">
int create_board(string board,
                 int priviliges,
                 string person)
</pre><dd><br />
Create a new board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to create<br />
priva - is this board only allowed prviliged access?<br />
person - the person to add into the security array initialy<br />
<br />
<dd><b>Returns:</b>
<br />0 on a failure, 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="delete_board">
delete_board</a><pre class="autodocfuncdef">
int delete_board(string board)
</pre><dd><br />
Complete erase a board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to delete<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="delete_message">
delete_message</a><pre class="autodocfuncdef">
int delete_message(string board,
                   int off,
                   string override_name)
</pre><dd><br />
Remove a message from a board.  The offset is the offset into the
subjects array.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to remove the message from<br />
off - the offset to delete<br />
override_name - used by the web boards<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="edit_message">
edit_message</a><pre class="autodocfuncdef">
int edit_message(string board,
                 string body,
                 string cap_name,
                 int post_time,
                 int num)
</pre><dd><br />
Edits a new message on the board.  This call can only be done from
verified source, like the bulletin oard objects themselves.  The
number used as a reply to should be the message number itself, not
the logical index.  If the reply_to is 0 then it is not
replying to anything at all.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to edit the message on<br />
body - the main section of the text<br />
cap_name - the name of the person posting<br />
post_time - the time the original post was made<br />
num - the note number of the messages<br />
<br />
<dd><b>Returns:</b>
<br />the note number, or 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="expire_boards">
expire_boards</a><pre class="autodocfuncdef">
void expire_boards()
</pre><dd><br />
This method runs through all the messages and expires any which are
too old.
<br />

<dt class="autodocfuncname"><a name="force_board_method_access_restricted">
force_board_method_access_restricted</a><pre class="autodocfuncdef">
int force_board_method_access_restricted(string board)
</pre><dd><br />
This method changes the type of the board to be a method access call
access restriction, instead of whatever it had before.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to control the access for
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="get_message">
get_message</a><pre class="autodocfuncdef">
string get_message(string board,
                   int num,
                   string person)
</pre><dd><br />
Get the text of a specific message.  This will look up the
text on a board with the given number and return that to the
caller.  The number is the offset into the subject array in
which to get the message from.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board name to get the message from<br />
num - the message number to use<br />
<br />
<dd><b>Returns:</b>
<br />the message or 0 if it failed
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="get_subjects">
get_subjects</a><pre class="autodocfuncdef">
varargs mixed get_subjects(string name,
                           string person)
</pre><dd><br />
Get the subjects for the specifed board.  The subjects are
returns in a special array format.  See the include file for the
defines to get at the members of the array.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the board name to lookup<br />
<br />
<dd><b>Returns:</b>
<br />the subject array
<br /><br />
<dd><b>See also:</b>
<br />/include/board.h<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_board">
is_board</a><pre class="autodocfuncdef">
int is_board(string board)
</pre><dd><br />
This method tests to see if the board exists.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if the board exists, 0 if it does not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_idiot">
is_idiot</a><pre class="autodocfuncdef">
int is_idiot(string name)
</pre><dd><br />
This method checks to see if the specified person is an idiot or
not.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are an idiot
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="list_killfile">
list_killfile</a><pre class="autodocfuncdef">
string * list_killfile(string player)
</pre><dd><br />
Retrieve a players killfile list
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the players name<br />
<br />
<dd><b>Returns:</b>
<br />string * the list of boards in their killfile
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="list_of_boards">
list_of_boards</a><pre class="autodocfuncdef">
string * list_of_boards()
</pre><dd><br />
The names of all the boards.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the list of all the boards
<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_boards">query_boards()</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_archive">
query_archive</a><pre class="autodocfuncdef">
string query_archive(string board)
</pre><dd><br />
Return the archive file location for the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to get the archive location for<br />
<br />
<dd><b>Returns:</b>
<br />the archive file location, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_board_order">
query_board_order</a><pre class="autodocfuncdef">
string * query_board_order(string player)
</pre><dd><br />
Retrieve someones chosen board order.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the players name<br />
<br />
<dd><b>Returns:</b>
<br />the list of boards, in order
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_boards">
query_boards</a><pre class="autodocfuncdef">
string * query_boards()
</pre><dd><br />
Returns the names of all the boards.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the names of all the boards
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_cache">
query_cache</a><pre class="autodocfuncdef">
void query_cache()
</pre>
<dt class="autodocfuncname"><a name="query_idiot">
query_idiot</a><pre class="autodocfuncdef">
int query_idiot(string idiot)
</pre><dd><br />
This method returns if they are an idiot and when their period of
idiocy runs out.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
idiot - the idiot to check<br />
<br />
<dd><b>Returns:</b>
<br />0 if not an idiot, the time left otherwise
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_killfile">
query_killfile</a><pre class="autodocfuncdef">
int query_killfile(string player,
                   string board)
</pre><dd><br />
Find out if a given board is in a player killfile
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the name of the player<br />
string - the name of the board (in lowercase)<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is, 0 if it isn't
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_maximum">
query_maximum</a><pre class="autodocfuncdef">
int query_maximum(string board)
</pre><dd><br />
Return the maximum number of message allowed on the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to get the maximum numbr of message for<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure, the maximum number of messages on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_minimum">
query_minimum</a><pre class="autodocfuncdef">
int query_minimum(string board)
</pre><dd><br />
Return the minimum number of message allowed on the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to get the minimum numbr of message for<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure, the minimum number of messages on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_newsrc">
query_newsrc</a><pre class="autodocfuncdef">
mapping query_newsrc(string player)
</pre><dd><br />
Get someones newsrc
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the name of the player<br />
<br />
<dd><b>Returns:</b>
<br />mapping their newsrc
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_no_inform">
query_no_inform</a><pre class="autodocfuncdef">
int query_no_inform(string board)
</pre><dd><br />
This method checks to see if the board is in a no inform mode.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is no inform, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_num">
query_num</a><pre class="autodocfuncdef">
int query_num()
</pre><dd><br />The current max board number. <br />

<dt class="autodocfuncname"><a name="query_prevent_shadow">
query_prevent_shadow</a><pre class="autodocfuncdef">
int query_prevent_shadow()
</pre><dd><br />Prevents the object from being shadowed. <br />

<dt class="autodocfuncname"><a name="query_privilage">
query_privilage</a><pre class="autodocfuncdef">
int query_privilage(string board)
</pre><dd><br />
This method returns the current privilage level of the board in
question.  This should be used for testing only.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the current privilage level
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_read_only">
query_read_only</a><pre class="autodocfuncdef">
int query_read_only(string board)
</pre><dd><br />
This method checks to see if the board is in a read only mode.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is read only, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_restricted_access">
query_restricted_access</a><pre class="autodocfuncdef">
int query_restricted_access(string board)
</pre><dd><br />
This method checks to see if the board is in restricted access mode.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is, 0 if it is not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_restricted_access_file">
query_restricted_access_file</a><pre class="autodocfuncdef">
int query_restricted_access_file(string board)
</pre><dd><br />
This method checkes to see if the board is in restricted access file
mode.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is, 0 if it is not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_security">
query_security</a><pre class="autodocfuncdef">
string * query_security(string board)
</pre><dd><br />
Returns the security array for the given board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to get the security array for<br />
<br />
<dd><b>Returns:</b>
<br />the security array
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_timeout">
query_timeout</a><pre class="autodocfuncdef">
int query_timeout(string board)
</pre><dd><br />
Return the timeout time of the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to get the timeout for<br />
<br />
<dd><b>Returns:</b>
<br />the timeout in seconds<br /><br />
<dd><b>See also:</b>
<br /><a href="#set_timeout">set_timeout()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="remove_admin_only_board">
remove_admin_only_board</a><pre class="autodocfuncdef">
void remove_admin_only_board(string board)
</pre><dd><br />
This method removes the board from the list of admin only boards.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to remove from the list
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_allowed">
remove_allowed</a><pre class="autodocfuncdef">
int remove_allowed(string board,
                   string name)
</pre><dd><br />
Remove someone from the allowed array of the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to remove the person from<br />
name - the name of the person to remove<br />
<br />
<dd><b>Returns:</b>
<br />0 on nfailure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_killfile">
remove_killfile</a><pre class="autodocfuncdef">
int remove_killfile(string player,
                    string board)
</pre>
<dt class="autodocfuncname"><a name="save_me">
save_me</a><pre class="autodocfuncdef">
void save_me()
</pre><dd><br />
Saves the state of the object.
<br />

<dt class="autodocfuncname"><a name="set_archive">
set_archive</a><pre class="autodocfuncdef">
int set_archive(string board,
                string file)
</pre><dd><br />
Set the archive file location.  This is where all deleted messages
wil be stored.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to set the archive for<br />
file - the file name to set it to<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_board_order">
set_board_order</a><pre class="autodocfuncdef">
int set_board_order(string player,
                    string * new_order)
</pre><dd><br />
Set the order boards should be shown in for a given player.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - a players name<br />
string - * the list of boards<br />
<br />
<dd><b>Returns:</b>
<br />1 for success, 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_killfile">
set_killfile</a><pre class="autodocfuncdef">
int set_killfile(string player,
                 string board)
</pre><dd><br />
Add a board to someones killfile
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the name of the player<br />
string - the name of the board (in lowercase)<br />
<br />
<dd><b>Returns:</b>
<br />1 for success, 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_maximum">
set_maximum</a><pre class="autodocfuncdef">
int set_maximum(string board,
                int max)
</pre><dd><br />
Set the maximum number of message before they start being auto deleted
when someone posts to the board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to set the maximum for<br />
max - the maximum number of messages<br />
<br />
<dd><b>Returns:</b>
<br />0 if it failed and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_method_access_call">
set_method_access_call</a><pre class="autodocfuncdef">
int set_method_access_call(string board,
                           string method,
                           string name)
</pre><dd><br />
This method sets the method to call to check for allowed postings
to a board setup as an method controlled post board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to setup the method for<br />
method - the method to call on the object<br />
name - the object to call the method on<br />
<br />
<dd><b>Returns:</b>
<br />0 if the method failed, 1 if it was successful
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_minimum">
set_minimum</a><pre class="autodocfuncdef">
int set_minimum(string board,
                int min)
</pre><dd><br />
Sets the minimum number of message to keep on a board.  If there is less
than this
number then they will not be auto deleted.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to set the minimum for<br />
min - the number of message to keep<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_newsrc">
set_newsrc</a><pre class="autodocfuncdef">
int set_newsrc(string player,
               mapping newsrc)
</pre><dd><br />
Set someones newsrc
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
string - the name of the player<br />
mapping - their new newsrc<br />
<br />
<dd><b>Returns:</b>
<br />1 for success, 0 for failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_timeout">
set_timeout</a><pre class="autodocfuncdef">
int set_timeout(string board,
                int timeout)
</pre><dd><br />
Change the time before a message automatic gets deleted off a
board.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the name of the board to set the timeout for<br />
timeout - the timeout (in seconds)<br />
<br />
<dd><b>Returns:</b>
<br />0 on failure and 1 on success
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="show_flags">
show_flags</a><pre class="autodocfuncdef">
void show_flags(string board)
</pre>
<dt class="autodocfuncname"><a name="test_can_delete">
test_can_delete</a><pre class="autodocfuncdef">
int test_can_delete(string board,
                    object previous,
                    string name)
</pre><dd><br />
Check to see if delete is allowed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to check<br />
previous - the previous object<br />
name - the name of the person doing stuff<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is allowed, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_can_read">
test_can_read</a><pre class="autodocfuncdef">
int test_can_read(string board,
                  object previous,
                  string name)
</pre><dd><br />
Check to see if read access is allowed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to check<br />
previous - the previous object<br />
name - the name of the person doing stuff<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is allowed, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="test_can_write">
test_can_write</a><pre class="autodocfuncdef">
int test_can_write(string board,
                   object previous,
                   string name)
</pre><dd><br />
Check to see if write access is allowed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
board - the board to check<br />
previous - the previous object<br />
name - the name of the person doing stuff<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is allowed, 0 if not
<br /><br />
<br /></dl>

</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_newsrc">
newsrc</a><pre>
class newsrc {
               int cached;
               int changed;
               mapping newsrc;
               string * kill;
               string * board_order;
}

</pre>
<li><a name="class_read_access_cache">
read_access_cache</a><pre>
class read_access_cache {
                          int read_time;
                          int read_access;
}

</pre>
</ul>
[an error occurred while processing this directive]