summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorJoas Schilling <nickvergessen@owncloud.com>2015-08-20 15:35:24 +0200
committerJoas Schilling <nickvergessen@owncloud.com>2015-08-20 15:35:24 +0200
commitc58316b1ae2657fca041d8ff40499bd4e19ba79a (patch)
tree6c59e97965229146c0735b781f28f8191334530f /lib/public
parent6697844c01b06e2232cdc246a3ef789a04bb2e01 (diff)
downloadnextcloud-server-c58316b1ae2657fca041d8ff40499bd4e19ba79a.tar.gz
nextcloud-server-c58316b1ae2657fca041d8ff40499bd4e19ba79a.zip
Expand the doc blocks on the new methods
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/activity/imanager.php17
1 files changed, 17 insertions, 0 deletions
diff --git a/lib/public/activity/imanager.php b/lib/public/activity/imanager.php
index c3818234f79..b3a4969fb06 100644
--- a/lib/public/activity/imanager.php
+++ b/lib/public/activity/imanager.php
@@ -39,12 +39,29 @@ namespace OCP\Activity;
*/
interface IManager {
/**
+ * Generates a new IEvent object
+ *
+ * Make sure to call at least the following methods before sending it to the
+ * app with via the publish() method:
+ * - setApp()
+ * - setType()
+ * - setAffectedUser()
+ * - setSubject()
+ *
* @return IEvent
* @since 8.2.0
*/
public function generateEvent();
/**
+ * Publish an event to the activity consumers
+ *
+ * Make sure to call at least the following methods before sending an Event:
+ * - setApp()
+ * - setType()
+ * - setAffectedUser()
+ * - setSubject()
+ *
* @param IEvent $event
* @return null
* @since 8.2.0