-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
162 additions
and
139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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,86 +48,95 @@ 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') | ||
| .. figure:: https://raw.githubusercontent.com/OCA/web/16.0/web_notify/static/description/notifications_screenshot.gif | ||
| :scale: 80 % | ||
| :alt: 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. | ||
|
|
||
| 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/description/test_notifications_demo.png | ||
| :scale: 80 % | ||
| :alt: Sample notifications | ||
| .. |image1| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/description/notifications_screenshot.gif | ||
| .. |image2| image:: https://raw.githubusercontent.com/OCA/web/17.0/web_notify/static/description/test_notifications_demo.png | ||
|
|
||
| Bug Tracker | ||
| =========== | ||
|
|
||
| Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_notify%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
| `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_notify%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. | ||
|
|
||
| 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 <https://www.tecnativa.com>`__: | ||
|
|
||
| * Laurent Mignon <[email protected]> | ||
| * Serpent Consulting Services Pvt. Ltd.<[email protected]> | ||
| * Aitor Bouzas <[email protected]> | ||
| * Shepilov Vladislav <[email protected]> | ||
| * Kevin Khao <[email protected]> | ||
| * `Tecnativa <https://www.tecnativa.com>`_: | ||
| - David Vidal | ||
|
|
||
| * David Vidal | ||
| - Nikul Chaudhary <[email protected]> | ||
|
|
||
| Maintainers | ||
| ~~~~~~~~~~~ | ||
| ----------- | ||
|
|
||
| This module is maintained by the OCA. | ||
|
|
||
|
|
@@ -138,6 +148,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 <https://github.com/OCA/web/tree/16.0/web_notify>`_ project on GitHub. | ||
| This module is part of the `OCA/web <https://github.com/OCA/web/tree/17.0/web_notify>`_ project on GitHub. | ||
|
|
||
| You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [build-system] | ||
| requires = ["whool"] | ||
| build-backend = "whool.buildapi" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| - Laurent Mignon \<<[email protected]>\> | ||
| - Serpent Consulting Services Pvt. Ltd.\<<[email protected]>\> | ||
| - Aitor Bouzas \<<[email protected]>\> | ||
| - Shepilov Vladislav \<<[email protected]>\> | ||
| - Kevin Khao \<<[email protected]>\> | ||
| - [Tecnativa](https://www.tecnativa.com): | ||
| - David Vidal | ||
|
|
||
| - Nikul Chaudhary \<<[email protected]>\> |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| 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') | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.