diff options
author | Joas Schilling <coding@schilljs.com> | 2016-10-25 19:00:25 +0300 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2016-11-16 11:25:44 +0300 |
commit | 13ff56bfc583fc983276e38ba239ccc7a14a4f33 (patch) | |
tree | 01e6c6cb86a5b2bcfe4545feecf4d2475f9121e4 /lib/public/Activity | |
parent | 0d940e581a38735497784b76c1321001493e5290 (diff) |
Allow to register settings/types via info.xml
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'lib/public/Activity')
-rw-r--r-- | lib/public/Activity/IManager.php | 23 | ||||
-rw-r--r-- | lib/public/Activity/ISetting.php | 76 |
2 files changed, 99 insertions, 0 deletions
diff --git a/lib/public/Activity/IManager.php b/lib/public/Activity/IManager.php index 387a1d85144..ded83bcc922 100644 --- a/lib/public/Activity/IManager.php +++ b/lib/public/Activity/IManager.php @@ -132,6 +132,27 @@ interface IManager { public function getFilterById($id); /** + * @param string $setting Class must implement OCA\Activity\ISetting + * @return void + * @since 9.2.0 + */ + public function registerSetting($setting); + + /** + * @return ISetting[] + * @since 9.2.0 + */ + public function getSettings(); + + /** + * @param string $id + * @return ISetting + * @throws \InvalidArgumentException when the setting was not found + * @since 9.2.0 + */ + public function getSettingById($id); + + /** * Will return additional notification types as specified by other apps * * @param string $languageCode @@ -141,6 +162,7 @@ interface IManager { * 'methods' => [\OCP\Activity\IExtension::METHOD_*], * ] * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods + * @deprecated 9.2.0 - Use getSettings() instead */ public function getNotificationTypes($languageCode); @@ -148,6 +170,7 @@ interface IManager { * @param string $method * @return array * @since 8.0.0 + * @deprecated 9.2.0 - Use getSettings()->isDefaulEnabled<method>() instead */ public function getDefaultTypes($method); diff --git a/lib/public/Activity/ISetting.php b/lib/public/Activity/ISetting.php new file mode 100644 index 00000000000..b90616e825c --- /dev/null +++ b/lib/public/Activity/ISetting.php @@ -0,0 +1,76 @@ +<?php +/** + * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * 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 + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +namespace OCP\Activity; + +/** + * Interface ISetting + * + * @package OCP\Activity + * @since 9.2.0 + */ +interface ISetting { + + /** + * @return string Lowercase a-z and underscore only identifier + * @since 9.2.0 + */ + public function getIdentifier(); + + /** + * @return string A translated string + * @since 9.2.0 + */ + public function getName(); + + /** + * @return int whether the filter should be rather on the top or bottom of + * the admin section. The filters are arranged in ascending order of the + * priority values. It is required to return a value between 0 and 100. + * @since 9.2.0 + */ + public function getPriority(); + + /** + * @return bool True when the option can be changed for the stream + * @since 9.2.0 + */ + public function canChangeStream(); + + /** + * @return bool True when the option can be changed for the stream + * @since 9.2.0 + */ + public function isDefaultEnabledStream(); + + /** + * @return bool True when the option can be changed for the mail + * @since 9.2.0 + */ + public function canChangeMail(); + + /** + * @return bool True when the option can be changed for the stream + * @since 9.2.0 + */ + public function isDefaultEnabledMail(); +} + |