Software / code / prosody-modules
Comparison
mod_push2/push2.md @ 6263:10a1016d1c3a
Merge update
| author | Trần H. Trung <xmpp:trần.h.trung@trung.fun> |
|---|---|
| date | Sun, 01 Jun 2025 11:43:16 +0700 |
| parent | 6233:1c16bb49f6f6 |
comparison
equal
deleted
inserted
replaced
| 6262:a72388da5cd4 | 6263:10a1016d1c3a |
|---|---|
| 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> | |
| 19 <filter jid="somemuc@conference.example.com"> | |
| 20 <mention/> | |
| 21 </filter> | |
| 18 <send xmlns="urn:xmpp:push2:send:notify-only:0"/> | 22 <send xmlns="urn:xmpp:push2:send:notify-only:0"/> |
| 19 </match> | 23 </match> |
| 20 </enable> | 24 </enable> |
| 21 ``` | 25 ``` |
| 22 | 26 |
| 23 The `<service/>` element contains a JID which push notifications for this client will be sent to. It may be a host, bare or full JID. | 27 The `<service/>` element contains a JID which push notifications for this client will be sent to. It may be a host, bare or full JID. |
| 24 | 28 |
| 25 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. |
| 26 | 30 |
| 27 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. |
| 32 | |
| 33 The optional `<filter/>` 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. | |
| 28 | 36 |
| 29 ## Match and send profiles | 37 ## Match and send profiles |
| 30 | 38 |
| 31 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. |
| 32 | 40 |