Add CollapseID & AlertSubtitle for iOS 10 support

Author: sideshow

client.go

@@ -125,6 +125,9 @@ func setHeaders(r *http.Request, n *Notification) {
 	if n.ApnsID != "" {
 		r.Header.Set("apns-id", n.ApnsID)
 	}
+	if n.CollapseID != "" {
+		r.Header.Set("apns-collapse-id", n.CollapseID)
+	}
 	if n.Priority > 0 {
 		r.Header.Set("apns-priority", fmt.Sprintf("%v", n.Priority))
 	}

client_test.go

@@ -118,6 +118,7 @@ func TestDefaultHeaders(t *testing.T) {
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		assert.Equal(t, "application/json; charset=utf-8", r.Header.Get("Content-Type"))
 		assert.Equal(t, "", r.Header.Get("apns-id"))
+		assert.Equal(t, "", r.Header.Get("apns-collapse-id"))
 		assert.Equal(t, "", r.Header.Get("apns-priority"))
 		assert.Equal(t, "", r.Header.Get("apns-topic"))
 		assert.Equal(t, "", r.Header.Get("apns-expiration"))
@@ -130,11 +131,13 @@ func TestDefaultHeaders(t *testing.T) {
 func TestHeaders(t *testing.T) {
 	n := mockNotification()
 	n.ApnsID = "84DB694F-464F-49BD-960A-D6DB028335C9"
+	n.CollapseID = "game1.start.identifier"
 	n.Topic = "com.testapp"
 	n.Priority = 10
 	n.Expiration = time.Now()
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		assert.Equal(t, n.ApnsID, r.Header.Get("apns-id"))
+		assert.Equal(t, n.CollapseID, r.Header.Get("apns-collapse-id"))
 		assert.Equal(t, "10", r.Header.Get("apns-priority"))
 		assert.Equal(t, n.Topic, r.Header.Get("apns-topic"))
 		assert.Equal(t, fmt.Sprintf("%v", n.Expiration.Unix()), r.Header.Get("apns-expiration"))

notification.go

@@ -32,6 +32,10 @@ type Notification struct {
 	// response.
 	ApnsID string
 
+	// A string which allows a notification to be replaced by a new notification
+	// with the same CollapseID.
+	CollapseID string
+
 	// A string containing hexadecimal bytes of the device token for the target device.
 	DeviceToken string
 

payload/builder.go

@@ -28,6 +28,7 @@ type alert struct {
 	LocArgs      []string `json:"loc-args,omitempty"`
 	LocKey       string   `json:"loc-key,omitempty"`
 	Title        string   `json:"title,omitempty"`
+	Subtitle     string   `json:"subtitle,omitempty"`
 	TitleLocArgs []string `json:"title-loc-args,omitempty"`
 	TitleLocKey  string   `json:"title-loc-key,omitempty"`
 }
@@ -100,6 +101,7 @@ func (p *Payload) ContentAvailable() *Payload {
 // MutableContent sets the aps mutable-content on the payload to 1.
 // This will indicate to the to the system to call your Notification Service
 // extension to mutate or replace the notification's content.
+//
 //	{"aps":{"mutable-content":1}}
 func (p *Payload) MutableContent() *Payload {
 	p.aps().MutableContent = 1
@@ -151,6 +153,16 @@ func (p *Payload) AlertTitleLocArgs(args []string) *Payload {
 	return p
 }
 
+// AlertSubtitle sets the aps alert subtitle on the payload.
+// This will display a short string describing the purpose of the notification.
+// Apple Watch & Safari display this string as part of the notification interface.
+//
+//	{"aps":{"subtitle":"subtitle"}}
+func (p *Payload) AlertSubtitle(subtitle string) *Payload {
+	p.aps().alert().Subtitle = subtitle
+	return p
+}
+
 // AlertBody sets the aps alert body on the payload.
 // This is the text of the alert message.
 //

payload/builder_test.go

@@ -94,6 +94,12 @@ func TestAlertTitleLocArgs(t *testing.T) {
 	assert.Equal(t, `{"aps":{"alert":{"title-loc-args":["Jenna","Frank"]}}}`, string(b))
 }
 
+func TestAlertSubtitle(t *testing.T) {
+	payload := NewPayload().AlertSubtitle("hello")
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"alert":{"subtitle":"hello"}}}`, string(b))
+}
+
 func TestAlertBody(t *testing.T) {
 	payload := NewPayload().AlertBody("body")
 	b, _ := json.Marshal(payload)