You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 lines
1.6 KiB
59 lines
1.6 KiB
<?php |
|
declare(strict_types=1); |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Joas Schilling <coding@schilljs.com> |
|
* |
|
* @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; |
|
|
|
/** |
|
* Interface INotifier |
|
* |
|
* @package OCP\Notification |
|
* @since 9.0.0 |
|
*/ |
|
interface INotifier { |
|
|
|
/** |
|
* Identifier of the notifier, only use [a-z0-9_] |
|
* |
|
* @return string |
|
* @since 17.0.0 |
|
*/ |
|
public function getID(): string; |
|
|
|
/** |
|
* Human readable name describing the notifier |
|
* |
|
* @return string |
|
* @since 17.0.0 |
|
*/ |
|
public function getName(): string; |
|
|
|
/** |
|
* @param INotification $notification |
|
* @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 |
|
* @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted |
|
* @since 9.0.0 |
|
*/ |
|
public function prepare(INotification $notification, string $languageCode): INotification; |
|
}
|
|
|