Tower: upload cx_web_refresh_from_backend 16.0.1.0.0 (via marketplace)
This commit is contained in:
127
addons/cx_web_refresh_from_backend/README.rst
Normal file
127
addons/cx_web_refresh_from_backend/README.rst
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
========================
|
||||||
|
Web Refresh From Backend
|
||||||
|
========================
|
||||||
|
|
||||||
|
..
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! This file is generated by oca-gen-addon-readme !!
|
||||||
|
!! changes will be overwritten. !!
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! source digest: sha256:e841ff66d3bfff0a3de22c9be5dc40f1ca539739f5487a9162fdf887fc5ac6ad
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
|
||||||
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||||
|
:target: https://odoo-community.org/page/development-status
|
||||||
|
:alt: Beta
|
||||||
|
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
|
||||||
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
||||||
|
:alt: License: LGPL-3
|
||||||
|
.. |badge3| image:: https://img.shields.io/badge/github-cetmix%2Fcetmix--tower-lightgray.png?logo=github
|
||||||
|
:target: https://github.com/cetmix/cetmix-tower/tree/16.0/cx_web_refresh_from_backend
|
||||||
|
:alt: cetmix/cetmix-tower
|
||||||
|
|
||||||
|
|badge1| |badge2| |badge3|
|
||||||
|
|
||||||
|
Backend UI Reload Module
|
||||||
|
========================
|
||||||
|
|
||||||
|
This is a **technical module** that allows triggering a **UI reload**
|
||||||
|
from the backend. It enables triggering the reload action for selected
|
||||||
|
users and record IDs.
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
|
🔧 Helper Function: ``reload_views``
|
||||||
|
------------------------------------
|
||||||
|
|
||||||
|
A special helper function ``reload_views`` is added to the ``res.users``
|
||||||
|
model.
|
||||||
|
|
||||||
|
**Arguments**
|
||||||
|
~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
+----------------+--------------------------+--------------------------+
|
||||||
|
| Argument | Type | Description |
|
||||||
|
+================+==========================+==========================+
|
||||||
|
| **model** | ``Char`` | Model name, e.g. |
|
||||||
|
| | | ``'res.partner'`` |
|
||||||
|
+----------------+--------------------------+--------------------------+
|
||||||
|
| **view_types** | ``List of Char`` | View types to reload, |
|
||||||
|
| | *(optional)* | e.g. |
|
||||||
|
| | | ``["form", "kanban"]``. |
|
||||||
|
| | | Leave blank to reload |
|
||||||
|
| | | all views. |
|
||||||
|
+----------------+--------------------------+--------------------------+
|
||||||
|
| **rec_ids** | ``List of Integer`` | The view will be |
|
||||||
|
| | *(optional)* | reloaded only if a |
|
||||||
|
| | | record with an ID from |
|
||||||
|
| | | this list is present in |
|
||||||
|
| | | the view. |
|
||||||
|
+----------------+--------------------------+--------------------------+
|
||||||
|
|
||||||
|
--------------
|
||||||
|
|
||||||
|
⚠️ Important Notes
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Use this function **wisely**.
|
||||||
|
|
||||||
|
When reloading **form views**, be aware that if a user is currently
|
||||||
|
editing a record, **their unsaved updates may be lost**.
|
||||||
|
|
||||||
|
**Table of contents**
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
|
||||||
|
Usage
|
||||||
|
=====
|
||||||
|
|
||||||
|
🧩 Example Usage
|
||||||
|
----------------
|
||||||
|
|
||||||
|
Below is a code snippet showing how to use the ``reload_views`` helper
|
||||||
|
function.
|
||||||
|
|
||||||
|
.. code:: python
|
||||||
|
|
||||||
|
# Reload the kanban and form views for all salespeople when an opportunity is won
|
||||||
|
# Will reload views only if the current opportunity is being displayed
|
||||||
|
|
||||||
|
group_id = self.env.ref("sales_team.group_sale_salesman").id
|
||||||
|
users_to_reload = self.env["res.users"].search([("groups_id", "in", [group_id])])
|
||||||
|
users_to_reload.reload_views(
|
||||||
|
model="crm.lead",
|
||||||
|
view_types=["kanban", "form"],
|
||||||
|
rec_ids=[self.id],
|
||||||
|
)
|
||||||
|
|
||||||
|
Bug Tracker
|
||||||
|
===========
|
||||||
|
|
||||||
|
Bugs are tracked on `GitHub Issues <https://github.com/cetmix/cetmix-tower/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/cetmix/cetmix-tower/issues/new?body=module:%20cx_web_refresh_from_backend%0Aversion:%2016.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
|
||||||
|
-------
|
||||||
|
|
||||||
|
* Cetmix
|
||||||
|
|
||||||
|
Contributors
|
||||||
|
------------
|
||||||
|
|
||||||
|
- Cetmix
|
||||||
|
|
||||||
|
Maintainers
|
||||||
|
-----------
|
||||||
|
|
||||||
|
This module is part of the `cetmix/cetmix-tower <https://github.com/cetmix/cetmix-tower/tree/16.0/cx_web_refresh_from_backend>`_ project on GitHub.
|
||||||
|
|
||||||
|
You are welcome to contribute.
|
||||||
Reference in New Issue
Block a user