Expand the doc blocks on the new methods

This commit is contained in:
Joas Schilling 2015-08-20 15:35:24 +02:00
parent 6697844c01
commit c58316b1ae
2 changed files with 32 additions and 0 deletions

View File

@ -127,6 +127,15 @@ class ActivityManager implements 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 * @return IEvent
*/ */
public function generateEvent() { public function generateEvent() {
@ -136,6 +145,12 @@ class ActivityManager implements IManager {
/** /**
* Publish an event to the activity consumers * 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 * @param IEvent $event
* @return null * @return null
* @throws \BadMethodCallException if required values have not been set * @throws \BadMethodCallException if required values have not been set

View File

@ -39,12 +39,29 @@ namespace OCP\Activity;
*/ */
interface IManager { 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 * @return IEvent
* @since 8.2.0 * @since 8.2.0
*/ */
public function generateEvent(); 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 * @param IEvent $event
* @return null * @return null
* @since 8.2.0 * @since 8.2.0