Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Expand documentation on using IDs in narrows.

This commit is contained in:
Tim Abbott 2019-08-29 16:15:19 -07:00
parent 8ef610f8c8
commit 73c9450d8a
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
templates/zerver/api/construct-narrow.md
View File

@ -37,9 +37,28 @@ as a list of simple objects, as follows:
```
The full set of search/narrowing options supported by the Zulip API is
documented in
[the Zulip Help Center article on search](/help/search-for-messages).
There are a few additional options that we don't document there
because they are primarily useful to API clients:
documented in [the Zulip Help Center article on
search](/help/search-for-messages). There are a few additional
options, new in Zulip 2.1, that we don't document there because they
are primarily useful to API clients:
* `pm-with:1234`: Search 1-on-1 messages by user ID `1234`.
* `pm-with:1234`: Search 1-on-1 messages between you and user ID `1234`.
* `sender:1234`: Search 1-on-1 messages sent by user ID `1234`.
* `stream:1234`: Search 1-on-1 messages sent to the stream with ID `123`.
* `group-pm-with:1234`: Search private messages including the user with ID `1234`.
For example, to query messages sent by a user 1234 to stream 123, the
correct JSON-encoded query is:
```json
[
{
"operator": "sender",
"operand": 1234
},
{
"operator": "stream",
"operand": 123
}
]
```