server/lib/private/notification/iaction.php

110 lines
2.3 KiB
PHP
Raw Normal View History

2015-08-31 10:24:37 +00:00
<?php
/**
* @author Joas Schilling <nickvergessen@owncloud.com>
*
* @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 <http://www.gnu.org/licenses/>
*
*/
namespace OC\Notification;
2015-08-31 10:24:37 +00:00
/**
* Interface IAction
*
* @package OC\Notification
2015-08-31 10:24:37 +00:00
* @since 8.2.0
2015-08-31 10:27:06 +00:00
*
* 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.
2015-08-31 10:24:37 +00:00
*/
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();
2015-11-16 15:14:52 +00:00
/**
* @param $primary bool
* @return $this
2015-11-16 15:14:52 +00:00
* @throws \InvalidArgumentException if $primary is invalid
* @since 9.0.0
*/
public function setPrimary($primary);
/**
* @return bool
* @since 9.0.0
*/
public function isPrimary();
2015-08-31 10:24:37 +00:00
/**
* @param string $link
2015-09-01 08:46:08 +00:00
* @param string $requestType
2015-08-31 10:24:37 +00:00
* @return $this
* @throws \InvalidArgumentException if the link is invalid
* @since 8.2.0
*/
2015-09-01 08:46:08 +00:00
public function setLink($link, $requestType);
2015-08-31 10:24:37 +00:00
/**
* @return string
* @since 8.2.0
*/
public function getLink();
2015-09-01 10:09:39 +00:00
/**
* @return string
* @since 8.2.0
*/
public function getRequestType();
2015-08-31 10:24:37 +00:00
/**
* @return bool
2015-09-03 10:12:10 +00:00
* @since 8.2.0
2015-08-31 10:24:37 +00:00
*/
public function isValid();
/**
* @return bool
2015-09-03 10:12:10 +00:00
* @since 8.2.0
2015-08-31 10:24:37 +00:00
*/
public function isValidParsed();
}