diff options
Diffstat (limited to 'lib/public/Dashboard/IButtonWidget.php')
-rw-r--r-- | lib/public/Dashboard/IButtonWidget.php | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/lib/public/Dashboard/IButtonWidget.php b/lib/public/Dashboard/IButtonWidget.php new file mode 100644 index 00000000000..cc0297fe7bc --- /dev/null +++ b/lib/public/Dashboard/IButtonWidget.php @@ -0,0 +1,51 @@ +<?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; + +/** + * Adds a button to the dashboard api representation + * + * @since 25.0.0 + */ +interface IButtonWidget extends IWidget { + /** + * Get the absolute url for the button target + * + * @return string + */ + public function getButtonUrl(): string; + + /** + * Get the absolute url for the button icon + * + * @return string + */ + public function getButtonIconUrl(): ?string; + + /** + * Get the text to show in the button + * + * @return string + */ + public function getButtonText(): string; +} |