nextcloud/lib/public/Notification/IAction.php

130 lines
2.5 KiB
PHP
Raw Normal View History

2015-08-31 13:24:37 +03:00
<?php
declare(strict_types=1);
2015-08-31 13:24:37 +03:00
/**
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2016-07-21 18:07:57 +03:00
*
* @author Joas Schilling <coding@schilljs.com>
*
2015-08-31 13:24:37 +03:00
* @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 OCP\Notification;
2015-08-31 13:24:37 +03:00
/**
* Interface IAction
*
* @package OCP\Notification
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
interface IAction {
/**
* @since 17.0.0
*/
public const TYPE_GET = 'GET';
/**
* @since 17.0.0
*/
public const TYPE_POST = 'POST';
/**
* @since 17.0.0
*/
public const TYPE_PUT = 'PUT';
/**
* @since 17.0.0
*/
public const TYPE_DELETE = 'DELETE';
/**
* @since 17.0.0
*/
public const TYPE_WEB = 'WEB';
2015-08-31 13:24:37 +03:00
/**
* @param string $label
* @return $this
* @throws \InvalidArgumentException if the label is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setLabel(string $label): IAction;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getLabel(): string;
2015-08-31 13:24:37 +03:00
/**
* @param string $label
* @return $this
* @throws \InvalidArgumentException if the label is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setParsedLabel(string $label): IAction;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getParsedLabel(): string;
2015-08-31 13:24:37 +03:00
2015-11-16 18:14:52 +03:00
/**
* @param bool $primary
* @return $this
2015-11-16 18:14:52 +03:00
* @throws \InvalidArgumentException if $primary is invalid
* @since 9.0.0
*/
public function setPrimary(bool $primary): IAction;
2015-11-16 18:14:52 +03:00
/**
* @return bool
* @since 9.0.0
*/
public function isPrimary(): bool;
2015-11-16 18:14:52 +03:00
2015-08-31 13:24:37 +03:00
/**
* @param string $link
2015-09-01 11:46:08 +03:00
* @param string $requestType
2015-08-31 13:24:37 +03:00
* @return $this
* @throws \InvalidArgumentException if the link is invalid
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function setLink(string $link, string $requestType): IAction;
2015-08-31 13:24:37 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function getLink(): string;
2015-08-31 13:24:37 +03:00
2015-09-01 13:09:39 +03:00
/**
* @return string
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-09-01 13:09:39 +03:00
*/
public function getRequestType(): string;
2015-09-01 13:09:39 +03:00
2015-08-31 13:24:37 +03:00
/**
* @return bool
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function isValid(): bool;
2015-08-31 13:24:37 +03:00
/**
* @return bool
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function isValidParsed(): bool;
2015-08-31 13:24:37 +03:00
}