messages-procs.tcl

Forums Library - for Messages

Location:
packages/forums/tcl/messages-procs.tcl
Created:
2002-05-20
Author:
Ben Adida
CVS Identification:
$Id: messages-procs.tcl,v 1.59.2.30 2024/08/07 09:54:43 gustafn Exp $

Procedures in this file

Detailed information

forum::message::approve (public)

 forum::message::approve -message_id message_id

Approve a message.

Switches:
-message_id (required)

Testcases:
forum_message_new

forum::message::close (public)

 forum::message::close -message_id message_id

Close a thread.
This is not exactly a cheap operation if the thread is long.

Switches:
-message_id (required)

Testcases:
forum_message_new

forum::message::delete (public)

 forum::message::delete -message_id message_id [ -no_callback ]

Delete a message and obviously all of its descendents.

Switches:
-message_id (required)
-no_callback (optional, boolean)

Testcases:
forum_count_test, web_forums_message_and_reply

forum::message::do_notifications (public)

 forum::message::do_notifications -message_id message_id \
    [ -user_id user_id ]

Perform the notifications.

Switches:
-message_id (required)
-user_id (optional)

Testcases:
forum_message_new, forum_count_test

forum::message::edit (public)

 forum::message::edit -message_id message_id -subject subject \
    -content content -format format [ -no_callback ]

Editing a message. There is no versioning here! This means this function is for admins only!

Switches:
-message_id (required)
-subject (required)
-content (required)
-format (required)
-no_callback (optional, boolean)

Testcases:
web_forums_message_and_reply

forum::message::get (public)

 forum::message::get -message_id message_id -array array

Get the fields for a message.

Switches:
-message_id (required)
-array (required)

Testcases:
forum_message_new, forum_count_test, web_forums_message_and_reply

forum::message::get_attachments (public, deprecated)

 forum::message::get_attachments -message_id message_id
Deprecated. Invoking this procedure generates a warning.

Get the attachments for a message. DEPRECATED: this proc requires a connection context in a forums package instance to work as expected. An alternative could be to retrieve the forum_id from the message instead, but as this proc is not used anywhere and its logics are not difficult to inline, we just deprecate it.

Switches:
-message_id (required)
See Also:

Testcases:
No testcase defined.

forum::message::initial_message (public, deprecated)

 forum::message::initial_message [ -forum_id forum_id ] \
    [ -parent parent ] -message message
Deprecated. Invoking this procedure generates a warning.

Create an array with values initialized for a new message. DEPRECATED: this proc is not used in current upstream code, its upvar juggling is questionable and most of the data returned is already provided from the start.

Switches:
-forum_id (optional)
-parent (optional)
-message (required)
See Also:

Testcases:
No testcase defined.

forum::message::new (public)

 forum::message::new -forum_id forum_id [ -message_id message_id ] \
    [ -parent_id parent_id ] -subject subject -content content \
    [ -format format ] [ -user_id user_id ] [ -no_callback ]

Create a new message.

Switches:
-forum_id (required)
-message_id (optional)
-parent_id (optional)
-subject (required)
-content (required)
-format (optional, defaults to "text/plain")
-user_id (optional)
-no_callback (optional, boolean)

Testcases:
forum_message_new, forum_count_test, web_forums_message_and_reply

forum::message::notify_moderators (private)

 forum::message::notify_moderators -message_array message_array \
    -forum_url forum_url -message_url message_url

Notify moderators of a new forum message

Switches:
-message_array (required)
name of message array of forum info in the caller scope
-forum_url (required)
-message_url (required)

Testcases:
forum_message_new, forum_count_test

forum::message::notify_users (private)

 forum::message::notify_users -message_array message_array \
    -forum_url forum_url -message_url message_url

Notify users of a new approved forum message.

Switches:
-message_array (required)
name of message array of forum info in the caller scope
-forum_url (required)
-message_url (required)

Testcases:
forum_message_new, forum_count_test

forum::message::open (public)

 forum::message::open -message_id message_id

Reopen a thread.
This is not exactly a cheap operation if the thread is long.

Switches:
-message_id (required)

Testcases:
forum_message_new

forum::message::reject (public)

 forum::message::reject -message_id message_id

Reject a message.

Switches:
-message_id (required)

Testcases:
forum_message_new

forum::message::set_format (public)

 forum::message::set_format -message_id message_id -format format

Set whether a message is HTML or not.

Switches:
-message_id (required)
-format (required)

Testcases:
forum_message_new

forum::message::set_state (private)

 forum::message::set_state -message_id message_id -state state

Set the new state for a message.
Usually, used for approval.

Switches:
-message_id (required)
-state (required)

Testcases:
forum_count_test, web_forums_message_and_reply

forum::message::subject_sort_filter (public, deprecated)

 forum::message::subject_sort_filter -forum_id forum_id \
    -order_by order_by
Deprecated. Invoking this procedure generates a warning.

Switches:
-forum_id (required)
-order_by (required)
Returns:
A piece of HTML for toggling the sort order of threads (subjects) in a forum. The user can either sort by the first postings in subjects (the creation date of the subjects) or the last one. DEPRECATED: this proc is not mentioned anywhere in current upstream codebase. Furthermore, it refers to a very specific UI (e.g. sorting properties, styling...) and does therefore provide little value in general.
Author:
Peter Marklund
See Also:
  • idioms in the specific UI

Testcases:
No testcase defined.
[ show source ]