general-comments-callback-procs.tcl

Callback Procs for general comments

Location:
packages/general-comments/tcl/general-comments-callback-procs.tcl

Procedures in this file

Detailed information

callback::general_comments::notify_objects::contract (private)

 callback::general_comments::notify_objects::contract \
    -object_id object_id -comment comment -title title \
    -object_type object_type

This callback is being called once a comment has been added

Switches:
-object_id (required)
Object ID of the object to which the comment was added
-comment (required)
Comment that was provided. This is HTML.
-title (required)
Title given with the comment
-object_type (required)
Object Type of the object id. This is useful to quickly say in the package implementations whether you want to deal with the comment or not.

Testcases:
No testcase defined.
[ hide source ] | [ make this the default ]

Content File Source

ad_library {
    Callback Procs for general comments

}

namespace eval general_comments {}


d_proc -public -callback general_comments::notify_objects {
    {-object_id:required}
    {-comment:required}
    {-title:required}
    {-object_type:required}
} {
    This callback is being called once a comment has been added

    @param object_id Object ID of the object to which the comment was added
    @param title Title given with the comment
    @param comment Comment that was provided. This is HTML.
    @param object_type Object Type of the object id. This is useful to quickly say in the package implementations whether you want to deal with the comment or not.
} -

# Local variables:
#    mode: tcl
#    tcl-indent-level: 4
#    indent-tabs-mode: nil
# End: