Unverified Commit 1b154723 authored by Faria Masood's avatar Faria Masood Committed by gitbook-bot
Browse files

GitBook: [master] 672 pages modified

parent 3ba5b90f
# Info
Retrieves information about a user, the result is only limited to what the callee has access to view. It supports [Fields Query Parameter](../../query-and-fields-info.md) with the `userRooms` field, that returns the rooms that the user is part of. The `rooms` field returns the `unread` property and this field is variable, based on the setting `Unread_Count` (`Admin Panel` => `General` => `Unread_Count`), this setting provides the ability to choose between options to count the unread messages.
Retrieves information about a user, the result is only limited to what the callee has access to view. It supports [Fields Query Parameter](../../query-and-fields-info.md) with the `userRooms` field, that returns the rooms that the user is part of. The `rooms` field returns the `unread` property and this field is variable, based on the setting `Unread_Count` \(`Admin Panel` => `General` => `Unread_Count`\), this setting provides the ability to choose between options to count the unread messages.
| URL | Requires Auth | HTTP Method |
| :--- | :--- | :--- |
......@@ -119,7 +119,7 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
| Version | Description |
| :--- | :--- |
| 3.4.0 | Added `unread` property inside `rooms` object |
| 3.4.0 | Added `unread` property inside `rooms` object |
| 0.70.0 | Added `rooms` property to response if the user request it and has the `view-other-user-channels` permission |
| 0.49.0 | Updated to support `userId` or `username` |
| 0.48.0 | Renamed to `users.info` |
......
# Amazon S3
Set set the following _CORS Configuration_ to your bucket.
Set set the following _CORS Configuration_ to your bucket.
XML format (if using the old AWS console Interface):
XML format \(if using the old AWS console Interface\):
```markup
<?xml version="1.0" encoding="UTF-8"?>
......@@ -19,9 +19,9 @@ XML format (if using the old AWS console Interface):
</CORSConfiguration>
```
JSON format (if using the new AWS console Interface):
JSON format \(if using the new AWS console Interface\):
```js
```javascript
[
{
"AllowedHeaders": [
......
# Notifications
Use the **Bell** icon to configure notifications whithin your channel or room. Other preferences are available in the `Personel Settings` dialog. Make sure your preferences include Receiving unread messages to get notifications.
Use the **Bell** icon to configure notifications within your channel or room. Other preferences are available in the`Personel Settings`dialog. Make sure your preferences include Receiving unread messages to get notifications.
## Desktop
......
# Push Notifications
There are two ways to setup push notifications with Rocket.Chat:
There are two ways to set up push notifications with Rocket.Chat:
* Push Gateway
* Self Configured
......@@ -19,15 +19,15 @@ Then also you will need to add your keys to Rocket.Chat.
Then you will have to compile for iOS and Android and submit them to the appropriate app stores for review.
Finally you would direct your users to download your custom version of the Rocket.Chat mobile applications.
Finally, you would direct your users to download your custom version of the Rocket.Chat mobile applications.
### Configuring for Android
The Rocket.Chat native application for Android supports FCM system. Here's how you configure it:
The Rocket.Chat native application for Android supports the FCM system. Here's how you configure it:
1. Create a Firebase project in the Firebase console, if you don't already have one. Click Add project. If you already have an existing Google project associated with your mobile app, select it from the Project name drop down menu. Otherwise, enter a project name to create a new project.
1. Create a Firebase project in the Firebase console, if you don't already have one. Click Add project. If you already have an existing Google project associated with your mobile app, select it from the Project name drop-down menu. Otherwise, enter a project name to create a new project.
2. _Optional:_ Edit your Project ID. Your project is given a unique ID automatically, and it's used in publicly visible Firebase features such as database URLs and your Firebase Hosting subdomain. You can change it now if you want to use a specific subdomain.
3. Follow the remaining setup steps and click Create project \(or Add Firebase if you're using an existing project\) to begin provisioning resources for your project. This typically takes a few minutes. When the process completes, you'll be taken to the project overview.
3. Follow the remaining setup steps and click Create a project \(or Add Firebase if you're using an existing project\) to begin provisioning resources for your project. This typically takes a few minutes. When the process completes, you'll be taken to the project overview.
Now that you have a project, you can add your Android app to it:
......@@ -44,22 +44,22 @@ For iOS you need an apple developer account that costs US$99 per year. Follow in
* Go to "Administration", then "Push"
* Set the Enable Gateway to False, then plug the information obtained from Apple and Google
* Restart server \(with out this it will not work\)
* Restart server \(without this it will not work\)
Now you should be able to Send a test message. Make sure that you have logged in to the server once, and then closed the app. You should see a test notification after you pressed the send button.
Now you should be able to send a test message. Make sure that you have logged in to the server once, and then closed the app. You should see a test notification after you pressed the send button.
## Privacy
Rocket.Chat allows for additional privacy configurations on push notifications:
* Show Channel/Group/Username in Notification: Default is "TRUE", disabling this setting prevents the Channel, Group, Discussion and Username being sent to the push notification gateway
* Show Channel/Group/Username in Notification: Default is "TRUE", disabling this setting prevents the Channel, Group, Discussion, and Username from being sent to the push notification gateway
* Show Message in Notification: Default is "TRUE", disabling this setting prevents the message content from being sent to the push notification gateway
If both settings are set to "FALSE", the user will receive a push notification without contextual information, as no such contextual information is sent to the push notification gateway in the first place. The user can then access the contextual information by opening the Rocket.Chat application. This is helpful in compliance-sensitive requirements like HIPAA to prevent sensitive information being disclosed via push notification.
If both settings are set to "FALSE", the user will receive a push notification without contextual information, as no such contextual information is sent to the push notification gateway in the first place. The user can then access the contextual information by opening the Rocket.Chat application. This is helpful in compliance-sensitive requirements like HIPAA to prevent sensitive information from being disclosed via push notification.
## General Observations
* If you don't want notifications you can just disable gateway and not provide keys.
* If you don't want notifications you can just disable the gateway and not provide keys.
* You cannot compile your own applications and use the Rocket.Chat push gateway.
* For iOS, you need to [convert](https://github.com/raix/push/blob/master/docs/IOS.md) both the .cer and .p12 files into .pem files
* Once everything is configured on the admin settings, the server must be restarted
......
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