You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
3.8 KiB

  1. ==========
  2. Web Notify
  3. ==========
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/12.0/web_notify
  16. :alt: OCA/web
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_notify
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/162/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. Send instant notification messages to the user in live.
  25. This technical module allows you to send instant notification messages from the server to the user in live.
  26. Two kinds of notification are supported.
  27. * Warning: Displayed in a red flying popup div
  28. * Information: Displayed in a light yellow flying popup div
  29. **Table of contents**
  30. .. contents::
  31. :local:
  32. Installation
  33. ============
  34. This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.
  35. Usage
  36. =====
  37. To send a notification to the user you just need to call one of the new methods defined on res.users:
  38. .. code-block:: python
  39. self.env.user.notify_info(message='My information message')
  40. or
  41. .. code-block:: python
  42. self.env.user.notify_warning(message='My marning message')
  43. .. figure:: https://raw.githubusercontent.com/OCA/web/12.0/web_notify/static/description/notifications_screenshot.png
  44. :scale: 80 %
  45. :alt: Sample notifications
  46. You can test the behaviour of the notifications by installing this module in a demo database.
  47. 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.
  48. .. figure:: https://raw.githubusercontent.com/OCA/web/12.0/web_notify/static/description/test_notifications_demo.png
  49. :scale: 80 %
  50. :alt: Sample notifications
  51. Bug Tracker
  52. ===========
  53. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  54. In case of trouble, please check there if your issue has already been reported.
  55. If you spotted it first, help us smashing it by providing a detailed and welcomed
  56. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_notify%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  57. Do not contact contributors directly about support or help with technical issues.
  58. Credits
  59. =======
  60. Authors
  61. ~~~~~~~
  62. * ACSONE SA/NV
  63. * AdaptiveCity
  64. Contributors
  65. ~~~~~~~~~~~~
  66. * Laurent Mignon <laurent.mignon@acsone.eu>
  67. * Serpent Consulting Services Pvt. Ltd.<jay.vora@serpentcs.com>
  68. * Aitor Bouzas <aitor.bouzas@adaptivecity.com>
  69. Maintainers
  70. ~~~~~~~~~~~
  71. This module is maintained by the OCA.
  72. .. image:: https://odoo-community.org/logo.png
  73. :alt: Odoo Community Association
  74. :target: https://odoo-community.org
  75. OCA, or the Odoo Community Association, is a nonprofit organization whose
  76. mission is to support the collaborative development of Odoo features and
  77. promote its widespread use.
  78. This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_notify>`_ project on GitHub.
  79. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.