README.rst

Web Notify

Send instant notification messages to the user in live.

This technical module allows you to send instant notification messages from the server to the user in live. Two kinds of notification are supported.

• Success: Displayed in a success theme color flying popup div
• Danger: Displayed in a danger theme color flying popup div
• Warning: Displayed in a warning theme color flying popup div
• Information: Displayed in a info theme color flying popup div
• Default: Displayed in a default theme color flying popup div

Table of contents

• Installation
• Usage
• Bug Tracker
• Credits
  • Authors
  • Contributors
  • Maintainers

Installation

This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.

Usage

To send a notification to the user you just need to call one of the new methods defined on res.users:

self.env.user.notify_success(message='My success message')

or

self.env.user.notify_danger(message='My danger message')

or

self.env.user.notify_warning(message='My warning message')

or

self.env.user.notify_info(message='My information message')

or

self.env.user.notify_default(message='My default message')

The notifications can bring interactivity with some buttons.

• One allowing to refresh the active view
• Another allowing to send a window / client action

The reload button is activated when sending the notification with:

The action can be used using the action keyword and we can choose which name to give to our button with the button_name key in the action context params key:

action = self.env["ir.actions.act_window"]._for_xml_id('sale.action_orders')
action.update({
   'res_id': self.id,
   'views': [(False, 'form')],
})
action["context"].setdefault("params", {})
action["context"]["params"]["button_name"] = "Sales"
action["context"]["params"]["button_icon"] = "fa-eye"
self.env.user.notify_info('My information message', action=action)

You can test the behaviour of the notifications by installing this module in a demo database. Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• ACSONE SA/NV
• AdaptiveCity

Contributors

• Laurent Mignon <[email protected]>
• Serpent Consulting Services Pvt. Ltd.<[email protected]>
• Aitor Bouzas <[email protected]>
• Shepilov Vladislav <[email protected]>
• Kevin Khao <[email protected]>
• Tecnativa:
  • David Vidal

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.