---

Class ::xowiki::includelet::personal-notification-messages

::xowiki::includelet::personal-notification-messages create ... \
           [ -__decoration (default "plain") ] \
           [ -parameter_declaration (default "
          {-url_poll ""}
          {-url_dismiss ""}
          {-poll_interval 5000}
        ") ]

Personal notification messages This includelet can be used for personal messaging, where a sender can send messages to a single user in a single applications (e.g. in an exam), where the user has to acknowledge every single message to make it disappear (current implementation). The messages are not persisted (current implementation).

Defined in packages/xowiki/tcl/personal-notification-procs.tcl

Class Relations

• class: ::xotcl::Class
• superclass: ::xowiki::Includelet

Methods (to be applied on the object)

• get_messages_response (scripted, public)

   xowiki::includelet::personal-notification-messages get_messages_response \
      [ -notification_id notification_id ] [ -user_id user_id ]

  Get all messages for the notification-id and the give user in form of an AJAX array.

  Switches:

  -notification_id

  (optional)

  -user_id

  (optional)

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

  Testcases:

  No testcase defined.

• message_add (scripted, public)

   xowiki::includelet::personal-notification-messages message_add \
      [ -notification_id notification_id ] [ -to_user_id to_user_id ] \
      -payload payload 

  Send the user a message. The payload has the form of a dict containing at least "msg" and "from" (in form of a user_id).

  Switches:

  -notification_id

  (optional)

  -to_user_id

  (optional)

  -payload

  (required)

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

  Testcases:

  No testcase defined.

• message_dismiss (scripted, public)

   xowiki::includelet::personal-notification-messages message_dismiss \
      [ -notification_id notification_id ] [ -user_id user_id ] \
      [ -ts ts ]

  The user has dismissed a message. flush this message from the set of displayed messages.

  Switches:

  -notification_id

  (optional)

  -user_id

  (optional)

  -ts

  (optional)

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

  Testcases:

  No testcase defined.

• modal_message_dialog (scripted, public)

   xowiki::includelet::personal-notification-messages modal_message_dialog \
      [ -to_user_id to_user_id ] [ -title title ] [ -adpicon adpicon ]

  Create a bootstrap3 modal dialog

  Switches:

  -to_user_id

  (optional)

  -title

  (defaults to "#xowiki.Send_message_to#") (optional)

  -adpicon

  (defaults to "pencil") (optional)

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

  Testcases:

  No testcase defined.

• modal_message_dialog_register_submit (scripted, public)

   xowiki::includelet::personal-notification-messages modal_message_dialog_register_submit \
      -url url 

  Register a submit callback for all bootstrap3 modal dialogs having an .submit class.

  Switches:

  -url

  (required)

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

  Testcases:

  create_test_items

---