Add Documentation (Troubleshooting, Application Developers' Notes) #150
Conversation
Signed-off-by: Olivier Wilkinson (reivilibre) <olivier@librepush.net>
reivilibre
changed the title
| Whereas data messages will wake up apps on Android with no additional changes, | ||
| iOS needs to be told that a notification is meant to wake up an inactive app. | ||
| This is done with the `content_available` flag, which you can set in your | ||
| `fcm_options` dictionary for the Firebase pushkin. |
There was a problem hiding this comment.
Setting an option for APNs is done using the fcm_options dict?
There was a problem hiding this comment.
Yes, as confusing as that is, since you need to tell FCM to set the APNs flag.
If you have suggestions to clarify, I'm all ears.
(Tempted to reorder so APNs is first, that way it's harder for your eyes to latch on to the mention of 'iOS' in the Firebase section)
There was a problem hiding this comment.
So this section is about sending notifications to iOS through FCM?
There was a problem hiding this comment.
Yes, exactly (what a monstrosity, but people want to do it)
There was a problem hiding this comment.
@iaMeteor Please don't bump old merged PRs. But to answer your question: Sygnal does not have a config option called apn_options.
The available options for APNs are listed here: https://github.com/matrix-org/sygnal/blob/main/sygnal.yaml.sample#L166-L199
Though note that there appears to be an unlisted option called push_type, with these possible values:
Lines 115 to 122 in 3a6ee38
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
|
@anoadragon453 Thanks for your reviews! |
This is a first pass at adding some docs, which will hopefully help all round (but especially the community).
As with most docs, always can use improvements but I eventually ran out of steam to figure out what I could add that would be useful — tempted to play it by ear and add stuff as and when it comes up.