diff --git a/web_notify/README.rst b/web_notify/README.rst index 006ae9513..a61830850 100644 --- a/web_notify/README.rst +++ b/web_notify/README.rst @@ -17,27 +17,28 @@ Web Notify :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github - :target: https://github.com/OCA/web/tree/16.0/web_notify + :target: https://github.com/OCA/web/tree/17.0/web_notify :alt: OCA/web .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_notify + :target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_notify :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png - :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0 + :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0 :alt: Try me on Runboat |badge1| |badge2| |badge3| |badge4| |badge5| 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. +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 +- 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** @@ -47,74 +48,77 @@ Two kinds of notification are supported. Installation ============ -This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. +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: -To send a notification to the user you just need to call one of the new methods defined on res.users: - -.. code-block:: python +.. code:: python self.env.user.notify_success(message='My success message') or -.. code-block:: python +.. code:: python self.env.user.notify_danger(message='My danger message') or -.. code-block:: python +.. code:: python self.env.user.notify_warning(message='My warning message') or -.. code-block:: python +.. code:: python self.env.user.notify_info(message='My information message') or -.. code-block:: python +.. code:: python 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 +- 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: +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: -.. code-block:: python +.. code:: python - 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) + 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) +|image1| -.. figure:: https://raw.githubusercontent.com/OCA/web/16.0/web_notify/static/img/notifications_screenshot.gif - :alt: 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. -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. +|image2| -.. figure:: https://raw.githubusercontent.com/OCA/web/16.0/web_notify/static/img/test_notifications_demo.png - :alt: Sample notifications +.. |image1| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/img/notifications_screenshot.gif +.. |image2| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/img/test_notifications_demo.png Bug Tracker =========== @@ -122,7 +126,7 @@ 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -130,25 +134,25 @@ Credits ======= Authors -~~~~~~~ +------- * ACSONE SA/NV * AdaptiveCity Contributors -~~~~~~~~~~~~ +------------ -* Laurent Mignon -* Serpent Consulting Services Pvt. Ltd. -* Aitor Bouzas -* Shepilov Vladislav -* Kevin Khao -* `Tecnativa `_: +- Laurent Mignon +- Serpent Consulting Services Pvt. Ltd. +- Aitor Bouzas +- Shepilov Vladislav +- Kevin Khao +- `Tecnativa `__: - * David Vidal + - David Vidal Maintainers -~~~~~~~~~~~ +----------- This module is maintained by the OCA. @@ -160,6 +164,6 @@ 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. +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. diff --git a/web_notify/pyproject.toml b/web_notify/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/web_notify/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/web_notify/readme/CONTRIBUTORS.md b/web_notify/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..97775e9a9 --- /dev/null +++ b/web_notify/readme/CONTRIBUTORS.md @@ -0,0 +1,7 @@ +- Laurent Mignon \<\> +- Serpent Consulting Services Pvt. Ltd.\<\> +- Aitor Bouzas \<\> +- Shepilov Vladislav \<\> +- Kevin Khao \<\> +- [Tecnativa](https://www.tecnativa.com): + - David Vidal diff --git a/web_notify/readme/CONTRIBUTORS.rst b/web_notify/readme/CONTRIBUTORS.rst deleted file mode 100644 index 77bb03c5e..000000000 --- a/web_notify/readme/CONTRIBUTORS.rst +++ /dev/null @@ -1,8 +0,0 @@ -* Laurent Mignon -* Serpent Consulting Services Pvt. Ltd. -* Aitor Bouzas -* Shepilov Vladislav -* Kevin Khao -* `Tecnativa `_: - - * David Vidal diff --git a/web_notify/readme/DESCRIPTION.md b/web_notify/readme/DESCRIPTION.md new file mode 100644 index 000000000..003a0133e --- /dev/null +++ b/web_notify/readme/DESCRIPTION.md @@ -0,0 +1,11 @@ +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 diff --git a/web_notify/readme/DESCRIPTION.rst b/web_notify/readme/DESCRIPTION.rst deleted file mode 100644 index 2cd897801..000000000 --- a/web_notify/readme/DESCRIPTION.rst +++ /dev/null @@ -1,10 +0,0 @@ -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 diff --git a/web_notify/readme/INSTALL.rst b/web_notify/readme/INSTALL.md similarity index 56% rename from web_notify/readme/INSTALL.rst rename to web_notify/readme/INSTALL.md index b47aebb79..0ec795793 100644 --- a/web_notify/readme/INSTALL.rst +++ b/web_notify/readme/INSTALL.md @@ -1 +1,2 @@ -This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode. +This module is based on the Instant Messaging Bus. To work properly, the +server must be launched in gevent mode. diff --git a/web_notify/readme/USAGE.md b/web_notify/readme/USAGE.md new file mode 100644 index 000000000..b6922cbf2 --- /dev/null +++ b/web_notify/readme/USAGE.md @@ -0,0 +1,62 @@ +To send a notification to the user you just need to call one of the new +methods defined on res.users: + +``` python +self.env.user.notify_success(message='My success message') +``` + +or + +``` python +self.env.user.notify_danger(message='My danger message') +``` + +or + +``` python +self.env.user.notify_warning(message='My warning message') +``` + +or + +``` python +self.env.user.notify_info(message='My information message') +``` + +or + +``` python +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: + +``` python +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) +``` + +![](../static/img/notifications_screenshot.gif) + +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. + +![](../static/img/test_notifications_demo.png) diff --git a/web_notify/readme/USAGE.rst b/web_notify/readme/USAGE.rst deleted file mode 100644 index d018bc7c8..000000000 --- a/web_notify/readme/USAGE.rst +++ /dev/null @@ -1,63 +0,0 @@ - -To send a notification to the user you just need to call one of the new methods defined on res.users: - -.. code-block:: python - - self.env.user.notify_success(message='My success message') - -or - -.. code-block:: python - - self.env.user.notify_danger(message='My danger message') - -or - -.. code-block:: python - - self.env.user.notify_warning(message='My warning message') - -or - -.. code-block:: python - - self.env.user.notify_info(message='My information message') - -or - -.. code-block:: python - - 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: - -.. code-block:: python - - 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) - - -.. figure:: ../static/img/notifications_screenshot.gif - :alt: 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. - -.. figure:: ../static/img/test_notifications_demo.png - :alt: Sample notifications diff --git a/web_notify/static/description/index.html b/web_notify/static/description/index.html index 609f9b5e9..400b4fc53 100644 --- a/web_notify/static/description/index.html +++ b/web_notify/static/description/index.html @@ -369,16 +369,17 @@ ul.auto-toc { !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! source digest: sha256:4869ee3b6cdd657030585657c2ede8fd85f2c6cf12fcbedfc662b7d35e3f9c5a !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

+

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.

+

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
    • +
  • 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

@@ -396,11 +397,13 @@ Two kinds of notification are supported.

Installation

-

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

+

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:

+

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')
@@ -426,8 +429,9 @@ Two kinds of notification are supported.

  • 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:

    +

    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({
@@ -439,21 +443,19 @@ give to our button with the button_name key in
 action["context"]["params"]["button_icon"] = "fa-eye"
 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 -
    +

    image1

    +

    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.

    +

    image2

    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.

    +feedback.

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

    @@ -488,7 +490,7 @@ If you spotted it first, help us to smash it by providing a detailed and welcome

    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.

    +

    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.