Add support for Summary arguments in notifications for iOS 12 (#119)

* Add summary-arg

Author: tommy-muehle

payload/builder.go

@@ -22,16 +22,18 @@ type aps struct {
 }
 
 type alert struct {
-	Action       string   `json:"action,omitempty"`
-	ActionLocKey string   `json:"action-loc-key,omitempty"`
-	Body         string   `json:"body,omitempty"`
-	LaunchImage  string   `json:"launch-image,omitempty"`
-	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"`
+	Action          string   `json:"action,omitempty"`
+	ActionLocKey    string   `json:"action-loc-key,omitempty"`
+	Body            string   `json:"body,omitempty"`
+	LaunchImage     string   `json:"launch-image,omitempty"`
+	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"`
+	SummaryArg      string   `json:"summary-arg,omitempty"`
+	SummaryArgCount int      `json:"summary-arg-count,omitempty"`
 }
 
 type sound struct {
@@ -235,6 +237,28 @@ func (p *Payload) AlertActionLocKey(key string) *Payload {
 	return p
 }
 
+// SummaryArg sets the aps alert summary arg key on the payload.
+// This is the string that is used as a key to fill in an argument
+// at the bottom of a notification to provide more context, such as
+// a name associated with the sender of the notification.
+//
+//	{"aps":{"alert":{"summary-arg":key}}}
+func (p *Payload) AlertSummaryArg(key string) *Payload {
+	p.aps().alert().SummaryArg = key
+	return p
+}
+
+// SummaryArgCount sets the aps alert summary arg count key on the payload.
+// This integer sets a custom "weight" on the notification, effectively
+// allowing a notification to be viewed internally as two. For example if
+// a notification encompasses 3 messages, you can set it to 3.
+//
+//	{"aps":{"alert":{"summary-arg-count":key}}}
+func (p *Payload) AlertSummaryArgCount(key int) *Payload {
+	p.aps().alert().SummaryArgCount = key
+	return p
+}
+
 // General
 
 // Category sets the aps category on the payload.

payload/builder_test.go

@@ -176,6 +176,18 @@ func TestSoundVolume(t *testing.T) {
 	assert.Equal(t, `{"aps":{"sound":{"critical":1,"name":"default","volume":0.5}}}`, string(b))
 }
 
+func TestAlertSummaryArg(t *testing.T) {
+	payload := NewPayload().AlertSummaryArg("Robert")
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"alert":{"summary-arg":"Robert"}}}`, string(b))
+}
+
+func TestAlertSummaryArgCount(t *testing.T) {
+	payload := NewPayload().AlertSummaryArgCount(3)
+	b, _ := json.Marshal(payload)
+	assert.Equal(t, `{"aps":{"alert":{"summary-arg-count":3}}}`, string(b))
+}
+	
 func TestCombined(t *testing.T) {
 	payload := NewPayload().Alert("hello").Badge(1).Sound("Default.caf").Custom("key", "val")
 	b, _ := json.Marshal(payload)