Skip to content

Commit

Permalink
update notification checklist
Browse files Browse the repository at this point in the history
Signed-off-by: Marcel Hibbe <[email protected]>
  • Loading branch information
mahibi committed Dec 12, 2024
1 parent a2028d1 commit a29e210
Show file tree
Hide file tree
Showing 13 changed files with 62 additions and 25 deletions.
Binary file added docs/grantNotificationPermissionAfterInstall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/grantNotificationPermissionAfterInstall.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later
Binary file added docs/ignoreBatteryOptimizationDialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/ignoreBatteryOptimizationDialog.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later
Binary file added docs/ignoreBatteryOptimizationSelectAllApps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/ignoreBatteryOptimizationSelectAllApps.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later
Binary file added docs/ignoreBatteryOptimizationTurnOffSwitch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/ignoreBatteryOptimizationTurnOffSwitch.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later
Binary file added docs/notificationSettingsExample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/notificationSettingsExample.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later
75 changes: 50 additions & 25 deletions docs/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ not be complete. Please contribute to this list as you gain new knowledge. Just
"notification" label or create a pull request for this document.

## 📱 Users
- Please make sure to install the app from the Google PlayStore. The f-droid version doesn't support push notifications.
- Please make sure to install the app from the Google PlayStore. **The f-droid version doesn't support push
notifications.**

[<img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png"
alt="Download from Google Play"
Expand All @@ -26,53 +27,77 @@ If your problem still occurs after checking all these hints, create an issue at

### 🤖 Check android settings

Please check the "Notifications" section in the app settings which should show warnings if anything needs to be
adjusted.
Please take into account that the android settings might be different for each manufacturer.
It might be worth it to check what other messaging apps recommend to get their apps running on a certain smartphone and adapt this to the talk app.
Also [https://dontkillmyapp.com/](https://dontkillmyapp.com/) might be good starting point.
First of all, please make sure that the following requirements are met:

- Check that your phone has internet access

- Check that your phone is not in "do not disturb" mode

- Check that your phone has internet access
#### Grant permissions on install

After the installation of Nextcloud Talk Android, dialogs appear asking you to grant the permissions.
Please note that the dialogs only appear once to respect the first decision of the users.
Depending on the Android version, only the dialogs appear that are necessary.

##### Grant notification permission

A dialog to enable notification permissions after install will only be shown for Android 13 and upwards. For older
Android versions notifications have to be enabled in the AppInfo settings.

- Check the android settings like **"energy saving"** and **"notifications"** regularly as they might be reset by
android at any time!
![Grant notification permission after install](/docs/grantNotificationPermissionAfterInstall.png "Grant notification permission after install")

- Energy saving options example for Xiaomi RedMi:
##### Ignore battery optimization

- go to "Settings"
For some smartphone models, ignoring battery optimization is not necessary while for others it is. If you absolutely want to be sure notifications are received, turning it off is highly recommended.

- "Battery & performance"
![Ignore battery optimization dialog](/docs/ignoreBatteryOptimizationDialog.png "Ignore battery optimization dialog")

- "App battery saver"
Please follow the description to turn off battery optimization for the Talk app. In the available apps you can use the search so you don't have to scroll through the whole app list.

- tap on the Talk app
![Ignore battery optimization - select all apps](/docs/ignoreBatteryOptimizationSelectAllApps.png "Ignore battery optimization - select all apps")

- set "No restrictions"
Please note that the switch has to be *turned off*.

- Notification options example for Xiaomi RedMi:
![Ignore battery optimization - turn off switch](/docs/ignoreBatteryOptimizationTurnOffSwitch.png "Ignore battery optimization - turn off switch")

- go to "Settings"
#### Grant permissions in settings

- "Notifications"
##### Regular warning

- tap on the Talk app
If notifications settings are not set up correctly, there will be a warning in the conversation list. This is displayed regularly unless it is changed in the settings so that you are not reminded of incorrect settings.
If you select "Not now", the warning will be shown again after a few days if the settings are still wrong. When
selecting "Settings", the settings screen will appear. All incorrect settings will blink and their description is in
red color.

- enable "Show notifications" and if you like
enable "Lock screen notifications"
##### Notification settings

### 🗨️ Check talk app settings
- In the settings, check if ringtones are set for calls and notifications and if vibration is activated if you would
like so.
The notification settings can either be reached when selecting "Settings" in the regular notification warning or by
clicking on the user avatar in the right corner of the conversation list and by selecting "Settings".

In the "Notifications" section, please change every setting that is marked with a red color.
Please take into account that the android settings might look different for each manufacturer.
You can also reach these settings by long pressing on the Nextcloud Android Talk App in Android itself and by selecting
"App info".

![Warning that notifications are not set up correctly](/docs/notificationsNotSetUpCorrectlyWarning.png "Warning that notifications are not set up correctly")

![Notification settings](/docs/notificationSettingsExample.png "Notification settings")

##### Further help for permission settings

If setting the above listed permission won't help, it might be that there are special settings for your phone. It
might be worth it to check what other messaging apps recommend to get their apps running on a certain smartphone and adapt this to the talk app.
Also [https://dontkillmyapp.com/](https://dontkillmyapp.com/) might be good starting point.

### 🗨️ Check conversation settings
- In the conversation settings (in the upper right corner of a conversation), check that notifications are set to
"Always notify" or "Notify when mentioned"

- Be aware that this is a per conversation setting. Set it for every conversation differently depending on your
needs.

- Also be aware that notifications are not generated when you have an active session for a conversation. This also applies for tabs that are open in the background, etc.
- Also be aware that notifications are not generated when you have an active session for a conversation. This also
applies for browser tabs that are open in the background, etc.

### 🖥 Check server settings

Expand Down
Binary file added docs/notificationsNotSetUpCorrectlyWarning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/notificationsNotSetUpCorrectlyWarning.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
# SPDX-License-Identifier: GPL-3.0-or-later

0 comments on commit a29e210

Please sign in to comment.