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

Document chat.ignoreUser API endpoint #1149

Merged

Conversation

thayannevls
Copy link
Contributor

Add chat.ignoreUser endpoint documentation.

I couldn't find which version this endpoint was added, can someone help me with this?

@@ -166,6 +166,7 @@ When calling a production Rocket.Chat server, ensure it is running via HTTPS and
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](chat/unstarmessage/) |
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](chat/update/) |
| `/api/v1/chat.getMessageReadReceipts` | Retrieves message read receipts. | [Link](chat/getmessagereadreceipts/) |
| `/api/v1/chat.ignoreUser` | Ignores an user from a chat. | [Link](chat/ignoreuser/) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thayannevls can you please put this in alphabetic order? Also if you can put the getMessageReadReceipts in order, because it is unordered too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thayannevls I think that here, you forgot to put in alphabetic order 😶

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh sorry 😅 now is fixed

| :--- | :--- | :--- | :--- |
| `rid` | `KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF` | Required | The room ID. |
| `userId` | `7aDSXtjMA3KPLxLjt` | Required | The User ID. |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that is missing the ignore query parameter, as we can see here.

-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type:application/json" \
http://localhost:3000/api/v1/chat.ignoreUser?rid=KLTM332QEwWLPJrjRPtcPHimPnLHsusiDF&userId=7aDSXtjMA3KPLxLjt
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, if you can create an example with ignore parameter, it would be good. 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did it! Can you verify if it's correct now?


| Version | Description |
| :--- | :--- |
| | Added |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version that it has been add is 0.64.0, as we can see here.

@MarcosSpessatto MarcosSpessatto merged commit b6dcb80 into RocketChat:master Mar 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants