Skip to content

Extend dashboard api to allow listing of widgets #33658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PVince81 merged 12 commits into from
Sep 16, 2022
Merged

Extend dashboard api to allow listing of widgets #33658

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0e59447
add dashboard api to list widgets
icewind1991 Aug 23, 2022
7f52a99
allow filtering dashboard items api by widgets
icewind1991 Aug 23, 2022
79adca6
allow adding button to dashboard api output
icewind1991 Aug 29, 2022
a3912e2
change widget button api to support multiple button types
icewind1991 Sep 1, 2022
845149b
add IItemOptionWidget to define some item-related parameters, only ge…
Sep 8, 2022
d9e75f0
move widget options into a Option class
icewind1991 Sep 13, 2022
8e2e3b4
implement IAPIWidget in user_status
Sep 7, 2022
500ba95
implement IButtonWidget and IIconWidget in user_status
Sep 7, 2022
9ba26ee
set round item icons for user status widget
icewind1991 Sep 13, 2022
da74da8
adjust empty array check
Sep 15, 2022
9c402eb
Add since tags
nickvergessen Sep 16, 2022
3009e02
Fix phpunit
nickvergessen Sep 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
implement IButtonWidget and IIconWidget in user_status 
Signed-off-by: Julien Veyssier <[email protected]>
  • Loading branch information
Julien Veyssier committed Sep 15, 2022
commit 500ba958f3ddfb203fae5638069e6631e054f084
24 changes: 21 additions & 3 deletions apps/user_status/lib/Dashboard/UserStatusWidget.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
use OCA\UserStatus\Service\StatusService;
use OCP\AppFramework\Services\IInitialState;
use OCP\Dashboard\IAPIWidget;
use OCP\Dashboard\IButtonWidget;
use OCP\Dashboard\IIconWidget;
use OCP\Dashboard\Model\WidgetItem;
use OCP\IDateTimeFormatter;
use OCP\IL10N;
Expand All @@ -44,7 +46,7 @@
*
* @package OCA\UserStatus
*/
class UserStatusWidget implements IAPIWidget {
class UserStatusWidget implements IAPIWidget, IButtonWidget, IIconWidget {
private IL10N $l10n;
private IDateTimeFormatter $dateTimeFormatter;
private IURLGenerator $urlGenerator;
Expand Down Expand Up @@ -108,6 +110,15 @@ public function getIconClass(): string {
return 'icon-user-status';
}

/**
* @inheritDoc
*/
public function getIconUrl(): string {
return $this->urlGenerator->getAbsoluteURL(
$this->urlGenerator->imagePath(Application::APP_ID, 'app.svg')
);
}

/**
* @inheritDoc
*/
Expand All @@ -123,7 +134,7 @@ public function load(): void {

$currentUser = $this->userSession->getUser();
if ($currentUser === null) {
$this->initialStateService->provideInitialState(Application::APP_ID, 'dashboard_data', []);
$this->initialStateService->provideInitialState('dashboard_data', []);
return;
}
$currentUserId = $currentUser->getUID();
Expand Down Expand Up @@ -175,7 +186,7 @@ public function getItems(string $userId, ?string $since = null, int $limit = 7):
$formattedDate = $this->dateTimeFormatter->formatTimeSpan($widgetData['timestamp']);
return new WidgetItem(
$widgetData['displayName'],
$widgetData['icon'] . ' ' . $widgetData['message'] . ', ' . $formattedDate,
$widgetData['icon'] . ($widgetData['icon'] ? ' ' : '') . $widgetData['message'] . ', ' . $formattedDate,
// https://nextcloud.local/index.php/u/julien
$this->urlGenerator->getAbsoluteURL(
$this->urlGenerator->linkToRoute('core.ProfilePage.index', ['targetUserId' => $widgetData['userId']])
Expand All @@ -187,4 +198,11 @@ public function getItems(string $userId, ?string $since = null, int $limit = 7):
);
}, $widgetItemsData);
}

/**
* @inheritDoc
*/
public function getWidgetButtons(string $userId): array {
return [];
}
}