Salesforce Docs Portal

Tab Refreshed

lightning:tabRefreshed

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

For Use In

Lightning Experience

::::::tabset{tabs='[ "Develop", "Specifications"]'}

:::::tab

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.

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

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

({
  onTabRefreshed: function (component, event, helper) {
    var refreshedTabId = event.getParam("tabId");
    var workspaceAPI = component.find("workspace");
    workspaceAPI.getTabInfo({
      tabId: refreshedTabId,
      callback: function (error, response) {
        console.log(response);
      },
    });
  },
});

For more information, see the Salesforce Console Developer Guide.

:::::

:::::tab

Attributes

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

:::::

::::::