Refreshing

Disabled by default, set the refresh parameters on the component.

Note: You should only enable one of the following methods on the component.

#setRefreshTime

Set the amount of time in milliseconds as a refresh interval.

1public function configure(): void
2{
3    $this->setRefreshTime(2000); // Component refreshes every 2 seconds
4}

#setRefreshKeepAlive

Keep polling when the tab with the component is in the background.

1public function configure(): void
2{
3    $this->setRefreshKeepAlive();
4}

#setRefreshVisible

Only refresh the component when it is visible.

1public function configure(): void
2{
3    $this->setRefreshVisible();
4}

#setRefreshMethod

Fire a specific action when polling. This is only necessary when you wish to call additional actions on each refresh. You must have a public function with the same name as the refresh method.

1public function configure(): void
2{
3    $this->setRefreshMethod('refreshTable');
4}
5 
6public function refreshTable()
7{
8    // Custom Code Here
9}