feat: add support for setDirectBootOk on OptionsBuilder

and mark setDryRun as deprecated v1 FCM on OptionsBuilder

Author: williamdes

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [v1.x.x]
+
+- Add support for setDirectBootOk on OptionsBuilder
+- Mark setDryRun as deprecated v1 FCM on OptionsBuilder
+
 ## [v1.5.0]
 
 - Add support for images on PayloadNotificationBuilder

src/Message/Options.php

@@ -65,6 +65,13 @@ class Options implements Arrayable
      */
     protected $isDryRun = false;
 
+    /**
+     * @internal
+     *
+     * @var bool
+     */
+    protected $directBootOk = false;
+
     /**
      * Options constructor.
      *
@@ -80,6 +87,7 @@ public function __construct(OptionsBuilder $builder)
         $this->timeToLive = $builder->getTimeToLive();
         $this->restrictedPackageName = $builder->getRestrictedPackageName();
         $this->isDryRun = $builder->isDryRun();
+        $this->directBootOk = $builder->isDirectBootOk();
     }
 
     /**
@@ -93,6 +101,7 @@ public function toArray()
         $mutableContent = $this->isMutableContent ? true : null;
         $delayWhileIdle = $this->delayWhileIdle ? true : null;
         $dryRun = $this->isDryRun ? true : null;
+        $directBootOk = $this->directBootOk ? true : null;
 
         $options = [
             'collapse_key' => $this->collapseKey,
@@ -103,6 +112,7 @@ public function toArray()
             'time_to_live' => $this->timeToLive,
             'restricted_package_name' => $this->restrictedPackageName,
             'dry_run' => $dryRun,
+            'direct_boot_ok' => $directBootOk,
         ];
 
         return array_filter($options);

src/Message/OptionsBuilder.php

@@ -69,6 +69,13 @@ class OptionsBuilder
      */
     protected $dryRun = false;
 
+    /**
+     * @internal
+     *
+     * @var bool
+     */
+    protected $directBootOk;
+
     /**
      * This parameter identifies a group of messages
      * A maximum of 4 different collapse keys is allowed at any given time.
@@ -84,6 +91,23 @@ public function setCollapseKey($collapseKey)
         return $this;
     }
 
+    /**
+     * If set to true, messages will be allowed to be delivered to the app while the device is in direct boot mode.
+     * See Support Direct Boot mode (https://developer.android.com/training/articles/direct-boot).
+     *
+     * @see https://developer.android.com/training/articles/direct-boot
+     *
+     * @param true $directBootOk (only true is valid, do not use for false it is pointless)
+     *
+     * @return \LaravelFCM\Message\OptionsBuilder
+     */
+    public function setDirectBootOk($directBootOk)
+    {
+        $this->directBootOk = $directBootOk;
+
+        return $this;
+    }
+
     /**
      * Sets the priority of the message. Valid values are "normal" and "high."
      * By default, messages are sent with normal priority.
@@ -175,6 +199,7 @@ public function setTimeToLive($timeToLive)
 
     /**
      * This parameter specifies the package name of the application where the registration tokens must match in order to receive the message.
+     * (Android only)
      *
      * @param string $restrictedPackageName
      *
@@ -191,6 +216,7 @@ public function setRestrictedPackageName($restrictedPackageName)
      * This parameter, when set to true, allows developers to test a request without actually sending a message.
      * It should only be used for the development.
      *
+     * @deprecated v1 (https://stackoverflow.com/a/53885050/5155484)
      * @param bool $isDryRun
      *
      * @return \LaravelFCM\Message\OptionsBuilder
@@ -282,6 +308,16 @@ public function isDryRun()
         return $this->dryRun;
     }
 
+    /**
+     * is direct boot ok
+     *
+     * @return bool
+     */
+    public function isDirectBootOk()
+    {
+        return $this->directBootOk;
+    }
+
     /**
      * build an instance of Options.
      *

tests/MessageTest.php

@@ -46,6 +46,43 @@ public function it_construct_a_valid_json_with_option()
         $this->assertJsonStringEqualsJsonString($targetFull, $json);
     }
 
+    public function testBuildOptionsDirectBootOk()
+    {
+        $targetPartial = '{
+					"direct_boot_ok": true,
+					"content_available":true
+				}';
+
+        $targetFull = '{
+					"collapse_key":"collapseKey",
+					"content_available":true,
+					"priority":"high",
+					"delay_while_idle":true,
+					"time_to_live":200,
+					"restricted_package_name":"customPackageName",
+					"dry_run": true,
+					"direct_boot_ok": true
+				}';
+
+        $optionBuilder = new OptionsBuilder();
+
+        $optionBuilder->setDirectBootOk(true);
+        $optionBuilder->setContentAvailable(true);
+
+        $json = json_encode($optionBuilder->build()->toArray());
+        $this->assertJsonStringEqualsJsonString($targetPartial, $json);
+
+        $optionBuilder->setPriority(OptionsPriorities::high)
+            ->setCollapseKey('collapseKey')
+            ->setDelayWhileIdle(true)
+            ->setDryRun(true)
+            ->setRestrictedPackageName('customPackageName')
+            ->setTimeToLive(200);
+
+        $json = json_encode($optionBuilder->build()->toArray());
+        $this->assertJsonStringEqualsJsonString($targetFull, $json);
+    }
+
     /**
      * @test
      */