Merge pull request #21238 from nextcloud/techdebt/noid/deferrable-notification-apps

Allow notification apps to defer and flush the sending

2 files changed, 65 insertions, 0 deletions

diff --git a/lib/public/Notification/IDeferrableApp.php b/lib/public/Notification/IDeferrableApp.php
new file mode 100644
index 00000000000..48ae7574192
--- /dev/null
+++ b/lib/public/Notification/IDeferrableApp.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020, Joas Schilling <coding@schilljs.com>
+ *
+ * @author Joas Schilling <coding@schilljs.com>
+ *
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP\Notification;
+
+/**
+ * Interface IDeferrableApp
+ *
+ * @package OCP\Notification
+ * @since 20.0.0
+ */
+interface IDeferrableApp extends IApp {
+	/**
+	 * Start deferring notifications until `flush()` is called
+	 *
+	 * @since 20.0.0
+	 */
+	public function defer(): void;
+
+	/**
+	 * Send all deferred notifications that have been stored since `defer()` was called
+	 *
+	 * @since 20.0.0
+	 */
+	public function flush(): void;
+}
diff --git a/lib/public/Notification/IManager.php b/lib/public/Notification/IManager.php
index 4acfa7ce786..dfc94c0be80 100644
--- a/lib/public/Notification/IManager.php
+++ b/lib/public/Notification/IManager.php
@@ -91,4 +91,21 @@ interface IManager extends IApp, INotifier {
 	 * @since 18.0.0
 	 */
 	public function dismissNotification(INotification $notification): void;
+
+	/**
+	 * Start deferring notifications until `flush()` is called
+	 *
+	 * The calling app should only "flush" when it got returned true on the defer call,
+	 * otherwise another app is deferring the sending already.
+	 * @return bool
+	 * @since 20.0.0
+	 */
+	public function defer(): bool;
+
+	/**
+	 * Send all deferred notifications that have been stored since `defer()` was called
+	 *
+	 * @since 20.0.0
+	 */
+	public function flush(): void;
 }