fix(icons): Document icon requirements for notifications and activities

Signed-off-by: Joas Schilling <coding@schilljs.com>
nextcloud · Sep 25, 2024 · 1f188c3 · 1f188c3
1 parent 6befdd6
commit 1f188c3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php
@@ -310,6 +310,10 @@ public function getObjectName(): string;
 	public function getLink(): string;
 
 	/**
+	 * Set the absolute url for the icon (should be colored black or not have a color)
+	 *
+	 * It's automatically color inverted by clients when needed
+	 *
 	 * @param string $icon
 	 * @return $this
 	 * @throws InvalidValueException if the icon is invalid
@@ -319,6 +323,10 @@ public function getLink(): string;
 	public function setIcon(string $icon): self;
 
 	/**
+	 * Get the absolute url for the icon (should be colored black or not have a color)
+	 *
+	 * It's automatically color inverted by clients when needed
+	 *
 	 * @return string
 	 * @since 11.0.0
 	 */

diff --git a/lib/public/Notification/INotification.php b/lib/public/Notification/INotification.php
@@ -249,6 +249,10 @@ public function setLink(string $link): INotification;
 	public function getLink(): string;
 
 	/**
+	 * Set the absolute url for the icon (should be colored black or not have a color)
+	 *
+	 * It's automatically color inverted by clients when needed
+	 *
 	 * @param string $icon
 	 * @return $this
 	 * @throws InvalidValueException if the icon is invalid
@@ -258,6 +262,10 @@ public function getLink(): string;
 	public function setIcon(string $icon): INotification;
 
 	/**
+	 * Get the absolute url for the icon (should be colored black or not have a color)
+	 *
+	 * It's automatically color inverted by clients when needed
+	 *
 	 * @return string
 	 * @since 11.0.0
 	 */