nextcloud-server/lib/public/Dashboard/IIconWidget.php

<?php

declare(strict_types=1);
/**
 * @copyright Copyright (c) 2022 Robin Appelman <robin@icewind.nl>
 *
 * @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;

/**
 * Allow getting the absolute icon url for a widget
 *
 * @since 25.0.0
 */
interface IIconWidget extends IWidget {
	/**
	 * Get the absolute url for the widget icon (should be colored black or not have a color)
	 *
	 * The icon will be inverted automatically in mobile clients and when using dark mode
	 *
	 * @return string
	 * @since 25.0.0
	 */
	public function getIconUrl(): string;
}