nextcloud/lib/public/Dashboard/Service/IWidgetsService.php

<?php

declare(strict_types=1);

/**
 * @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
 *
 * @author 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;
}