- Publicity: Public Only All
acs-messaging-procs.tcl
Utility procs for working with messages
- Location:
- packages/acs-messaging/tcl/acs-messaging-procs.tcl
- Created:
- 2000-09-01
- Author:
- John Prevost
- CVS Identification:
$Id: acs-messaging-procs.tcl,v 1.9.2.5 2022/09/08 16:17:02 antoniop Exp $
Procedures in this file
- acs_message_p (public)
- acs_messaging_first_ancestor (public)
- acs_messaging_send_query (public)
- ad_page_contract_filter_proc_acs_message_id (public, deprecated)
Detailed information
acs_message_p (public)
acs_message_p message_id
Check if an integer is a valid OpenACS message id.
- Parameters:
- message_id (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- acs_messaging_message_p
acs_messaging_first_ancestor (public)
acs_messaging_first_ancestor message_id
Takes the message_id of an acs_message and returns the message_id of the first ancestor message (i.e. the message that originated the thread).
- Parameters:
- message_id (required)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
acs_messaging_send_query (public)
acs_messaging_send_query -message_id message_id -query query \ [ -bind bind ]
Given an SQL query returning columns recipient_id, grouping_id, and wait_until, arrange for all to be sent for this message. Example: acs_message_send_query -message_id $new_message -query { select subscriber_id as recipient_id, forum_id as grouping_id, bboard_util.next_period(period) as wait_until from bboard_forum_subscribers where forum_id = :forum_id } -bind [list forum_id $forum_id] Assuming bboard_util.next_period(period) returns the next date at which a digest should be sent, the above will enter info to send all subscriptions for a single message. The bind argument, if given, must be a list, NOT an ns_set.
- Switches:
- -message_id (required)
- -query (required)
- -bind (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
ad_page_contract_filter_proc_acs_message_id (public, deprecated)
ad_page_contract_filter_proc_acs_message_id name value_varname
Deprecated. Invoking this procedure generates a warning.
Checks whether the value (assumed to be an integer) is the id of an already-existing OpenACS message. DEPRECATED: OpenACS now has a generic filter object_type.
- Parameters:
- name (required)
- value_varname (required)
- See Also:
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.