Add group related notification ID (#16)

Co-authored-by: Daniil Glushchenko <[email protected]>
cybercog · Jun 19, 2024 · ab36a21 · ab36a21
1 parent d47cbdb
commit ab36a21
Show file tree

Hide file tree

Showing 8 changed files with 144 additions and 42 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 /vendor
 .phpunit.result.cache
 composer.lock
+.idea/
diff --git a/src/main/php/Gomoob/Pushwoosh/Model/Notification/Android.php b/src/main/php/Gomoob/Pushwoosh/Model/Notification/Android.php
@@ -22,7 +22,7 @@ class Android implements \JsonSerializable
      * @var int
      */
     private $badges;
-    
+
     private $banner;
     private $customIcon;
 
@@ -33,24 +33,31 @@ class Android implements \JsonSerializable
      * @var int
      */
     private $gcmTtl;
+
+    /**
+     * Identifier to group related notifications.
+     * Messages with the same thread ID will be grouped in the Notification Center.
+     */
+    private ?string $groupId;
+
     private $header;
-    
+
     /**
      * The icon background color on Lollipop, #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
      *
      * @var string
      */
     private $ibc;
-    
+
     private $icon;
-    
+
     /**
      * The LED hex color, device will do its best approximation.
      *
      * @var string
      */
     private $led;
-    
+
     /**
      * The priority of the push in the Android push drawer, valid values are -2, -1, 0, 1 and 2.
      *
@@ -60,7 +67,7 @@ class Android implements \JsonSerializable
 
     private $rootParams;
     private $sound;
-    
+
     /**
      * A boolean used to force vibration for high-priority pushes.
      *
@@ -113,12 +120,17 @@ public function getGcmTtl()
 
     }
 
+    public function getGroupId(): ?string
+    {
+        return $this->groupId;
+    }
+
     public function getHeader()
     {
         return $this->header;
 
     }
-    
+
     /**
      * Gets the icon background color on Lollipop, #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
      *
@@ -133,7 +145,7 @@ public function getIcon()
     {
         return $this->icon;
     }
-    
+
     /**
      * Gets the LED hex color, device will do its best approximation.
      *
@@ -143,7 +155,7 @@ public function getLed()
     {
         return $this->led;
     }
-    
+
     /**
      * Gets priority of the push in the Android push drawer, valid values are -2, -1, 0, 1 and 2.
      *
@@ -163,7 +175,7 @@ public function getSound()
     {
         return $this->sound;
     }
-    
+
     /**
      * Gets the boolean used to force vibration for high-priority pushes.
      *
@@ -173,14 +185,14 @@ public function isVibration()
     {
         return $this->vibration;
     }
-    
+
     /**
      * {@inheritdoc}
      */
     public function jsonSerialize(): mixed
     {
         $json = [];
-    
+
         isset($this->badges) ? $json['android_badges'] = $this->badges : false;
         isset($this->banner) ? $json['android_banner'] = $this->banner : false;
         isset($this->customIcon) ? $json['android_custom_icon'] = $this->customIcon : false;
@@ -193,9 +205,13 @@ public function jsonSerialize(): mixed
         isset($this->rootParams) ? $json['android_root_params'] = $this->rootParams : false;
         isset($this->sound) ? $json['android_sound'] = $this->sound : false;
         isset($this->vibration) ? $json['android_vibration'] = ($this->vibration ? 1 : 0) : false;
-
+
+        if ($this->groupId !== null) {
+            $json['android_group_id'] = $this->groupId;
+        }
+
         return $json;
-    
+
     }
 
     /**
@@ -208,7 +224,7 @@ public function jsonSerialize(): mixed
     public function setBadges($badges)
     {
         $this->badges = $badges;
-        
+
         return $this;
     }
 
@@ -242,14 +258,21 @@ public function setGcmTtl($gcmTtl)
         return $this;
     }
 
+    public function setGroupId(?string $groupId): self
+    {
+        $this->groupId = $groupId;
+
+        return $this;
+    }
+
     public function setHeader($header)
     {
         $this->header = $header;
 
         return $this;
 
     }
-    
+
     /**
      * Sets the icon background color on Lollipop, #RRGGBB, #AARRGGBB, "red", "black", "yellow", etc.
      *
@@ -260,7 +283,7 @@ public function setHeader($header)
     public function setIbc($ibc)
     {
         $this->ibc = $ibc;
-         
+
         return $this;
     }
 
@@ -270,7 +293,7 @@ public function setIcon($icon)
 
         return $this;
     }
-    
+
     /**
      * Sets the LED hex color, device will do its best approximation.
      *
@@ -281,10 +304,10 @@ public function setIcon($icon)
     public function setLed($led)
     {
         $this->led = $led;
-        
+
         return $this;
     }
-    
+
     /**
      * Sets the priority of the push in the Android push drawer, valid values are -2, -1, 0, 1 and 2.
      *
@@ -295,7 +318,7 @@ public function setLed($led)
     public function setPriority($priority)
     {
         $this->priority = $priority;
-         
+
         return $this;
     }
 
@@ -312,7 +335,7 @@ public function setSound($sound)
 
         return $this;
     }
-    
+
     /**
      * Sets the boolean used to force vibration for high-priority pushes.
      *
@@ -323,7 +346,7 @@ public function setSound($sound)
     public function setVibration($vibration)
     {
         $this->vibration = $vibration;
-        
+
         return $this;
     }
 }
diff --git a/src/main/php/Gomoob/Pushwoosh/Model/Notification/Huawei.php b/src/main/php/Gomoob/Pushwoosh/Model/Notification/Huawei.php
@@ -24,6 +24,12 @@ final class Huawei implements \JsonSerializable
      */
     private $gcmTtl;
 
+    /**
+     * Identifier to group related notifications.
+     * Messages with the same thread ID will be grouped in the Notification Center.
+     */
+    private ?string $groupId;
+
     /**
      * @var string|null
      */
@@ -89,6 +95,11 @@ public function getGcmTtl()
         return $this->gcmTtl;
     }
 
