Mercurial > prosody-modules

comparison mod_push2/push2.md @ 6183:e53f0967520c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_push: Allow filtering pushes for particular chats
author Stephen Paul Weber <singpolyma@singpolyma.net>
date Mon, 24 Mar 2025 13:01:05 -0500
parents aa240145aa22
children 2f2539ce8f3b
comparison
equal deleted inserted replaced
6182:fe9f2c618e8a 6183:e53f0967520c
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 <chat jid="somemuc@conference.example.com">
19 <mention/>
20 </chat>
18 <send xmlns="urn:xmpp:push2:send:notify-only:0"/> 21 <send xmlns="urn:xmpp:push2:send:notify-only:0"/>
19 </match> 22 </match>
20 </enable> 23 </enable>
21 ``` 24 ```
22 25
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. 26 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 27
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. 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.
26 29
27 The `<match/>` and `<send/>` elements define what profiles to use for matching stanzas and sending notifications. These are described later in this document. 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
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.
28 33
29 ## Match and send profiles 34 ## Match and send profiles
30 35
31 Different clients and push services have different requirements for push notifications, often due to the differing capabilities of target platforms. 36 Different clients and push services have different requirements for push notifications, often due to the differing capabilities of target platforms.
32 37