Unverified Commit 7fcfdc37 authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot
Browse files

GitBook: [master] 681 pages modified

parent adb5bb69
......@@ -78,10 +78,10 @@
* [Channels](guides/user-guides/channels/README.md)
* [Channel Actions](guides/user-guides/channels/channel-actions.md)
* [Multi-users Direct Message](guides/user-guides/direct-messages-between-multiple-users.md)
* [Messages](guides/user-guides/messaging/README.md)
* [Message Actions](guides/user-guides/messaging/message-actions.md)
* [Off-the-record \(OTR\) Messaging Guide](guides/user-guides/messaging/off-the-record-otr-messaging-guide.md)
* [End to End Encryption Guide](guides/user-guides/end-to-end-encryption.md)
* [Message Actions](guides/user-guides/message-actions.md)
* [Messages](guides/user-guides/messaging.md)
* [Off-the-record \(OTR\) Messaging Guide](guides/user-guides/off-the-record-otr-messaging-guide.md)
* [Registering an account](guides/user-guides/registration.md)
* [Talking to users from another server](guides/user-guides/talking-to-users-from-another-server.md)
* [Voice and Video Conferencing](guides/user-guides/voice-and-video-conferencing.md)
......
......@@ -54,5 +54,5 @@ The response of a message being pinned is a new chat message which contains the
## See Also
* [The Message Object](../../schema-definition/the-message-object.md)
* [Pinning Messages User Guide](../../../guides/user-guides/messaging.md)
* [Pinning Messages User Guide](../../../guides/user-guides/messaging/)
......@@ -36,5 +36,5 @@ Setting and removing a reaction requires a call to the same method with the same
## See Also
* [Reacting to Messages User Guide](../../../guides/user-guides/messaging.md)
* [Reacting to Messages User Guide](../../../guides/user-guides/messaging/)
......@@ -37,5 +37,5 @@ The only parameter that needs to be passed in is an object with the `_id`, `rid`
## See Also:
* [Starring Messages User Guide](../../../guides/user-guides/messaging.md)
* [Starring Messages User Guide](../../../guides/user-guides/messaging/)
......@@ -10,7 +10,7 @@ Unpinning a message allows administrators and owners of rooms to remove pinned i
## Example Call
The only parameter that needs to be passed in is the [Message Object](../../../guides/user-guides/messaging.md) and as of release `0.46` you need to send the entire message object otherwise an internal error will happen \([fixed via pull request \#5087](https://github.com/RocketChat/Rocket.Chat/pull/5087)\).
The only parameter that needs to be passed in is the [Message Object](../../../guides/user-guides/messaging/) and as of release `0.46` you need to send the entire message object otherwise an internal error will happen \([fixed via pull request \#5087](https://github.com/RocketChat/Rocket.Chat/pull/5087)\).
```javascript
{
......@@ -23,7 +23,7 @@ The only parameter that needs to be passed in is the [Message Object](../../../g
## Example Response
The response of a message being pinned is a new chat message which contains the broadcast of the message pinning. See [Message Object Details](../../../guides/user-guides/messaging.md) for information about the response format.
The response of a message being pinned is a new chat message which contains the broadcast of the message pinning. See [Message Object Details](../../../guides/user-guides/messaging/) for information about the response format.
```javascript
{
......@@ -53,5 +53,5 @@ The response of a message being pinned is a new chat message which contains the
## See Also
* [Pinning Messages User Guide](../../../guides/user-guides/messaging.md)
* [Pinning Messages User Guide](../../../guides/user-guides/messaging/)
......@@ -20,22 +20,22 @@ Favoriting a channel moves it to a **Favorites** section on the channels list, m
Here you can see all kinds of information about the current channel. If you admin permissions, you can edit this information. These are the channel info options:
* **Channel Name**: The name of the channel, how users see the title and find the channel via search.
* **Channel Name**: The channel's name, how users see the title and find the channel via search.
* **Topic**: The topic shows next to the title on the channel header. Great for giving more info about the channel.
* **Announcement**: Announcements post in a bar under the channel header.
* **Description**: The description of the channel.
* **Private**: Tells whether a channel is private, and can set the channel to private or public.
* **Read Only**: Tells whether a channel is read-only, and toggles the read-only status on the channel. In read-only channels, only people with admin permissions can post messages. Good for announcements channels.
* **Archived**: Tells if a channel is archived, and toggles the archived status of a channel. Nobody can post messages in an archived channel, and channel search will not find that channel.
* **Password**: Tells whether a channel has a password and let you set the password. If a channel has a password, other users need to enter the password to become a member of the channel.
* **Private**: Tells whether a channel is private and can set the channel to private or public.
* **Read Only**: Tells whether a channel is read-only and toggles the read-only status on the channel. In read-only channels, only people with admin permissions can post messages. Good for announcements channels.
* **Archived**: Tells if a channel is archived and toggles the archived status of a channel. Nobody can post messages in an archived channel, and channel search will not find that channel.
* **Password**: Tells whether a channel has a password and let you set the password. If a channel has a password, other users need to enter the password to become a channel's member.
If a [retention policy](../../administrator-guides/retention-policies.md) is active on this channel, a red warning box appears saying when messages or files are deleted.
If a [retention policy](../../administrator-guides/retention-policies.md) is active on this channel, a red warning box appears stating when messages or files are deleted.
## Search Messages
Rocket.Chat search supports basic search commands which work like Gmail search.
Rocket.Chat also supports the use of "[regular expressions](https://en.wikipedia.org/wiki/Regular_expression)." Regular expressions provide flexibility and the ability to search chat entries in any language, even ones which are traditionally a challenge like "CJK" languages \(Chinese, Japanese, Korean\).
Rocket.Chat also supports the use of "[regular expressions](https://en.wikipedia.org/wiki/Regular_expression)." Regular expressions provide flexibility to search chat entries in any language, even the ones traditionally a challenge like "CJK" languages \(Chinese, Japanese, Korean\).
### Basic Search Commands
......@@ -47,7 +47,7 @@ You can use these commands before or after entering search terms:
* `is:pinned` or `has:pin` returns messages that pin in the current channel.
* `has:url` or `has:link` returns messages that contain a link.
* `has:location` or `has:map` returns messages that have a location attached.
* `before:dd/mm/yyyy`, `after:dd/mm/yyyy` and `on:dd/mm/yyyy` return message that were created before, after, or on the provided date.
* `before:dd/mm/yyyy`, `after:dd/mm/yyyy` and `on:dd/mm/yyyy` return message that was created before, after, or on the provided date.
Dashes `dd-mm-yyyy` or dots `dd.mm.yyyy` can be used instead of slashes. `order:asc`, `order:ascend`, or `order:ascending` sorts messages by ascending timestamp.
......@@ -93,7 +93,7 @@ These options are on the channel notifications tab:
* **Mobile**: Controls push notification behavior when using any mobile app.
* **Email**: Set whether an email sends whenever someone mentions you or posts a message, or disable email notifications.
* **Unread Room Status**: Control whether the channel on the channel list highlights when there is a new message or mention.
* **Unread Tray Icon**: Controls whether the tray icon highlights when there are new messages or mentions on the current channel.
* **Unread Tray Icon**: Controls whether the tray icon highlights new messages or mentions on the current channel.
## Message list options
......@@ -102,7 +102,7 @@ This section details a list of all different types of lists specific to channels
* **Files List**: A list of all the files uploaded to the current channel.
* **Mentions**: All messages that mentioned you on the current channel.
* **Starred Messages**: All messages that you have starred in the current channel.
* **Pinned Messages**: All messages pinned to the current channel.
* **Pinned Messages**: All messages are pinned to the current channel.
## Streaming
......@@ -112,16 +112,16 @@ Through the **Streaming** tab, owners of the channel of server admins can start
### Start a stream
_Note: Depending on the settings of the server, you might be only able to link live streams from Youtube. In doubt always ask your server's admin._
_Note: Depending on the settings of the server, you might be only able to link live streams from Youtube. In doubt ,always ask your server's admin._
1. Press the **Broadcast my Camera** button.
2. Login with a Google account. Remember that streaming must be activated through your Youtube account. For more information, see [Introduction to live streaming](https://support.google.com/youtube/answer/2474026?hl=en) Google guide\).
To add a different Livestream, get the URL \(must be from Youtube\) for the stream, enter it into the **Livestream source** field and hit save.
To add a different Livestream, get the URL \(must be from Youtube\) for the stream, enter it into the **Livestream source** field, and hit save.
You can also add a message for whenever the stream is unavailable in the **Livestream not available message** field.
You can also add a message whenever the stream is unavailable in the **Livestream not available message** field.
To add a stream with no video and only audio, use the **Enable audio only button**.
To add a stream with no video and only audio, use the **Enable audio-only button**.
### \(Users\) Start a Live Stream
......
# Messages
This page explains the ins and outs of messaging in Rocket.Chat.
## Compose messages
To compose a message in Rocket.Chat, go the channel or user you want to send a message. Type the message box and press Enter or the **Send** Button.
If you want to add new lines of text, press Shift + Enter to add a new line.
## Cursor movement
While writing or editing messages, you can move the cursor using the arrow keys. Where the cursor moves depends on the wrapping of the text.
Hold `Alt` or `Command` while pressing the right or left arrow keys to move the cursor to the beginning or end of the message.
## Notify other team members
To get the attention of a specific team member in a channel, type `@` followed by their username, for example, `@username`. The mentioned user sees a red badge on the channel or is notified via email or their mobile device if they're not online.
You can also notify everyone in a channel by typing `@all`. We recommend using `@all` sparingly. Although notifying everyone in the channel is useful for announcements, not every message requires this.
## Send attachments
You can send a variety of attachments on your messages, like files, audio, links, videos, and many more.
To access the attachment menu you can, click on the **plus** \(+\) icon on the message input.
### Files
You can select files using three methods:
* By choosing the **Select Files from Computer** option from the attachment menu
* By dragging and dropping the file on Rocket.Chat
* By pasting an image from the clipboard
After selecting the file, add a name and a description of the file and press **Send**.
_Remember that the server administrator can block certain file types from being uploaded._
### Audio
When using Rocket.Chat through a web browser give Rocket.Chat permission to use your microphone.
To start recording, click on the **Create new Audio Message** or the option in the attachment menu or the microphone inside the message box. To stop recording, click the green checkmark. The audio message automatically sends. You can choose to play or download the message.
### Video
When using Rocket.Chat through a web browser give Rocket.Chat permission to use your webcam.
To start recording, click on the **Create new Video Message** option in the attachment menu, then click the red circle icon.
While recording, a stop button appears. To end the recording, press **Stop**.
Preview the video you recorded by pressing **Ok**. A window appears where you can watch, download, and name the video. To send the video, click **Send** or click **Cancel** to discard the video.
## Interacting with Google Drive
_Note:_ Google Drive features available only if the server's admin has enabled Google Drive access and provided the correct API keys. For instructions to obtain these keys can see the [Administrator guides](../../administrator-guides/).
### From Google Drive to Rocket.Chat
Files can be uploaded from Google Drive to a room by selecting the **Select Files from Google Drive** option on the attachment menu. This opens a Google Drive file picker GUI with search and view modes. Select the required file, enter a title and description, and then click **Upload**.
Files upload in the same format to Rocket.Chat as they are in Google Drive with exception to Google docs, slides and sheets which convert to pdfs upon upload.
### From Rocket.Chat to Google Drive
Files uploaded as a message attached to a room can be uploaded to Google Drive. Click **Save to Google Drive** above the file attachment. The file saves to Google Drive in its original format.
### Create Google Docs, Slides and Sheets
Create Google docs, slides, and sheets by clicking to corresponding file type in the attachments menu. The file saves to that user's Google Drive account and posts on the message or channel from which creation occurs. The sharing setting for the file shall remain default. It can be changed by the file owner via the link to collaborate with other users.
## Links
URLs to other sites automatically generate a preview of that site's content. Copy and paste the link into the message box to create the preview.
## Location
To share your location, click **Share My Location**. A message generates a link to a Google Map of your location.
## Emoji
To insert an emoji, click the **smiley face icon** in the message box. Browse through emoji using the icon categories or through the search box.
You can also insert emojis by inputting an [emoji code](https://www.webfx.com/tools/emoji-cheat-sheet/).
### Emoticons
Rocket.Chat changes common emoticons, or symbols used to represent emoji, to the equivalent emoji. For example, `:)` converts to the `:smiley:` emoji.
### Disabling emojis
Emojis can be enabled/disabled in [Your Account](../user-panel/managing-your-account.md) settings under the **Messages** section.
When graphical emojis are disabled, emoji keywords and shortcuts display as regular text.
## Formatting
Use the following symbols to format text as desired:
* Bold: `*Lorem ipsum dolor*`
* Italic: `_Lorem ipsum dolor_`
* Strike: `~Lorem ipsum dolor~`
* Inline code: `Lorem ipsum dolor`
* Image: `![Alt text](https://rocket.chat/favicon.ico)`
* Link: `[Lorem ipsum dolor](https://www.rocket.chat/)` or `<https://www.rocket.chat/ |Lorem ipsum dolor>`
# Message Actions
Message actions allow you to interact with messages that you've already posted.
## Open message actions
To open the message actions menu, place your mouse over the message and click the **actions menu** on the left.
## Edit messages
To edit a message, click on the **edit** option on the message actions menu. You can also place your cursor in the message box and press the **Up arrow** to edit your last message.
_The administrator of the Rocket.Chat server sets the permissions for who can edit messages from other users. By default, only administrators, moderators, and owners of the channels can edit messages from other users._
## Draft messages
Rocket.Chat saves drafts of all message edits so you can return to edit later. When drafting a message, press **Escape** to discard the draft.
## Delete messages
To delete a message, click **Delete** in the message actions menu.
## Star messages
Star messages to make the message easier to find it later. To star a message, click **Star** option in the message actions menu. If you want to remove the star from an already starred message, click **Remove Star**.
Find starred messages by going to the channel actions menu and clicking **Starred Messages**.
Starred messages are per chat room and are not global; each room has its list of starred messages.
## Pin messages
Pin a message to a channel to make that message easily accessible to all users on the channel. To pin a message, select the **Pin Message** option in the message actions menu. Remove already pinned messages by selecting **Remove Pin**.
_The administrator of a Rocket.Chat team sets the permissions for who can pin messages in a channel. By default, only administrators, moderators, and owners of the channel can pin messages._
## Reactions
You can react to messages with emoji.
To add a reaction to a message, go to the message, click on the **smiley face icon** on the right of the message and then choose an emoji.
You can see other users’ emoji reactions beneath the message. To react with the same emoji as another user, click the emoji. You can also remove your reaction by clicking on your emoji.
## Permalink a message
Permalink a message to creates a URL directly to that message in the chat.
Click on the **Permalink** option in the message actions menu. This copies the message into your clipboard.
## Copy a message
To copy the contents of a message to your clipboard, click on the `copy` option on the message actions menu.
## Reply to a message
Reply to a message to quote a message from another user. The reply automatically triggers a notification sent to the message's original author.
There are two options for replies:
Use **Reply in Thread** to start a new thread underneath the original message. Threads create a string of messages that quote the original. Use **Reply in Direct Message** to quote the original message in a direct message to that user.
## Quote a message
Quote a message to respond to another user's message without notifying the user directly. Select **Quote** in the message actions menu.
# Off-the-record \(OTR\) Messaging Guide
{% hint style="info" %}
This feature is currently in beta. Search operations will not find encrypted messages of encrypted rooms. The mobile apps and multi-DMs may not support the encrypted messages \(currently under implementation\). File Uploads will not be encrypted in this version.
{% endhint %}
Off-the-record \(OTR\) Messaging is a feature that allows users to exchange **temporary, encrypted messages directly between each other**. This happens by using the local**,** non-persistent session storage of their browser rather than storing messages on the Rocket.Chat server. After an OTR session ends and the session storage is cleared, the OTR messages are removed and can no longer be restored.
{% hint style="success" %}
OTR messages can help exchange confidential information between users without creating a record of this exchange on the server.
{% endhint %}
{% hint style="info" %}
In contrast to OTR, _end-to-end encrypted messages_ have a record on the server \(in the form of the encrypted message string\) and are persistent.
{% endhint %}
## Getting started
Prerequisites for using OTR are:
* OTR has been enabled by your server administrator \(if not, you will not be able to see OTR in the DM context menu\)
* a direct message \(DM\) room with only one other participant
* you and your DM-partner have entered their [end-to-end encryption key](https://docs.rocket.chat/guides/user-guides/end-to-end-encryption)
* you and your DM-partner are both online
## Starting an OTR conversation
_See the following steps with the sample users A and B._
_User A:_ Start the OTR conversation by clicking the DM context menu and selecting **OTR**. This will open the OTR-sidebar.
![Selecting OTR-Panel](../../../.gitbook/assets/image%20%2895%29.png)
**User A:** Start OTR.
![Starting OTR-Chat](../../../.gitbook/assets/image%20%28115%29.png)
_User B:_ Accept the OTR invitation.
![Accepting the invitation](../../../.gitbook/assets/image%20%28129%29.png)
The following messages will be subject to the OTR session and be marked by a key-icon. Unlike end-to-end encryption, this key icon is **bold**.
![OTR messages visual display](../../../.gitbook/assets/image%20%2835%29.png)
If User A or B breaks OTR \(by clearing their local session storage, e.g., refreshing the web client\), one of them needs to re-initiate the OTR session by clicking **Refresh Keys**.
![Options during OTR conversation](../../../.gitbook/assets/image%20%28176%29.png)
## Ending an OTR conversation
In case User A or B wants to end the OTR session, one needs to click "End OTR". This ends the OTR session. The following messages will follow the normal configuration of the DM and be recorded on the server again. Refreshing his local session storage will make all **OTR messages disappear for the user.**
![Ending OTR conversations](../../../.gitbook/assets/image%20%2847%29.png)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment