Skip to content
This repository was archived by the owner on Mar 17, 2023. It is now read-only.

Docs for new chat.getSnippetedMessages endpoint #1485

Merged
sampaiodiego merged 4 commits into from
Dec 20, 2019
Merged

Docs for new chat.getSnippetedMessages endpoint #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bb384d4
Docs for new chat.getSnippetedMessages endpoint
Oct 26, 2019
34b45af
Merge branch 'master' into chat-snippeted-messages
Nov 26, 2019
3738f09
Merge branch 'master' into chat-snippeted-messages
sampaiodiego Dec 20, 2019
16a81d8
Merge branch 'master' into chat-snippeted-messages
sampaiodiego Dec 20, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _data/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,7 @@
- getMessage
- getMessageReadReceipts
- getPinnedMessages
- getSnippetedMessages
- getSnippetedMessageById
- getStarredMessages
- getThreadMessages
Expand Down
1 change: 1 addition & 0 deletions contributing/documentation/documentation-map/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@ Here you can also find what articles are incomplete and missing.
- getMessage
- getMessageReadReceipts
- getPinnedMessages
- getSnippetedMessages
- getSnippetedMessageById
- getStarredMessages
- getThreadMessages
Expand Down
1 change: 1 addition & 0 deletions developer-guides/rest-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](chat/getmessage/) |
| `/api/v1/chat.getMessageReadReceipts` | Retrieves message read receipts. | [Link](chat/getmessagereadreceipts/) |
| `/api/v1/chat.getPinnedMessages` | Retrieve pinned messages from a room. | [Link](chat/getpinnedmessages/) |
| `/api/v1/chat.getSnippetedMessages` | Retrieves snippeted messages. | [Link](chat/getsnippetedmessages/) |
| `/api/v1/chat.getSnippetedMessageById`| Retrieves snippeted message by id. | [Link](chat/getsnippetedmessagebyid/) |
| `/api/v1/chat.getStarredMessages` | Retrieves starred messages. | [Link](chat/getstarredmessages/) |
| `/api/v1/chat.getThreadMessages` | Retrieves thread's messages. | [Link](chat/getthreadmessages/) |
Expand Down
1 change: 1 addition & 0 deletions developer-guides/rest-api/chat/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](getmessage/) |
| `/api/v1/chat.getMessageReadReceipts` | Retrieves message read receipts. | [Link](getmessagereadreceipts/) |
| `/api/v1/chat.getPinnedMessages` | Retrieve pinned messages from a room. | [Link](getpinnedmessages/) |
| `/api/v1/chat.getSnippetedMessages` | Retrieves snippeted messages. | [Link](getsnippetedmessages/) |
| `/api/v1/chat.getSnippetedMessageById`| Retrieves snippeted message by id. | [Link](getsnippetedmessagebyid/) |
| `/api/v1/chat.getStarredMessages` | Retrieves the starred messages. | [Link](getstarredmessages/) |
| `/api/v1/chat.getThreadMessages`| Retrieves thread's messages. | [Link](getthreadmessages/) |
Expand Down
60 changes: 60 additions & 0 deletions developer-guides/rest-api/chat/getsnippetedmessages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Get Snippeted Messages

Retrieve snippeted messages. It supports the [Offset, Count, and Sort Query Parameters](../../offset-and-count-and-sort-info/).

| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
| `/api/v1/chat.getSnippetedMessages` | `yes` | `GET` |

## Query Parameters

| Argument | Example | Required | Description |
| :--- | :--- | :--- | :--- |
| `roomId` | `ByehQjC44FwMeiLbX` | Required | The room id |

## Example Call

```bash
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/chat.getSnippetedMessages?roomId=ByehQjC44FwMeiLbX
```

## Example Result

```json
{
"messages": [
{
"_id": "QQuPFFcLmsqHWeqhn",
"rid": "GENERAL",
"msg": "``````\ntest\n``````",
"ts": "2019-10-25T21:42:39.022Z",
"u": {
"_id": "CaevAPDbXN252kyXa",
"username": "marcos.defendi",
"name": "Marcos Defendi"
},
"_updatedAt": "2019-10-25T22:54:02.094Z",
"mentions": [],
"channels": [],
"snippetName": "ee",
"snippeted": true,
"snippetedBy": {
"_id": "CaevAPDbXN252kyXa",
"username": "marcos.defendi"
}
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}
```

## Change Log

| Version | Description |
| :---- | :---- |
| 2.3.0 | Added |