wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve formatting of definitions in the Push Notifications section (#1415)

Browse source 
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
This commit is contained in:
Kim Brose 2023-01-29 16:22:12 +01:00 • committed by GitHub
parent f06ffc8176
commit d4586eba2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/internal/newsfragments/1415.clarification Normal file
View file

@ -0,0 +1 @@
Improve formatting of definitions in the Push Notifications section.

47
content/client-server-api/modules/push.md
View file

@ -51,34 +51,39 @@ such as Apple's APNS or Google's GCM. This happens as follows:
Definitions for terms used in this section are below: Definitions for terms used in this section are below:
Push Provider Push Provider
A push provider is a service managed by the device vendor which can send
notifications directly to the device. Google Cloud Messaging (GCM) and : A push provider is a service managed by the device vendor which can send
Apple Push Notification Service (APNS) are two examples of push notifications directly to the device. Google Cloud Messaging (GCM) and
providers. Apple Push Notification Service (APNS) are two examples of push
providers.
Push Gateway Push Gateway
A push gateway is a server that receives HTTP event notifications from
homeservers and passes them on to a different protocol such as APNS for : A push gateway is a server that receives HTTP event notifications from
iOS devices or GCM for Android devices. Clients inform the homeserver homeservers and passes them on to a different protocol such as APNS for
which Push Gateway to send notifications to when it sets up a Pusher. iOS devices or GCM for Android devices. Clients inform the homeserver
which Push Gateway to send notifications to when it sets up a Pusher.
Pusher Pusher
A pusher is a worker on the homeserver that manages the sending of HTTP
notifications for a user. A user can have multiple pushers: one per : A pusher is a worker on the homeserver that manages the sending of HTTP
device. notifications for a user. A user can have multiple pushers: one per
device.
Push Rule Push Rule
A push rule is a single rule that states under what *conditions* an
event should be passed onto a push gateway and *how* the notification : A push rule is a single rule that states under what *conditions* an
should be presented. These rules are stored on the user's homeserver. event should be passed onto a push gateway and *how* the notification
They are manually configured by the user, who can create and view them should be presented. These rules are stored on the user's homeserver.
via the Client/Server API. They are manually configured by the user, who can create and view them
via the Client/Server API.
Push Ruleset Push Ruleset
A push ruleset *scopes a set of rules according to some criteria*. For
example, some rules may only be applied for messages from a particular : A push ruleset *scopes a set of rules according to some criteria*. For
sender, a particular room, or by default. The push ruleset contains the example, some rules may only be applied for messages from a particular
entire set of scopes and rules. sender, a particular room, or by default. The push ruleset contains the
entire set of scopes and rules.
#### Client behaviour #### Client behaviour
@ -864,7 +869,7 @@ than the room, sender and content rules):
##### Recommendations for APNS ##### Recommendations for APNS
The exact format for sending APNS notifications is flexible and up to The exact format for sending APNS notifications is flexible and up to
the client app and its' push gateway to agree on. As APNS requires that the client app and its push gateway to agree on. As APNS requires that
the sender has a private key owned by the app developer, each app must the sender has a private key owned by the app developer, each app must
have its own push gateway. It is recommended that: have its own push gateway. It is recommended that: