Skip to content

Commit

Permalink
MT#61140 Docs: add to-tag description for NG delete
Browse files Browse the repository at this point in the history
Describes the `to-tag` option flag action for the
NG delete case.

Change-Id: I8df60425195138eb2162e4c63b6ed8fa7b6a96f0
  • Loading branch information
zenichev committed Sep 26, 2024
1 parent e22282a commit 902ca49
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/ng_control_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 902ca49

Please sign in to comment.