Enlarge README.md for Novu. Refs: #50414

symfony · Jun 15, 2023 · 24e1136 · 24e1136
1 parent 05c57e2
commit 24e1136
Showing 1 changed file with 54 additions and 0 deletions.
diff --git a/src/Symfony/Component/Notifier/Bridge/Novu/README.md b/src/Symfony/Component/Notifier/Bridge/Novu/README.md
@@ -10,6 +10,60 @@ DSN example
 NOVU_DSN=novu://API_KEY@default
 ```
 
+Notification example
+--------------------
+
+```php
+class NovuNotification extends Notification implements PushNotificationInterface
+{
+    public function asPushMessage(
+        NovuSubscriberRecipient|RecipientInterface $recipient,
+        ?string $transport = null,
+    ): ?PushMessage {
+        return new PushMessage(
+            $this->getSubject(),
+            $this->getContent(),
+            new NovuOptions(
+                $recipient->getSubscriberId(),
+                $recipient->getFirstName(),
+                $recipient->getLastName(),
+                $recipient->getEmail(),
+                $recipient->getPhone(),
+                $recipient->getAvatar(),
+                $recipient->getLocale(),
+                [],
+            ),
+        );
+    }
+}
+```
+
+```php
+$notification = new NovuNotification;
+$notification->subject('test');
+$notification->channels(['push']);
+$notification->content(
+    json_encode(
+        [
+            'param1' => 'Lorum Ipsum',
+        ]
+    )
+);
+
+$this->notifier->send(
+    $notification,
+    new NovuSubscriberRecipient(
+        "123",
+        'Wouter',
+        'van der Loop',
+        'woutervdl@toppy.nl',
+        null,
+        null,
+        null,
+    ),
+);
+```
+
 Resources
 ---------