mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-09-07 05:31:56 +00:00
Fix the formatting of push config section (#8818)
This PR updates the push config's formatting to better align with our [code style guidelines](https://github.com/matrix-org/synapse/blob/develop/docs/code_style.md#configuration-file-format).
This commit is contained in:
parent
d963c69ba5
commit
2b110dda2a
1
changelog.d/8818.doc
Normal file
1
changelog.d/8818.doc
Normal file
@ -0,0 +1 @@
|
|||||||
|
Update the formatting of the `push` section of the homeserver config file to better align with the [code style guidelines](https://github.com/matrix-org/synapse/blob/develop/docs/code_style.md#configuration-file-format).
|
@ -2251,20 +2251,25 @@ password_providers:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Clients requesting push notifications can either have the body of
|
## Push ##
|
||||||
# the message sent in the notification poke along with other details
|
|
||||||
# like the sender, or just the event ID and room ID (`event_id_only`).
|
push:
|
||||||
# If clients choose the former, this option controls whether the
|
# Clients requesting push notifications can either have the body of
|
||||||
# notification request includes the content of the event (other details
|
# the message sent in the notification poke along with other details
|
||||||
# like the sender are still included). For `event_id_only` push, it
|
# like the sender, or just the event ID and room ID (`event_id_only`).
|
||||||
# has no effect.
|
# If clients choose the former, this option controls whether the
|
||||||
#
|
# notification request includes the content of the event (other details
|
||||||
# For modern android devices the notification content will still appear
|
# like the sender are still included). For `event_id_only` push, it
|
||||||
# because it is loaded by the app. iPhone, however will send a
|
# has no effect.
|
||||||
# notification saying only that a message arrived and who it came from.
|
#
|
||||||
#
|
# For modern android devices the notification content will still appear
|
||||||
#push:
|
# because it is loaded by the app. iPhone, however will send a
|
||||||
# include_content: true
|
# notification saying only that a message arrived and who it came from.
|
||||||
|
#
|
||||||
|
# The default value is "true" to include message details. Uncomment to only
|
||||||
|
# include the event ID and room ID in push notification payloads.
|
||||||
|
#
|
||||||
|
#include_content: false
|
||||||
|
|
||||||
|
|
||||||
# Spam checkers are third-party modules that can block specific actions
|
# Spam checkers are third-party modules that can block specific actions
|
||||||
|
@ -21,7 +21,7 @@ class PushConfig(Config):
|
|||||||
section = "push"
|
section = "push"
|
||||||
|
|
||||||
def read_config(self, config, **kwargs):
|
def read_config(self, config, **kwargs):
|
||||||
push_config = config.get("push", {})
|
push_config = config.get("push") or {}
|
||||||
self.push_include_content = push_config.get("include_content", True)
|
self.push_include_content = push_config.get("include_content", True)
|
||||||
|
|
||||||
pusher_instances = config.get("pusher_instances") or []
|
pusher_instances = config.get("pusher_instances") or []
|
||||||
@ -49,18 +49,23 @@ class PushConfig(Config):
|
|||||||
|
|
||||||
def generate_config_section(self, config_dir_path, server_name, **kwargs):
|
def generate_config_section(self, config_dir_path, server_name, **kwargs):
|
||||||
return """
|
return """
|
||||||
# Clients requesting push notifications can either have the body of
|
## Push ##
|
||||||
# the message sent in the notification poke along with other details
|
|
||||||
# like the sender, or just the event ID and room ID (`event_id_only`).
|
push:
|
||||||
# If clients choose the former, this option controls whether the
|
# Clients requesting push notifications can either have the body of
|
||||||
# notification request includes the content of the event (other details
|
# the message sent in the notification poke along with other details
|
||||||
# like the sender are still included). For `event_id_only` push, it
|
# like the sender, or just the event ID and room ID (`event_id_only`).
|
||||||
# has no effect.
|
# If clients choose the former, this option controls whether the
|
||||||
#
|
# notification request includes the content of the event (other details
|
||||||
# For modern android devices the notification content will still appear
|
# like the sender are still included). For `event_id_only` push, it
|
||||||
# because it is loaded by the app. iPhone, however will send a
|
# has no effect.
|
||||||
# notification saying only that a message arrived and who it came from.
|
#
|
||||||
#
|
# For modern android devices the notification content will still appear
|
||||||
#push:
|
# because it is loaded by the app. iPhone, however will send a
|
||||||
# include_content: true
|
# notification saying only that a message arrived and who it came from.
|
||||||
|
#
|
||||||
|
# The default value is "true" to include message details. Uncomment to only
|
||||||
|
# include the event ID and room ID in push notification payloads.
|
||||||
|
#
|
||||||
|
#include_content: false
|
||||||
"""
|
"""
|
||||||
|
Loading…
Reference in New Issue
Block a user