diff options
author | Maxence Lange <maxence@artificial-owl.com> | 2018-10-15 19:25:09 +0200 |
---|---|---|
committer | Roeland Jago Douma <roeland@famdouma.nl> | 2018-10-15 19:59:27 +0200 |
commit | dfd4782dfc1f67b3e5fd6b515ac8ed5b49d87de1 (patch) | |
tree | cdd785d96a6a5d991dbbf491e13e1edbce88baa0 /lib/public/Dashboard/Service | |
parent | 11144aa614d00f097169eb004beced1592055c66 (diff) | |
download | nextcloud-server-dfd4782dfc1f67b3e5fd6b515ac8ed5b49d87de1.tar.gz nextcloud-server-dfd4782dfc1f67b3e5fd6b515ac8ed5b49d87de1.zip |
include dashboard into core
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
Merge remote-tracking branch 'origin/interface-dashboard' into interface-dashboard
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
moving data object to OCP
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
update autoload files
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
+@since
Signed-off-by: Maxence Lange <maxence@artificial-owl.com>
Diffstat (limited to 'lib/public/Dashboard/Service')
-rw-r--r-- | lib/public/Dashboard/Service/IEventsService.php | 94 | ||||
-rw-r--r-- | lib/public/Dashboard/Service/IWidgetsService.php | 62 |
2 files changed, 156 insertions, 0 deletions
diff --git a/lib/public/Dashboard/Service/IEventsService.php b/lib/public/Dashboard/Service/IEventsService.php new file mode 100644 index 00000000000..4262e235fd5 --- /dev/null +++ b/lib/public/Dashboard/Service/IEventsService.php @@ -0,0 +1,94 @@ +<?php +declare(strict_types=1); + + +/** + * Nextcloud - Dashboard App + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@artificial-owl.com> + * @copyright 2018, Maxence Lange <maxence@artificial-owl.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\Dashboard\Service; + + +use OCP\Dashboard\IDashboardManager; + +/** + * Interface IEventsService + * + * The Service is provided by the Dashboard app. The method in this interface + * are used by the IDashboardManager when creating push event. + * + * @since 15.0.0 + * + * @package OCP\Dashboard\Service + */ +interface IEventsService { + + + /** + * Create an event for a widget and an array of users. + * + * @see IDashboardManager::createUsersEvent + * + * @since 15.0.0 + * + * @param string $widgetId + * @param array $users + * @param array $payload + * @param string $uniqueId + */ + public function createUsersEvent(string $widgetId, array $users, array $payload, string $uniqueId); + + + /** + * Create an event for a widget and an array of groups. + * + * @see IDashboardManager::createGroupsEvent + * + * @since 15.0.0 + * + * @param string $widgetId + * @param array $groups + * @param array $payload + * @param string $uniqueId + */ + public function createGroupsEvent(string $widgetId, array $groups, array $payload, string $uniqueId); + + + /** + * Create a global event for all users that use a specific widget. + * + * @see IDashboardManager::createGlobalEvent + * + * @since 15.0.0 + * + * @param string $widgetId + * @param array $payload + * @param string $uniqueId + */ + public function createGlobalEvent(string $widgetId, array $payload, string $uniqueId); + + +} + diff --git a/lib/public/Dashboard/Service/IWidgetsService.php b/lib/public/Dashboard/Service/IWidgetsService.php new file mode 100644 index 00000000000..b9a4482b4fc --- /dev/null +++ b/lib/public/Dashboard/Service/IWidgetsService.php @@ -0,0 +1,62 @@ +<?php +declare(strict_types=1); + + +/** + * Nextcloud - Dashboard App + * + * This file is licensed under the Affero General Public License version 3 or + * later. See the COPYING file. + * + * @author Maxence Lange <maxence@artificial-owl.com> + * @copyright 2018, Maxence Lange <maxence@artificial-owl.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\Dashboard\Service; + + +use OCP\Dashboard\Model\IWidgetConfig; + +/** + * Interface IWidgetsService + * + * The Service is provided by the Dashboard app. The method in this interface + * are used by the IDashboardManager when a widget needs to access the current + * configuration of a widget for a user. + * + * @since 15.0.0 + * + * @package OCP\Dashboard\Service + */ +interface IWidgetsService { + + /** + * Returns the IWidgetConfig for a widgetId and userId + * + * @since 15.0.0 + * + * @param string $widgetId + * @param string $userId + * + * @return IWidgetConfig + */ + public function getWidgetConfig(string $widgetId, string $userId): IWidgetConfig; + +} + |