update v1.0.7.9 R.C.

This is a Release Candidate. We are still testing.

vendor/brozot/laravel-fcm/src/Message/PayloadNotificationBuilder.php

@@ -0,0 +1,401 @@
+<?php namespace LaravelFCM\Message;
+
+/**
+ * Class PayloadNotificationBuilder
+ *
+ * Official google documentation :
+ * @link http://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json
+ *
+ * @package LaravelFCM\Message
+ */
+class PayloadNotificationBuilder {
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $title;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $body;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $icon;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $sound;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $badge;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $tag;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $color;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $clickAction;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $bodyLocationKey;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $bodyLocationArgs;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $titleLocationKey;
+
+	/**
+	 * @internal
+	 * @var null|String
+	 */
+	protected $titleLocationArgs;
+
+	/**
+	 * Title must be present on android notification and ios (watch) notification
+	 *
+	 * @param String $title
+	 */
+	public function __construct($title = null)
+	{
+		$this->title = $title;
+	}
+
+	/**
+	 * Indicates notification title. This field is not visible on iOS phones and tablets.
+	 * but it is required for android
+	 *
+	 * @param String $title
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setTitle($title) {
+		$this->title = $title;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates notification body text.
+	 *
+	 * @param String $body
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setBody($body)
+	{
+		$this->body = $body;
+
+		return $this;
+	}
+
+	/**
+	 * Supported Android
+	 * Indicates notification icon. example : Sets value to myicon for drawable resource myicon.
+	 *
+	 * @param String $icon
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setIcon($icon)
+	{
+		$this->icon = $icon;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates a sound to play when the device receives a notification.
+	 * Supports default or the filename of a sound resource bundled in the app.
+	 *
+	 * @param String $sound
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setSound($sound)
+	{
+		$this->sound = $sound;
+
+		return $this;
+	}
+
+	/**
+	 * Supported Ios
+	 *
+	 * Indicates the badge on the client app home icon.
+	 *
+	 * @param String $badge
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setBadge($badge)
+	{
+		$this->badge = $badge;
+
+		return $this;
+	}
+
+	/**
+	 * Supported Android
+	 *
+	 * Indicates whether each notification results in a new entry in the notification drawer on Android.
+	 * If not set, each request creates a new notification.
+	 * If set, and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
+	 *
+	 * @param String $tag
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setTag($tag)
+	{
+		$this->tag = $tag;
+
+		return $this;
+	}
+
+	/**
+	 * Supported Android
+	 *
+	 * Indicates color of the icon, expressed in #rrggbb format
+	 *
+	 * @param String $color
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setColor($color) {
+		$this->color = $color;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates the action associated with a user click on the notification
+	 *
+	 * @param String $action
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setClickAction($action)
+	{
+		$this->clickAction = $action;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates the key to the title string for localization.
+	 *
+	 * @param String $titleKey
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setTitleLocationKey($titleKey)
+	{
+		$this->titleLocationKey = $titleKey;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates the string value to replace format specifiers in the title string for localization.
+	 *
+	 * @param mixed $titleArgs
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setTitleLocationArgs($titleArgs)
+	{
+		$this->titleLocationArgs = $titleArgs;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates the key to the body string for localization.
+	 *
+	 * @param String $bodyKey
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setBodyLocationKey($bodyKey)
+	{
+		$this->bodyLocationKey = $bodyKey;
+
+		return $this;
+	}
+
+	/**
+	 * Indicates the string value to replace format specifiers in the body string for localization.
+	 *
+	 * @param mixed $bodyArgs
+	 *
+	 * @return PayloadNotificationBuilder current instance of the builder
+	 */
+	public function setBodyLocationArgs($bodyArgs)
+	{
+		$this->bodyLocationArgs = $bodyArgs;
+
+		return $this;
+	}
+
+	/**
+	 * Get title
+	 *
+	 * @return null|String
+	 */
+	public function getTitle()
+	{
+		return $this->title;
+	}
+
+	/**
+	 * Get body
+	 *
+	 * @return null|String
+	 */
+	public function getBody()
+	{
+		return $this->body;
+	}
+
+	/**
+	 * Get Icon
+	 *
+	 * @return null|String
+	 */
+	public function getIcon()
+	{
+		return $this->icon;
+	}
+
+	/**
+	 * Get Sound
+	 *
+	 * @return null|String
+	 */
+	public function getSound()
+	{
+		return $this->sound;
+	}
+
+	/**
+	 * Get Badge
+	 *
+	 * @return null|String
+	 */
+	public function getBadge()
+	{
+		return $this->badge;
+	}
+
+	/**
+	 * Get Tag
+	 *
+	 * @return null|String
+	 */
+	public function getTag()
+	{
+		return $this->tag;
+	}
+
+	/**
+	 * Get Color
+	 *
+	 * @return null|String
+	 */
+	public function getColor()
+	{
+		return $this->color;
+	}
+
+	/**
+	 * Get ClickAction
+	 *
+	 * @return null|String
+	 */
+	public function getClickAction()
+	{
+		return $this->clickAction;
+	}
+
+	/**
+	 * Get BodyLocationKey
+	 *
+	 * @return null|String
+	 */
+	public function getBodyLocationKey()
+	{
+		return $this->bodyLocationKey;
+	}
+
+	/**
+	 * Get BodyLocationArgs
+	 *
+	 * @return null|String|array
+	 */
+	public function getBodyLocationArgs()
+	{
+		return $this->bodyLocationArgs;
+	}
+
+	/**
+	 * Get TitleLocationKey
+	 *
+	 * @return string
+	 */
+	public function getTitleLocationKey()
+	{
+		return $this->titleLocationKey;
+	}
+
+	/**
+	 * GetTitleLocationArgs
+	 *
+	 * @return null|String|array
+	 */
+	public function getTitleLocationArgs()
+	{
+		return $this->titleLocationArgs;
+	}
+
+	/**
+	 * Build an PayloadNotification
+	 * 
+	 * @return PayloadNotification
+	 */
+	public function build()
+	{
+		return new PayloadNotification($this);
+	}
+}