+    public function getGroupId(): ?string
+    {
+        return $this->groupId;
+    }
+
     public function getHeader()
     {
         return $this->header;
@@ -149,6 +160,10 @@ public function jsonSerialize(): mixed
             $json['huawei_android_gcm_ttl'] = $this->gcmTtl;
         }
 
+        if ($this->groupId !== null) {
+            $json['huawei_android_group_id'] = $this->groupId;
+        }
+
         if ($this->header !== null) {
             $json['huawei_android_header'] = $this->header;
         }
@@ -212,6 +227,13 @@ public function setGcmTtl($gcmTtl)
         return $this;
     }
 
+    public function setGroupId(?string $groupId): self
+    {
+        $this->groupId = $groupId;
+
+        return $this;
+    }
+
     public function setHeader($header)
     {
         $this->header = $header;

diff --git a/src/main/php/Gomoob/Pushwoosh/Model/Notification/IOS.php b/src/main/php/Gomoob/Pushwoosh/Model/Notification/IOS.php
@@ -23,16 +23,23 @@ class IOS implements \JsonSerializable
     private $apnsTrimContent;
 
     private $badges;
-    
+
     /**
      * The iOS 8 category ID from Pushwoosh.
      *
      * @var int
      */
     private $categoryId;
-    
+
     private $rootParams;
     private $sound;
+
+    /**
+     * Identifier to group related notifications.
+     * Messages with the same thread ID will be grouped on the lock screen and in the Notification Center.
+     */
+    private ?string $threadId;
+
     private $ttl;
     private $trimContent;
 
@@ -50,7 +57,7 @@ public function getBadges()
     {
         return $this->badges;
     }
-    
+
     /**
      * Gets the iOS 8 category ID from Pushwoosh.
      *
@@ -72,6 +79,11 @@ public function getSound()
 
     }
 
+    public function getThreadId(): ?string
+    {
+        return $this->threadId;
+    }
+
     public function getTtl()
     {
         return $this->ttl;
@@ -93,24 +105,28 @@ public function isTrimContent()
         return $this->trimContent;
 
     }
-    
+
     /**
      * {@inheritdoc}
      */
     public function jsonSerialize(): mixed
     {
         $json = [];
-    
+
         isset($this->apnsTrimContent) ? $json['apns_trim_content'] = intval($this->apnsTrimContent) : false;
         isset($this->badges) ? $json['ios_badges'] = $this->badges : false;
         isset($this->categoryId) ? $json['ios_category_id'] = $this->categoryId : false;
         isset($this->rootParams) ? $json['ios_root_params'] = $this->rootParams : false;
         isset($this->sound) ? $json['ios_sound'] = $this->sound : false;
         isset($this->ttl) ? $json['ios_ttl'] = $this->ttl : false;
         isset($this->trimContent) ? $json['ios_trim_content'] = intval($this->trimContent) : false;
-
+
+        if ($this->threadId !== null) {
+            $json['ios_thread_id'] = $this->threadId;
+        }
+
         return $json;
-    
+
     }
 
     /**
@@ -135,7 +151,7 @@ public function setBadges($badges)
         return $this;
 
     }
-    
+
     /**
      * Sets the iOS 8 category ID from Pushwoosh.
      *
@@ -146,7 +162,7 @@ public function setBadges($badges)
     public function setCategoryId($categoryId)
     {
         $this->categoryId = $categoryId;
-         
+
         return $this;
     }
 
@@ -165,6 +181,13 @@ public function setSound($sound)
         return $this;
     }
 
+    public function setThreadId(?string $threadId): self
+    {
+        $this->threadId = $threadId;
+
+        return $this;
+    }
+
     public function setTtl($ttl)
     {
         $this->ttl = $ttl;