nextcloud/lib/public/notification/inotifier.php

44 lines
1.4 KiB
PHP
Raw Normal View History

2015-08-31 13:24:37 +03: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 OCP\Notification;
/**
* Interface INotifier
*
* @package OCP\Notification
* @since 8.2.0
2015-08-31 13:27:06 +03: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 13:24:37 +03:00
*/
interface INotifier {
/**
* @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
* @since 8.2.0
*/
2015-09-01 11:20:54 +03:00
public function prepare(INotification $notification, $languageCode);
2015-08-31 13:24:37 +03:00
}