[Notifier] Document Notifier options in README files 5.4

alamirault · nicolas-grekas · commit b670273f2fa8 · 2023-05-22T10:46:29.000+02:00
diff --git a/src/Symfony/Component/Notifier/Bridge/AmazonSns/AmazonSnsOptions.php b/src/Symfony/Component/Notifier/Bridge/AmazonSns/AmazonSnsOptions.php
@@ -52,7 +52,7 @@ public function recipient(string $topic): self
     }
 
     /**
-     * @see PublishInput::$Subject
+     * @see PublishInput::$subject
      *
      * @return $this
      */
@@ -64,7 +64,7 @@ public function subject(string $subject): self
     }
 
     /**
-     * @see PublishInput::$MessageStructure
+     * @see PublishInput::$messageStructure
      *
      * @return $this
      */
diff --git a/src/Symfony/Component/Notifier/Bridge/AmazonSns/README.md b/src/Symfony/Component/Notifier/Bridge/AmazonSns/README.md
@@ -10,6 +10,30 @@ DSN example
 AMAZON_SNS_DSN=sns://ACCESS_ID:ACCESS_KEY@default?region=REGION
 ```
 
+Adding Options to a Chat Message
+--------------------------------
+
+With an Amazon SNS Chat Message, you can use the `AmazonSnsOptions` class to add
+message options.
+
+```php
+use Symfony\Component\Notifier\Message\ChatMessage;
+use Symfony\Component\Notifier\Bridge\AmazonSns\AmazonSnsOptions;
+
+$chatMessage = new ChatMessage('Contribute To Symfony');
+
+$options = (new AmazonSnsOptions('topic_arn'))
+    ->subject('subject')
+    ->messageStructure('json')
+    // ...
+    ;
+
+// Add the custom options to the chat message and send the message
+$chatMessage->options($options);
+
+$chatter->send($chatMessage);
+```
+
 Resources
 ---------
 
diff --git a/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md b/src/Symfony/Component/Notifier/Bridge/Mobyt/README.md
@@ -16,6 +16,29 @@ where:
  - `FROM` is the sender
  - `TYPE_QUALITY` is the quality of your message: `N` for high, `L` for medium, `LL` for low (default: `L`)
 
+Adding Options to a Message
+---------------------------
+
+With a Mobyt Message, you can use the `MobytOptions` class to add
+[message options](https://gatewayapi.com/docs/apis/rest/).
+
+```php
+use Symfony\Component\Notifier\Message\SmsMessage;
+use Symfony\Component\Notifier\Bridge\Mobyt\MobytOptions;
+
+$sms = new SmsMessage('+1411111111', 'My message');
+
+$options = (new MobytOptions())
+    ->messageType(MobytOptions::MESSAGE_TYPE_QUALITY_HIGH)
+    // ...
+    ;
+
+// Add the custom options to the sms message and send the message
+$sms->options($options);
+
+$texter->send($sms);
+```
+
 Resources
 ---------
 

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function recipient(string $topic): self`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`/**`
`55`		`- * @see PublishInput::$Subject`
	`55`	`+ * @see PublishInput::$subject`
`56`	`56`	`*`
`57`	`57`	`* @return $this`
`58`	`58`	`*/`
`@@ -64,7 +64,7 @@ public function subject(string $subject): self`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`/**`
`67`		`- * @see PublishInput::$MessageStructure`
	`67`	`+ * @see PublishInput::$messageStructure`
`68`	`68`	`*`
`69`	`69`	`* @return $this`
`70`	`70`	`*/`