Software / code / prosody-modules
Comparison
mod_push2/push2.md @ 6216:2f2539ce8f3b
mod_push2: implement grace period
| author | Stephen Paul Weber <singpolyma@singpolyma.net> |
|---|---|
| date | Mon, 24 Mar 2025 22:18:47 -0500 |
| parent | 6215:e53f0967520c |
| child | 6233:1c16bb49f6f6 |
comparison
equal
deleted
inserted
replaced
| 6215:e53f0967520c | 6216:2f2539ce8f3b |
|---|---|
| 13 ```xml | 13 ```xml |
| 14 <enable xmlns='urn:xmpp:push2:0'> | 14 <enable xmlns='urn:xmpp:push2:0'> |
| 15 <service>pusher@push.example.com</service> | 15 <service>pusher@push.example.com</service> |
| 16 <client>https://push.example.com/adlfkjadafdasf</client> | 16 <client>https://push.example.com/adlfkjadafdasf</client> |
| 17 <match profile="urn:xmpp:push2:match:archived-with-body"> | 17 <match profile="urn:xmpp:push2:match:archived-with-body"> |
| 18 <grace>144</grace> | |
| 18 <chat jid="somemuc@conference.example.com"> | 19 <chat jid="somemuc@conference.example.com"> |
| 19 <mention/> | 20 <mention/> |
| 20 </chat> | 21 </chat> |
| 21 <send xmlns="urn:xmpp:push2:send:notify-only:0"/> | 22 <send xmlns="urn:xmpp:push2:send:notify-only:0"/> |
| 22 </match> | 23 </match> |
| 28 The `<client/>` element contains an opaque string that will be included in all communication with the push service. It may be used to convey client identifiers used by the push notification service to route notifications. | 29 The `<client/>` element contains an opaque string that will be included in all communication with the push service. It may be used to convey client identifiers used by the push notification service to route notifications. |
| 29 | 30 |
| 30 The `<match/>` and `<send/>` elements define what profiles to use for matching stanzas and sending notifications. These are described later in this document. | 31 The `<match/>` and `<send/>` elements define what profiles to use for matching stanzas and sending notifications. These are described later in this document. |
| 31 | 32 |
| 32 The optional `<chat/>` child of `<match/>` allows extra filtering of pushes for only specific chats. No specified filters means muted, do not push. `<mention/>` means push on mentions, `<reply/>` means push on replies. | 33 The optional `<chat/>` child of `<match/>` allows extra filtering of pushes for only specific chats. No specified filters means muted, do not push. `<mention/>` means push on mentions, `<reply/>` means push on replies. |
| 34 | |
| 35 The optional `<grace/>` child of `<match/>` allows specifying a "grace period" in seconds where activity on another session by the same user (such as sending a message) will temporarily pause sending push notifications. | |
| 33 | 36 |
| 34 ## Match and send profiles | 37 ## Match and send profiles |
| 35 | 38 |
| 36 Different clients and push services have different requirements for push notifications, often due to the differing capabilities of target platforms. | 39 Different clients and push services have different requirements for push notifications, often due to the differing capabilities of target platforms. |
| 37 | 40 |