summaryrefslogtreecommitdiffstats
path: root/lib/private/notification/inotifier.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/notification/inotifier.php')
-rw-r--r--lib/private/notification/inotifier.php43
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/private/notification/inotifier.php b/lib/private/notification/inotifier.php
new file mode 100644
index 00000000000..22531229e3f
--- /dev/null
+++ b/lib/private/notification/inotifier.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ *
+ * @copyright Copyright (c) 2015, ownCloud, Inc.
+ * @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 OC\Notification;
+
+/**
+ * Interface INotifier
+ *
+ * @package OC\Notification
+ * @since 8.2.0
+ *
+ * DEVELOPER NOTE:
+ * The notification api is experimental only in 8.2.0! Do not start using it,
+ * if you can not prepare an update for the next version afterwards.
+ */
+interface INotifier {
+ /**
+ * @param INotification $notification
+ * @param string $languageCode The code of the language that should be used to prepare the notification
+ * @return INotification
+ * @throws \InvalidArgumentException When the notification was not prepared by a notifier
+ * @since 8.2.0
+ */
+ public function prepare(INotification $notification, $languageCode);
+}