notification-display-procs.tcl

Publicity: Public Only All

notification-display-procs.tcl

Notifications Display Procs. Notifications is mostly a service package, but it does have some level of user interface. These procs enable other packages to simply display information about notifications.

Location:

packages/notifications/tcl/notification-display-procs.tcl
Created:

2002-05-24
Author:

Ben Adida
CVS Identification:

$Id: notification-display-procs.tcl,v 1.21.2.3 2022/07/12 14:05:27 antoniop Exp $

Procedures in this file

notification::display::get_urls (public)
notification::display::request_widget (public)
notification::display::subscribe_url (public)
notification::display::unsubscribe_url (public)

Detailed information

notification::display::get_urls (public)

 notification::display::get_urls -type type -object_id object_id \
    [ -return_url return_url ] [ -pretty_name pretty_name ] \
    [ -user_id user_id ]

Get both subscribe_url and unsubscribe_url as a list. At most one of them will be set. Example:
    lassign [notification::display::get_urls  -type "my_notif_type"  -object_id $object_id  -pretty_name $title] subscribe_url unsubscribe_url
    
Switches:

-type (required)
-object_id (required)
-return_url (optional)
-pretty_name (optional)
-user_id (optional)

Returns:
a Tcl list with two elements (subscribe_url, unsubscribe_url)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

notification::display::request_widget (public)

 notification::display::request_widget -type type -object_id object_id \
    -pretty_name pretty_name -url url [ -user_id user_id ]

Produce a widget for requesting notifications of a given type. If the notifications package has not been mounted then return the empty string.

Switches:

-type (required)
-object_id (required)
-pretty_name (required)
-url (required)
-user_id (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

notification::display::subscribe_url (public)

 notification::display::subscribe_url -type type -object_id object_id \
    -url url -user_id user_id [ -pretty_name pretty_name ]

Returns the URL that allows one to subscribe to a notification type on a particular object. If the notifications package has not been mounted return the empty string.

Switches:

-type (required)
-object_id (required)
-url (required)
-user_id (required)
-pretty_name (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

notification::display::unsubscribe_url (public)

 notification::display::unsubscribe_url -request_id request_id -url url

Returns the URL that allows one to unsubscribe from a particular request.

Switches:

-request_id (required)
-url (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:
No testcase defined.

[ show source ]