aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Federation/ICloudFederationNotification.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Federation/ICloudFederationNotification.php')
-rw-r--r--lib/public/Federation/ICloudFederationNotification.php36
1 files changed, 36 insertions, 0 deletions
diff --git a/lib/public/Federation/ICloudFederationNotification.php b/lib/public/Federation/ICloudFederationNotification.php
new file mode 100644
index 00000000000..c550a936927
--- /dev/null
+++ b/lib/public/Federation/ICloudFederationNotification.php
@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCP\Federation;
+
+/**
+ * Interface ICloudFederationNotification
+ *
+ *
+ * @since 14.0.0
+ */
+interface ICloudFederationNotification {
+ /**
+ * add a message to the notification
+ *
+ * @param string $notificationType (e.g. SHARE_ACCEPTED)
+ * @param string $resourceType (e.g. file, calendar, contact,...)
+ * @param string $providerId id of the share
+ * @param array $notification payload of the notification
+ *
+ * @since 14.0.0
+ */
+ public function setMessage($notificationType, $resourceType, $providerId, array $notification);
+
+ /**
+ * get message, ready to send out
+ *
+ * @return array
+ *
+ * @since 14.0.0
+ */
+ public function getMessage();
+}