From 38001d824b142ca9c47f2afafce91ab8b76f1a9a Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Tue, 8 Sep 2015 08:57:29 +0200 Subject: Move interfaces to private until they are no longer experimental --- lib/private/notification/iaction.php | 109 +++++++++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 lib/private/notification/iaction.php (limited to 'lib/private/notification/iaction.php') diff --git a/lib/private/notification/iaction.php b/lib/private/notification/iaction.php new file mode 100644 index 00000000000..da6728f5c52 --- /dev/null +++ b/lib/private/notification/iaction.php @@ -0,0 +1,109 @@ + + * + * @copyright Copyright (c) 2015, ownCloud, Inc. + * @license AGPL-3.0 + * + * This code is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License, version 3, + * as published by the Free Software Foundation. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License, version 3, + * along with this program. If not, see + * + */ + +namespace OC\Notification; + +/** + * Interface IAction + * + * @package OC\Notification + * @since 8.2.0 + * + * DEVELOPER NOTE: + * The notification api is experimental only in 8.2.0! Do not start using it, + * if you can not prepare an update for the next version afterwards. + */ +interface IAction { + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setLabel($label); + + /** + * @return string + * @since 8.2.0 + */ + public function getLabel(); + + /** + * @param string $label + * @return $this + * @throws \InvalidArgumentException if the label is invalid + * @since 8.2.0 + */ + public function setParsedLabel($label); + + /** + * @return string + * @since 8.2.0 + */ + public function getParsedLabel(); + + /** + * @param string $link + * @param string $requestType + * @return $this + * @throws \InvalidArgumentException if the link is invalid + * @since 8.2.0 + */ + public function setLink($link, $requestType); + + /** + * @return string + * @since 8.2.0 + */ + public function getLink(); + + /** + * @return string + * @since 8.2.0 + */ + public function getRequestType(); + + /** + * @param string $icon + * @return $this + * @throws \InvalidArgumentException if the icon is invalid + * @since 8.2.0 + */ + public function setIcon($icon); + + /** + * @return string + * @since 8.2.0 + */ + public function getIcon(); + + /** + * @return bool + * @since 8.2.0 + */ + public function isValid(); + + /** + * @return bool + * @since 8.2.0 + */ + public function isValidParsed(); +} -- cgit v1.2.3