Expand the doc blocks on the new methods
This commit is contained in:
parent
6697844c01
commit
c58316b1ae
2 changed files with 32 additions and 0 deletions
|
@ -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
|
||||
*/
|
||||
public function generateEvent() {
|
||||
|
@ -136,6 +145,12 @@ class ActivityManager implements IManager {
|
|||
/**
|
||||
* 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
|
||||
* @throws \BadMethodCallException if required values have not been set
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue