From 902ca49cb5ccf6e2b02e249d0c0bd42f15e3749c Mon Sep 17 00:00:00 2001 From: Donat Zenichev Date: Thu, 26 Sep 2024 14:36:12 +0200 Subject: [PATCH] MT#61140 Docs: add `to-tag` description for NG delete Describes the `to-tag` option flag action for the NG delete case. Change-Id: I8df60425195138eb2162e4c63b6ed8fa7b6a96f0 --- docs/ng_control_protocol.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/ng_control_protocol.md b/docs/ng_control_protocol.md index 5a61af2e4..f98cea1b5 100644 --- a/docs/ng_control_protocol.md +++ b/docs/ng_control_protocol.md @@ -1569,6 +1569,14 @@ of zero or more strings. The following flags are defined: result in an error reply (i.e. `"result": "error"`). The default is to reply with a warning only (i.e. `"result": "ok", "warning": ...`). +* `to-tag` + + This flag controls whether the `"To"` tag's value is honoured or ignored when handling + delete messages. Normally, the `"To"` tag's value is always included when present, + but can be disregarded for the `"delete"` type of messages. + So that, including the `"To-tag"` option flag in the `"delete"` message, + forces to honour it and hence allows to be more selective about monologues within a dialog to be torn down. + Other optional keys are: * `delete delay`