Skip to content

Commit

Permalink
further explanation of priority messages
Browse files Browse the repository at this point in the history
  • Loading branch information
or-else committed Nov 7, 2019
1 parent af1634e commit eea2f12
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -806,7 +806,7 @@ The following values are currently defined for the `head` field:
* `hashtags`: an array of hashtags in the message without the leading `#` symbol: `["onehash", "twohash"]`.
* `mentions`: an array of user IDs mentioned (`@alice`) in the message: `["usr1XUtEhjv6HND", "usr2il9suCbuko"]`.
* `mime`: MIME-type of the message content, `"text/x-drafty"`; a `null` or a missing value is interpreted as `"text/plain"`.
* `priority`: message display priority: hint for the client that the message should be displayed more or less prominently; only `"high"` is currently defined; `priority` can be set by the topic owner or administrator (`A` permission) only.
* `priority`: message display priority: hint for the client that the message should be displayed more prominently for a set period of time; only `"high"` is currently defined; `{"level": "high", "expires": "2019-10-06T18:07:30.038Z"}`; `priority` can be set by the topic owner or administrator (`A` permission) only. The `"expires"` qualifier is optional.
* `replace`: an indicator that the message is a correction/replacement for another message, a topic-unique ID of the message being updated/replaced, `":123"`
* `reply`: an indicator that the message is a reply to another message, a unique ID of the original message, `"grp1XUtEhjv6HND:123"`.
* `sender`: a user ID of the sender added by the server when the message is sent by on behalf of another user, `"usr1XUtEhjv6HND"`.
Expand Down

0 comments on commit eea2f12

Please sign in to comment.