This repository has been archived by the owner on Mar 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 763
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
160 changed files
with
267 additions
and
707 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 4 | ||
--- | ||
|
||
# Rocket.Chat Code Styleguide | ||
|
||
- [Less Code Styleguide](less.md) | ||
- [Less Code Styleguide](less/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,10 @@ | ||
--- | ||
order: 9 | ||
--- | ||
|
||
# Iframe Integration | ||
|
||
## Use your own login page to login users in Rocket.Chat | ||
If you want to authenticate users using the iframe integration, go to `Adminstration > Accounts > Iframe` and enable it: | ||
- [How to use iframe integration for authentication](Authentication) | ||
If you want to authenticate users using the iframe integration, go to `Adminstration > Accounts > Iframe` and enable it: | ||
- [How to use iframe integration for authentication](Authentication/) | ||
|
||
## Use Rocket.Chat in your site/app inside an iframe | ||
If you need listen to events, go to `Administration > General > Iframe Integration` and enable send (events) or receive (commands), depending on your needs: | ||
- [How to use iframe integration events](Events) | ||
- [How to use iframe integration commands](Commands) | ||
- [How to use iframe integration events](Events/) | ||
- [How to use iframe integration commands](Commands/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1 @@ | ||
--- | ||
order: 7 | ||
--- | ||
|
||
# Internationalization (i18n) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 5 | ||
--- | ||
|
||
# Livechat API | ||
|
||
## Usage | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 8 | ||
--- | ||
|
||
# Building Rocket.Chat for mobile apps | ||
|
||
## Android | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,6 @@ | ||
--- | ||
order: 2 | ||
--- | ||
|
||
# Logout | ||
|
||
## See Also | ||
* [Login][1] | ||
|
||
[1]:../login | ||
[1]:../login/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,12 @@ | ||
--- | ||
order: 50 | ||
--- | ||
|
||
# Chat Methods | ||
| Url | Short Description | Details Page | | ||
| :--- | :--- | :--- | | ||
| `/api/v1/chat.delete` | Deletes an existing chat message. | [Link](delete.md) | | ||
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](getMessage.md) | | ||
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](pinMessage.md) | | ||
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](postMessage.md) | | ||
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](react.md) | | ||
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](starMessage.md) | | ||
| `/api/v1/chat.unPinMessage` | Removes the pinned status of the provided chat message. | [Link](unPinMessage.md) | | ||
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](unStarMessage.md) | | ||
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](update.md) | | ||
| `/api/v1/chat.delete` | Deletes an existing chat message. | [Link](delete/) | | ||
| `/api/v1/chat.getMessage` | Retrieves a single chat message. | [Link](getMessage/) | | ||
| `/api/v1/chat.pinMessage` | Pins a chat message to the message's channel. | [Link](pinMessage/) | | ||
| `/api/v1/chat.postMessage` | Posts a new chat message. | [Link](postMessage/) | | ||
| `/api/v1/chat.react` | Sets/unsets the user's reaction to an existing chat message. | [Link](react/) | | ||
| `/api/v1/chat.starMessage` | Stars a chat message for the authenticated user. | [Link](starMessage/) | | ||
| `/api/v1/chat.unPinMessage` | Removes the pinned status of the provided chat message. | [Link](unPinMessage/) | | ||
| `/api/v1/chat.unStarMessage` | Removes the star on the chat message for the authenticated user. | [Link](unStarMessage/) | | ||
| `/api/v1/chat.update` | Updates the text of the chat message. | [Link](update/) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 10 | ||
--- | ||
|
||
# Chat Message Delete | ||
| URL | Requires Auth | HTTP Method | | ||
| :--- | :--- | :--- | :--- | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 40 | ||
--- | ||
|
||
# Pins a Chat Message | ||
Pins a chat message to the message's channel. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 60 | ||
--- | ||
|
||
# Chat Message Reactions | ||
Toggles the authenciated user's reaction to the provided message. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 70 | ||
--- | ||
|
||
# Star a Chat Message | ||
Stars a chat message for the authenticated user. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 80 | ||
--- | ||
|
||
# Unpins a Chat Message | ||
Removes the pinned status of the provided chat message. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 85 | ||
--- | ||
|
||
# Unpins a Chat Message | ||
Removes the star on the chat message for the authenticated user. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 100 | ||
--- | ||
|
||
# Chat Message Update | ||
| URL | Requires Auth | HTTP Method | | ||
| :--- | :--- | :--- | :--- | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,26 @@ | ||
--- | ||
order: 40 | ||
--- | ||
|
||
# Group Methods | ||
| Url | Short Description | Details Page | | ||
| :--- | :--- | :--- | | ||
| `/api/v1/groups.addAll` | Adds all of the users on the server to a private group. | [Link](addAll.md) | | ||
| `/api/v1/groups.addModerator` | Gives the role of moderator to a user in a group. | [Link](addModerator.md) | | ||
| `/api/v1/groups.addOwner` | Gives the role of owner to a user in a group. | [Link](addOwner.md) | | ||
| `/api/v1/groups.archive` | Archives a private group. | [Link](archive.md) | | ||
| `/api/v1/groups.close` | Removes a private group from the list of groups. | [Link](close.md) | | ||
| `/api/v1/groups.create` | Creates a new private group. | [Link](create.md) | | ||
| `/api/v1/groups.getIntegrations` | Gets the integrations assigned to the group. | [Link](getIntegrations.md) | | ||
| `/api/v1/groups.history` | Retrieves the messages from a private group. | [Link](history.md) | | ||
| `/api/v1/groups.info` | Gets the information about a private group. | [Link](info.md) | | ||
| `/api/v1/groups.invite` | Adds a user to the private group. | [Link](invite.md) | | ||
| `/api/v1/groups.kick` | Removes a user from a private group. | [Link](kick.md) | | ||
| `/api/v1/groups.leave` | Removes the calling user from the private group. | [Link](leave.md) | | ||
| `/api/v1/groups.list` | List the private groups the caller is part of. | [Link](list.md) | | ||
| `/api/v1/groups.open` | Adds the private group back to the list of groups. | [Link](open.md) | | ||
| `/api/v1/groups.removeModerator` | Removes the role of moderator from a user in a group. | [Link](removeModerator.md) | | ||
| `/api/v1/groups.removeOwner` | Removes the role of owner from a user in a group. | [Link](removeOwner.md) | | ||
| `/api/v1/groups.rename` | Changes the name of the private group. | [Link](rename.md) | | ||
| `/api/v1/groups.setDescription` | Sets a private group's description. | [Link](setDescription.md) | | ||
| `/api/v1/groups.setPurpose` | Sets a private group's description. | [Link](setPurpose.md) | | ||
| `/api/v1/groups.setReadOnly` | Sets whether the room is read only or not. | [Link](setReadOnly.md) | | ||
| `/api/v1/groups.setTopic` | Sets a private group's topic. | [Link](setTopic.md) | | ||
| `/api/v1/groups.setType` | Sets the type of room this group will be. | [Link](setType.md) | | ||
| `/api/v1/groups.unarchive` | Unarchives a private group. | [Link](unarchive.md) | | ||
| `/api/v1/groups.addAll` | Adds all of the users on the server to a private group. | [Link](addAll/) | | ||
| `/api/v1/groups.addModerator` | Gives the role of moderator to a user in a group. | [Link](addModerator/) | | ||
| `/api/v1/groups.addOwner` | Gives the role of owner to a user in a group. | [Link](addOwner/) | | ||
| `/api/v1/groups.archive` | Archives a private group. | [Link](archive/) | | ||
| `/api/v1/groups.close` | Removes a private group from the list of groups. | [Link](close/) | | ||
| `/api/v1/groups.create` | Creates a new private group. | [Link](create/) | | ||
| `/api/v1/groups.getIntegrations` | Gets the integrations assigned to the group. | [Link](getIntegrations/) | | ||
| `/api/v1/groups.history` | Retrieves the messages from a private group. | [Link](history/) | | ||
| `/api/v1/groups.info` | Gets the information about a private group. | [Link](info/) | | ||
| `/api/v1/groups.invite` | Adds a user to the private group. | [Link](invite/) | | ||
| `/api/v1/groups.kick` | Removes a user from a private group. | [Link](kick/) | | ||
| `/api/v1/groups.leave` | Removes the calling user from the private group. | [Link](leave/) | | ||
| `/api/v1/groups.list` | List the private groups the caller is part of. | [Link](list/) | | ||
| `/api/v1/groups.open` | Adds the private group back to the list of groups. | [Link](open/) | | ||
| `/api/v1/groups.removeModerator` | Removes the role of moderator from a user in a group. | [Link](removeModerator/) | | ||
| `/api/v1/groups.removeOwner` | Removes the role of owner from a user in a group. | [Link](removeOwner/) | | ||
| `/api/v1/groups.rename` | Changes the name of the private group. | [Link](rename/) | | ||
| `/api/v1/groups.setDescription` | Sets a private group's description. | [Link](setDescription/) | | ||
| `/api/v1/groups.setPurpose` | Sets a private group's description. | [Link](setPurpose/) | | ||
| `/api/v1/groups.setReadOnly` | Sets whether the room is read only or not. | [Link](setReadOnly/) | | ||
| `/api/v1/groups.setTopic` | Sets a private group's topic. | [Link](setTopic/) | | ||
| `/api/v1/groups.setType` | Sets the type of room this group will be. | [Link](setType/) | | ||
| `/api/v1/groups.unarchive` | Unarchives a private group. | [Link](unarchive/) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 1 | ||
--- | ||
|
||
# Group Add All | ||
Adds all of the users of the Rocket.Chat server to the group. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 3 | ||
--- | ||
|
||
# Group Add Moderator | ||
Gives the role of moderator for a user in the currrent group. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 4 | ||
--- | ||
|
||
# Group Add Owner | ||
Gives the role of owner for a user in the currrent group. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 30 | ||
--- | ||
|
||
# Group Invite | ||
Adds a user to the private group. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 35 | ||
--- | ||
|
||
# Group Kick | ||
Removes a user from the private group. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
order: 50 | ||
--- | ||
|
||
# Group Open | ||
Adds the private group back to the user's list of private groups. | ||
|
||
|
Oops, something went wrong.