add CriticalSound support for APS (#196)

* add CriticalSound support for APS

* change type of critical from int to bool

Author: chemidy

CHANGELOG.md

@@ -1,12 +1,15 @@
 # Unreleased
 
+- [added] `messaging.Aps` type now supports critical sound in its payload.
+
 # v3.5.0
 
 - [added] `messaging.AndroidNotification` type now supports `channel_id`.
 - [dropped] Dropped support for Go 1.8 and earlier.
 - [fixed] Fixing error handling in FCM. The SDK now checks the key 
   `type.googleapis.com/google.firebase.fcm.v1.FcmError` to set error code.
 - [added] `messaging.ApsAlert` type now supports subtitle in its payload.
+- [added] `messaging.WebpushConfig` type now supports fcmOptions in its payload.
 
 # v3.4.0
 

messaging/messaging.go

@@ -350,6 +350,7 @@ type Aps struct {
 	Alert            *ApsAlert
 	Badge            *int
 	Sound            string
+	CriticalSound    *CriticalSound
 	ContentAvailable bool
 	MutableContent   bool
 	Category         string
@@ -374,7 +375,9 @@ func (a *Aps) standardFields() map[string]interface{} {
 	if a.Badge != nil {
 		m["badge"] = *a.Badge
 	}
-	if a.Sound != "" {
+	if a.CriticalSound != nil {
+		m["sound"] = a.CriticalSound
+	} else if a.Sound != "" {
 		m["sound"] = a.Sound
 	}
 	if a.Category != "" {
@@ -395,6 +398,13 @@ func (a *Aps) MarshalJSON() ([]byte, error) {
 	return json.Marshal(m)
 }
 
+// CriticalSound is the sound payload that can be included in an Aps.
+type CriticalSound struct {
+	Critical bool    `json:"critical,omitempty"`
+	Name     string  `json:"name,omitempty"`
+	Volume   float64 `json:"volume,omitempty"`
+}
+
 // ApsAlert is the alert payload that can be included in an Aps.
 //
 // See https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html

messaging/messaging_test.go

@@ -329,6 +329,60 @@ var validMessages = []struct {
 			"topic": "test-topic",
 		},
 	},
+	{
+		name: "APNSAlertCrticalSound",
+		req: &Message{
+			APNS: &APNSConfig{
+				Headers: map[string]string{
+					"h1": "v1",
+					"h2": "v2",
+				},
+				Payload: &APNSPayload{
+					Aps: &Aps{
+						AlertString: "a",
+						Badge:       &badge,
+						Category:    "c",
+						CriticalSound: &CriticalSound{
+							Critical: true,
+							Name:     "n",
+							Volume:   0.7,
+						},
+						ThreadID:         "t",
+						ContentAvailable: true,
+						MutableContent:   true,
+					},
+					CustomData: map[string]interface{}{
+						"k1": "v1",
+						"k2": true,
+					},
+				},
+			},
+			Topic: "test-topic",
+		},
+		want: map[string]interface{}{
+			"apns": map[string]interface{}{
+				"headers": map[string]interface{}{"h1": "v1", "h2": "v2"},
+				"payload": map[string]interface{}{
+					"aps": map[string]interface{}{
+						"alert":    "a",
+						"badge":    float64(badge),
+						"category": "c",
+						"sound": map[string]interface{}{
+							"critical": true,
+							"name":     "n",
+							"volume":   float64(0.7),
+						},
+						"thread-id":         "t",
+						"content-available": float64(1),
+						"mutable-content":   float64(1),
+					},
+					"k1": "v1",
+					"k2": true,
+				},
+			},
+			"topic": "test-topic",
+		},
+	},
 	{
 		name: "APNSBadgeZero",
 		req: &Message{

messaging/messaging_utils.go

@@ -108,6 +108,9 @@ func validateAps(aps *Aps) error {
 		if aps.Alert != nil && aps.AlertString != "" {
 			return fmt.Errorf("multiple alert specifications")
 		}
+		if aps.CriticalSound != nil && aps.Sound != "" {
+			return fmt.Errorf("multiple sound specifications")
+		}
 		m := aps.standardFields()
 		for k := range aps.CustomData {
 			if _, contains := m[k]; contains {