details: https://code.tryton.org/tryton/commit/cf9db3d44577
branch: default
user: Cédric Krier <[email protected]>
date: Tue Dec 02 14:38:58 2025 +0100
description:
Add documentation for chat
diffstat:
trytond/doc/modules/ir/design/chat.inc.rst | 25 +++++++++++++++++++++++++
trytond/doc/modules/ir/design/index.rst | 1 +
trytond/doc/ref/models.rst | 9 +++++++++
3 files changed, 35 insertions(+), 0 deletions(-)
diffs (59 lines):
diff -r 7173c77acabb -r cf9db3d44577 trytond/doc/modules/ir/design/chat.inc.rst
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/trytond/doc/modules/ir/design/chat.inc.rst Tue Dec 02 14:38:58
2025 +0100
@@ -0,0 +1,25 @@
+.. _model-ir.chat.channel:
+
+Chat Channel
+============
+
+A *Channel* stores the `model-ir.chat.message` linked to a
+:class:`~trytond.model.ChatMixin`.
+
+
+.. _model-ir.chat.follower:
+
+Chat Follower
+=============
+
+The *Follower* concept stores the `model-res.user` or *email* to
+notify for new message on the linked `model-ir.chat.channel`.
+
+
+.. _model-ir.chat.message:
+
+Chat Message
+============
+
+A *Message* stores the content posted to a `model-ir.chat.channel`.
+The audience property defines who can see the message.
diff -r 7173c77acabb -r cf9db3d44577 trytond/doc/modules/ir/design/index.rst
--- a/trytond/doc/modules/ir/design/index.rst Tue Dec 02 13:39:07 2025 +0100
+++ b/trytond/doc/modules/ir/design/index.rst Tue Dec 02 14:38:58 2025 +0100
@@ -25,6 +25,7 @@
.. include:: lang.inc.rst
.. include:: message.inc.rst
.. include:: note.inc.rst
+.. include:: chat.inc.rst
.. include:: queue.inc.rst
.. include:: rule.inc.rst
.. include:: sequence.inc.rst
diff -r 7173c77acabb -r cf9db3d44577 trytond/doc/ref/models.rst
--- a/trytond/doc/ref/models.rst Tue Dec 02 13:39:07 2025 +0100
+++ b/trytond/doc/ref/models.rst Tue Dec 02 14:38:58 2025 +0100
@@ -1278,6 +1278,15 @@
Generate a default avatar for each record using the field.
+ChatMixin
+=========
+
+.. class:: ChatMixin
+
+A mixin_ to activate a `model-ir.chat.channel` on any
+:class:`~trytond.model.ModelStorage` record.
+
+
.. _mixin: http://en.wikipedia.org/wiki/Mixin
.. _JSON: http://en.wikipedia.org/wiki/Json
.. _UNION: http://en.wikipedia.org/wiki/Union_(SQL)#UNION_operator
