nextcloud/lib/public/Notification/INotifier.php

61 lines
1.6 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/>
2015-08-31 13:24:37 +03:00
*
*/
namespace OCP\Notification;
2015-08-31 13:24:37 +03:00
/**
* Interface INotifier
*
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
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;
2015-08-31 13:24:37 +03:00
/**
* @param INotification $notification
2015-09-01 11:20:54 +03:00
* @param string $languageCode The code of the language that should be used to prepare the notification
2015-08-31 13:24:37 +03:00
* @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
2016-01-22 12:51:36 +03:00
* @since 9.0.0
2015-08-31 13:24:37 +03:00
*/
public function prepare(INotification $notification, string $languageCode): INotification;
2015-08-31 13:24:37 +03:00
}