Tab Refreshed

lightning:tabRefreshed

Fires when a Console workspace or subtab has been successfully refreshed.

For Use In

Lightning Experience

lightning:tabRefreshed is an application event that indicates a tab has been refreshed successfully. This event is supported in Lightning console apps only.

Handle the event using aura:handler.

1<aura:component implements="flexipage:availableForAllPageTypes" access="global">
2  <lightning:workspaceAPI aura:id="workspace" />
3  <aura:handler event="lightning:tabRefreshed" action="{! c.onTabRefreshed }" />
4</aura:component>

In your client-side controller, retrieve the ID of the tab that’s refreshed.

1({
2  onTabRefreshed: function (component, event, helper) {
3    var refreshedTabId = event.getParam("tabId");
4    var workspaceAPI = component.find("workspace");
5    workspaceAPI.getTabInfo({
6      tabId: refreshedTabId,
7      callback: function (error, response) {
8        console.log(response);
9      },
10    });
11  },
12});

For more information, see the Salesforce Console Developer Guide.

Attributes

Name	Description	Type	Default	Required
`tabId`	The currently refreshed tab ID.	string

Tab Refreshed

Attributes

Lightning Component Reference