Adjust the since on the interface
This commit is contained in:
Joas Schilling
parent
ee02165005
commit
9ea7ae6f87
|
|
@ -25,20 +25,20 @@ namespace OCP\Notification;
|
|||
* Interface IAction
|
||||
*
|
||||
* @package OCP\Notification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
interface IAction {
|
||||
/**
|
||||
* @param string $label
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the label is invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setLabel($label);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getLabel();
|
||||
|
||||
|
|
@ -46,13 +46,13 @@ interface IAction {
|
|||
* @param string $label
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the label is invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setParsedLabel($label);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getParsedLabel();
|
||||
|
||||
|
|
@ -75,31 +75,31 @@ interface IAction {
|
|||
* @param string $requestType
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the link is invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setLink($link, $requestType);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getLink();
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getRequestType();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function isValid();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function isValidParsed();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,28 +25,28 @@ namespace OCP\Notification;
|
|||
* Interface IApp
|
||||
*
|
||||
* @package OCP\Notification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
interface IApp {
|
||||
/**
|
||||
* @param INotification $notification
|
||||
* @return null
|
||||
* @throws \InvalidArgumentException When the notification is not valid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function notify(INotification $notification);
|
||||
|
||||
/**
|
||||
* @param INotification $notification
|
||||
* @return null
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function markProcessed(INotification $notification);
|
||||
|
||||
/**
|
||||
* @param INotification $notification
|
||||
* @return int
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getCount(INotification $notification);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,14 +25,14 @@ namespace OCP\Notification;
|
|||
* Interface IManager
|
||||
*
|
||||
* @package OCP\Notification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
interface IManager extends IApp, INotifier {
|
||||
/**
|
||||
* @param \Closure $service The service must implement IApp, otherwise a
|
||||
* \InvalidArgumentException is thrown later
|
||||
* @return null
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function registerApp(\Closure $service);
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ interface IManager extends IApp, INotifier {
|
|||
* @param \Closure $info An array with the keys 'id' and 'name' containing
|
||||
* the app id and the app name
|
||||
* @return null
|
||||
* @since 8.2.0 - Parameter $info was added in 9.0.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function registerNotifier(\Closure $service, \Closure $info);
|
||||
|
||||
|
|
@ -54,13 +54,13 @@ interface IManager extends IApp, INotifier {
|
|||
|
||||
/**
|
||||
* @return INotification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function createNotification();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function hasNotifiers();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,20 +25,20 @@ namespace OCP\Notification;
|
|||
* Interface INotification
|
||||
*
|
||||
* @package OCP\Notification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
interface INotification {
|
||||
/**
|
||||
* @param string $app
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the app id are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setApp($app);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getApp();
|
||||
|
||||
|
|
@ -46,13 +46,13 @@ interface INotification {
|
|||
* @param string $user
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the user id are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setUser($user);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getUser();
|
||||
|
||||
|
|
@ -75,19 +75,19 @@ interface INotification {
|
|||
* @param string $id
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the object type or id is invalid
|
||||
* @since 8.2.0 - 9.0.0: Type of $id changed to string
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setObject($type, $id);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getObjectType();
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0 - 9.0.0: Return type changed to string
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getObjectId();
|
||||
|
||||
|
|
@ -96,19 +96,19 @@ interface INotification {
|
|||
* @param array $parameters
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the subject or parameters are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setSubject($subject, array $parameters = []);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getSubject();
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getSubjectParameters();
|
||||
|
||||
|
|
@ -116,13 +116,13 @@ interface INotification {
|
|||
* @param string $subject
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the subject are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setParsedSubject($subject);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getParsedSubject();
|
||||
|
||||
|
|
@ -131,19 +131,19 @@ interface INotification {
|
|||
* @param array $parameters
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the message or parameters are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setMessage($message, array $parameters = []);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getMessage();
|
||||
|
||||
/**
|
||||
* @return string[]
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getMessageParameters();
|
||||
|
||||
|
|
@ -151,13 +151,13 @@ interface INotification {
|
|||
* @param string $message
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the message are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setParsedMessage($message);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getParsedMessage();
|
||||
|
||||
|
|
@ -165,19 +165,19 @@ interface INotification {
|
|||
* @param string $link
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the link are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function setLink($link);
|
||||
|
||||
/**
|
||||
* @return string
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getLink();
|
||||
|
||||
/**
|
||||
* @return IAction
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function createAction();
|
||||
|
||||
|
|
@ -185,13 +185,13 @@ interface INotification {
|
|||
* @param IAction $action
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the action are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function addAction(IAction $action);
|
||||
|
||||
/**
|
||||
* @return IAction[]
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getActions();
|
||||
|
||||
|
|
@ -199,25 +199,25 @@ interface INotification {
|
|||
* @param IAction $action
|
||||
* @return $this
|
||||
* @throws \InvalidArgumentException if the action are invalid
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function addParsedAction(IAction $action);
|
||||
|
||||
/**
|
||||
* @return IAction[]
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function getParsedActions();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function isValid();
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function isValidParsed();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace OCP\Notification;
|
|||
* Interface INotifier
|
||||
*
|
||||
* @package OCP\Notification
|
||||
* @since 8.2.0
|
||||
* @since 9.0.0
|
||||
*/
|
||||
interface INotifier {
|
||||
/**
|
||||
|
|
@ -33,7 +33,7 @@ interface INotifier {
|
|||
* @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
|
||||
* @since 9.0.0
|
||||
*/
|
||||
public function prepare(INotification $notification, $languageCode);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue