• Publicity: Public Only All

delivery-method-procs.tcl

Notification Delivery Methods Functions to support notification delivery methods. A delivery method is a means by which a notification is sent to a user. "Email" is a common one, but others, like "sms", may exist. The delivery method integration is done via acs-service-contract: any new delivery method must implement this service contract.

Location:
packages/notifications/tcl/delivery-method-procs.tcl
Created:
2002-05-24
Author:
Ben Adida
CVS Identification:
$Id: delivery-method-procs.tcl,v 1.16.2.3 2022/07/12 14:02:11 antoniop Exp $

Procedures in this file

Detailed information

notification::delivery::delete (public)

 notification::delivery::delete -delivery_method_id delivery_method_id

Unregister a delivery method with the notification service.

Switches:
-delivery_method_id (required)

Testcases:
No testcase defined.

notification::delivery::get_id (public)

 notification::delivery::get_id -short_name short_name

Return the delivery_method_id from the short_name.

Switches:
-short_name (required)

Testcases:
No testcase defined.

notification::delivery::new (public)

 notification::delivery::new [ -delivery_method_id delivery_method_id ] \
    -sc_impl_id sc_impl_id -short_name short_name \
    -pretty_name pretty_name

Register a new delivery method with the notification service.

Switches:
-delivery_method_id (optional)
-sc_impl_id (required)
-short_name (required)
-pretty_name (required)

Testcases:
No testcase defined.

notification::delivery::scan_replies (public)

 notification::delivery::scan_replies \
    -delivery_method_id delivery_method_id

scan for replies. Every delivery method allows for replies. This is the wrapper proc that indicates to the delivery method service contract implementation that it's time to scan for replies.

Switches:
-delivery_method_id (required)

Testcases:
No testcase defined.

notification::delivery::send (public)

 notification::delivery::send -delivery_method_id delivery_method_id \
    [ -reply_object_id reply_object_id ] \
    -notification_type_id notification_type_id \
    [ -from_user_id from_user_id ] -to_user_id to_user_id \
    -subject subject -content_text content_text \
    -content_html content_html [ -file_ids file_ids ]

do the delivery of certain content to a particular user using a particular delivery method. This is just a wrapper proc that sets up the call to the service contract implementation for a given delivery method.

Switches:
-delivery_method_id (required)
-reply_object_id (optional)
-notification_type_id (required)
-from_user_id (optional)
-to_user_id (required)
-subject (required)
-content_text (required)
-content_html (required)
-file_ids (optional)

Testcases:
No testcase defined.
[ show source ]