Nextcloud PHP API (master)

IButtonWidget extends IWidget

Adds a button to the dashboard api representation

Tags
since
25.0.0

Table of Contents

Methods

getIconClass()  : string
getId()  : string
getOrder()  : int
getTitle()  : string
getUrl()  : string|null
getWidgetButtons()  : array<string|int, WidgetButton>
Get the buttons to show on the widget
load()  : void
Execute widget bootstrap code like loading scripts and providing initial state

Methods

getIconClass()

public getIconClass() : string
Tags
since
20.0.0
Return values
string

css class that displays an icon next to the widget title

getId()

public getId() : string
Tags
since
20.0.0
Return values
string

Unique id that identifies the widget, e.g. the app id

getOrder()

public getOrder() : int
Tags
since
20.0.0
Return values
int

Initial order for widget sorting

getTitle()

public getTitle() : string
Tags
since
20.0.0
Return values
string

User facing title of the widget

getUrl()

public getUrl() : string|null
Tags
since
20.0.0
Return values
string|null

The absolute url to the apps own view

getWidgetButtons()

Get the buttons to show on the widget

public getWidgetButtons(string $userId) : array<string|int, WidgetButton>
Parameters
$userId : string
Tags
since
25.0.0
Return values
array<string|int, WidgetButton>

load()

Execute widget bootstrap code like loading scripts and providing initial state

public load() : void
Tags
since
20.0.0

        
On this page

Search results