Merge pull request #6552 from nextcloud/notifications-add-highlight-definition

Notifications: Add highlight type definition

1 files changed, 25 insertions, 0 deletions

diff --git a/lib/public/RichObjectStrings/Definitions.php b/lib/public/RichObjectStrings/Definitions.php
index 8ee3ad3bf3d..d1d636fe36b 100644
--- a/lib/public/RichObjectStrings/Definitions.php
+++ b/lib/public/RichObjectStrings/Definitions.php
@@ -256,6 +256,31 @@ class Definitions {
 				],
 			],
 		],
+		'highlight' => [
+			'author' => 'Nextcloud',
+			'app' => 'core',
+			'since' => '13.0.0',
+			'parameters' => [
+				'id' => [
+					'since' => '13.0.0',
+					'required' => true,
+					'description' => 'The id used to identify the highlighted object on the instance',
+					'example' => '42',
+				],
+				'name' => [
+					'since' => '13.0.0',
+					'required' => true,
+					'description' => 'The string that should be highlighted.',
+					'example' => 'Hello World',
+				],
+				'link' => [
+					'since' => '13.0.0',
+					'required' => false,
+					'description' => 'The full URL that should be opened when clicking the highlighted text.',
+					'example' => 'http://localhost/index.php/f/42',
+				],
+			],
+		],
 		'open-graph' => [
 			'author' => 'Maxence Lange',
 			'app' => 'mood',