Skip to main content

Send notification messages to user

Project description

Production/Stable License: AGPL-3 OCA/web Translate me on Weblate Try me on Runboat

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

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"
self.env.user.notify_info('My information message', action=action)
Sample notifications

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.

Sample notifications

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

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_addon_web_notify-15.0.2.1.1.2-py3-none-any.whl (303.1 kB view details)

Uploaded Python 3

File details

Details for the file odoo_addon_web_notify-15.0.2.1.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_addon_web_notify-15.0.2.1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 95422432fd769e64d59c6093b4673dc0c0a8be63696f8a2b50730386345eb06e
MD5 7cfdf188b06992840d2e8c92a8addc3b
BLAKE2b-256 f7cb417c5756fc2864c926f7fc1dd6a813575c2929bd4cdbcba927e5daf3f2ef

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page