Add iOS 15 payload additions

README.md

@@ -11,6 +11,7 @@ APNS/2 is a go package designed for simple, flexible and fast Apple Push Notific
 - Works with go 1.7 and later
 - Supports new Apple Token Based Authentication (JWT)
 - Supports new iOS 10 features such as Collapse IDs, Subtitles and Mutable Notifications
+- Supports new iOS 15 fetaures interruptionLevel and relevanceScore
 - Supports persistent connections to APNs
 - Supports VoIP/PushKit notifications (iOS 8 and later)
 - Modular & easy to use

payload/builder.go

@@ -11,14 +11,16 @@ type Payload struct {
 }
 
 type aps struct {
-	Alert            interface{} `json:"alert,omitempty"`
-	Badge            interface{} `json:"badge,omitempty"`
-	Category         string      `json:"category,omitempty"`
-	ContentAvailable int         `json:"content-available,omitempty"`
-	MutableContent   int         `json:"mutable-content,omitempty"`
-	Sound            interface{} `json:"sound,omitempty"`
-	ThreadID         string      `json:"thread-id,omitempty"`
-	URLArgs          []string    `json:"url-args,omitempty"`
+	Alert             interface{} `json:"alert,omitempty"`
+	Badge             interface{} `json:"badge,omitempty"`
+	Category          string      `json:"category,omitempty"`
+	ContentAvailable  int         `json:"content-available,omitempty"`
+	InterruptionLevel string      `json:"interruption-level,omitempty"`
+	MutableContent    int         `json:"mutable-content,omitempty"`
+	RelevanceScore    float32     `json:"relevance-score,omitempty"`
+	Sound             interface{} `json:"sound,omitempty"`
+	ThreadID          string      `json:"thread-id,omitempty"`
+	URLArgs           []string    `json:"url-args,omitempty"`
 }
 
 type alert struct {
@@ -324,6 +326,58 @@ func (p *Payload) SoundVolume(volume float32) *Payload {
 	return p
 }
 
+// InterruptionLevelPassive sets the aps interruption-level to "passive" on the payload.
+// This is to indicate the importance and delivery timing of a notification.
+// See: https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/
+//
+// {"aps":{"interruption-level":passive}}
+func (p *Payload) InterruptionLevelPassive() *Payload {
+	p.aps().InterruptionLevel = "passive"
+	return p
+}
+
+// InterruptionLevelActive sets the aps interruption-level to "active" on the payload.
+// This is to indicate the importance and delivery timing of a notification.
+// See: https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/
+//
+// {"aps":{"interruption-level":active}}
+func (p *Payload) InterruptionLevelActive() *Payload {
+	p.aps().InterruptionLevel = "active"
+	return p
+}
+
+// InterruptionLevelTimeSensitive sets the aps interruption-level to "time-sensitive" on the payload.
+// This is to indicate the importance and delivery timing of a notification.
+// See: https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/
+//
+// {"aps":{"interruption-level":time-sensitive}}
+func (p *Payload) InterruptionLevelTimeSensitive() *Payload {
+	p.aps().InterruptionLevel = "time-sensitive"
+	return p
+}
+
+// InterruptionLevelCritical sets the aps interruption-level to "critical" on the payload.
+// This is to indicate the importance and delivery timing of a notification.
+// This interruption level requires an approved entitlement from Apple.
+// See: https://developer.apple.com/documentation/usernotifications/unnotificationinterruptionlevel/
+//
+// {"aps":{"interruption-level":critical}}
+func (p *Payload) InterruptionLevelCritical() *Payload {
+	p.aps().InterruptionLevel = "critical"
+	return p
+}
+
+// The relevance score, a number between 0 and 1,
+// that the system uses to sort the notifications from your app.
+// The highest score gets featured in the notification summary.
+// See https://developer.apple.com/documentation/usernotifications/unnotificationcontent/3821031-relevancescore.
+//
+//	{"aps":{"relevance-score":0.1}}
+func (p *Payload) RelevanceScore(b float32) *Payload {
+	p.aps().RelevanceScore = b
+	return p
+}
+
 // MarshalJSON returns the JSON encoded version of the Payload
 func (p *Payload) MarshalJSON() ([]byte, error) {
 	return json.Marshal(p.content)

payload/builder_test.go

@@ -193,3 +193,33 @@ func TestCombined(t *testing.T) {
 	b, _ := json.Marshal(payload)
 	assert.Equal(t, `{"aps":{"alert":"hello","badge":1,"sound":"Default.caf"},"key":"val"}`, string(b))
 }
+
+func TestInterruptionLevelPassive(t *testing.T) {
+	payload := NewPayload().InterruptionLevelTimeSensitive().InterruptionLevelPassive()
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"interruption-level":"passive"}}`, string(b))
+}
+
+func TestInterruptionLevelActive(t *testing.T) {
+	payload := NewPayload().InterruptionLevelActive()
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"interruption-level":"active"}}`, string(b))
+}
+
+func TestInterruptionLevelTimeSensitive(t *testing.T) {
+	payload := NewPayload().InterruptionLevelTimeSensitive()
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"interruption-level":"time-sensitive"}}`, string(b))
+}
+
+func TestInterruptionLevelCritical(t *testing.T) {
+	payload := NewPayload().InterruptionLevelCritical()
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"interruption-level":"critical"}}`, string(b))
+}
+
+func TestRelevanceScore(t *testing.T) {
+	payload := NewPayload().RelevanceScore(0.1)
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"relevance-score":0.1}}`, string(b))
+}