paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-14 10:57:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

api docs: Clarify how mention flags can change.

Browse Source 
The previous description didn't make clear that you can edit a message
to add a mention.

Also, adjust indentation to be the normal 4-space style we use for HTML.
This commit is contained in:
Tim Abbott
2021-05-26 11:57:44 -07:00
parent 55f30458e1
commit 7d1db086c3
1 changed files with 22 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
templates/zerver/api/update-message-flags.md
View File

@@ -55,37 +55,43 @@ More examples and documentation can be found [here](https://github.com/zulip/zul
<tr> <tr>
<td><code>mentioned</code></td> <td><code>mentioned</code></td>
<td> <td>
Whether the current user Whether the current user
<a href="/help/mention-a-user-or-group">was mentioned</a> <a href="/help/mention-a-user-or-group">was mentioned</a>
by this message, either directly or via a user by this message, either directly or via a user
group. Not editable. group. Cannot be changed by the user directly, but
can change if the message is edited to add/remove
a mention of the current user.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>wildcard_mentioned</code></td> <td><code>wildcard_mentioned</code></td>
<td> <td>
Whether this message contained Whether this message contained
<a href="/help/mention-a-user-or-group#mention-everyone-on-a-stream">wildcard mention</a> <a href="/help/mention-a-user-or-group#mention-everyone-on-a-stream">wildcard mention</a>
like @**all**. Not editable. like @**all**. Cannot be changed by the user directly, but
can change if the message is edited to add/remove
a wildcard mention.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>has_alert_word</code></td> <td><code>has_alert_word</code></td>
<td> <td>
Whether the message contains any of the current user's Whether the message contains any of the current user's
<a href="/help/add-an-alert-word">configured alert words</a>. <a href="/help/add-an-alert-word">configured alert words</a>.
Not editable. Cannot be changed by the user directly, but
can change if the message is edited to add/remove
one of the current user's alert words.
</td> </td>
</tr> </tr>
<tr> <tr>
<td><code>historical</code></td> <td><code>historical</code></td>
<td> <td>
True for messages that the user did not receive True for messages that the user did not receive
at the time they were sent but later was added to at the time they were sent but later was added to
the user's history (E.g. because they starred or the user's history (E.g. because they starred or
reacted to a message sent to a public stream reacted to a message sent to a public stream
before they subscribed to that stream). Not before they subscribed to that stream). Cannot be
editable. changed by the user directly.
</td> </td>
</tr> </tr>
</tbody> </tbody>