notifications-security-procs.tcl

Notifications Security Library Manage permissions for notifications.

Location:
packages/notifications/tcl/notifications-security-procs.tcl
Created:
2002-05-27
Author:
Ben Adida
CVS Identification:
$Id: notifications-security-procs.tcl,v 1.9.2.3 2024/08/28 06:34:03 gustafn Exp $

Procedures in this file

Detailed information

notification::security::can_admin_request_p (public)

 notification::security::can_admin_request_p [ -user_id user_id ] \
    -request_id request_id

Checks if a user can manage a given notification request.

Switches:
-user_id (optional)
-request_id (required)
Returns:
boolean value

Testcases:
No testcase defined.

notification::security::can_notify_object_p (public)

 notification::security::can_notify_object_p [ -user_id user_id ] \
    -object_id object_id

This checks if a user can request notification on a given object.

Switches:
-user_id (optional)
-object_id (required)
Returns:
boolean value

Testcases:
No testcase defined.

notification::security::can_notify_user (public)

 notification::security::can_notify_user -user_id user_id \
    [ -delivery_method_id delivery_method_id ]

Can a user be notified for a given delivery method. This proc can be expanded to deal with cases when we don't want to send a notification. For instance we could check email_bouncing_p or if a user is on vacation. Right now it just makes sure its an approved user.

Switches:
-user_id (required)
-delivery_method_id (optional)
Returns:
boolean value

Testcases:
No testcase defined.

notification::security::require_admin_request (public)

 notification::security::require_admin_request [ -user_id user_id ] \
    -request_id request_id

Require the ability to admin a request. The function raised potentially a script_abort exception, when the user is not logged in.

Switches:
-user_id (optional)
-request_id (required)
Returns:
boolean value expressing if the user can issued an admin request
See Also:

Testcases:
No testcase defined.

notification::security::require_notify_object (public)

 notification::security::require_notify_object [ -user_id user_id ] \
    -object_id object_id

Require the ability to notify on an object. The function raised potentially a script_abort exception, when the user is not logged in.

Switches:
-user_id (optional)
-object_id (required)
Returns:
boolean value expressing if we can notify the user

Testcases:
No testcase defined.
[ show source ]