lightning__tabRefreshed
A Lightning message channel that corresponds to the lightning:tabRefreshed Aura app event. This message channel is available for
Lightning web components used within a Lightning console app.
Response
The response is the same as that of the lightning:tabRefreshed Aura app event.
LWC Example
Import the lightning__tabRefreshed message channel from the @salesforce/messageChannel/ scoped module. The event returns the message in the response.
import { LightningElement, track, wire } from "lwc";
import { MessageContext, subscribe, unsubscribe, APPLICATION_SCOPE } from "lightning/messageService";
import tabRefreshedChannel from "@salesforce/messageChannel/lightning__tabRefreshed";
export default class TabRefreshedExample extends LightningElement {
subscription = null;
@wire(MessageContext) messageContext;
// Encapsulate logic for Lightning message service subscribe and unsubscribe
subscribeToMessageChannel() {
if (!this.subscription) {
this.subscription = subscribe(
this.messageContext,
tabRefreshedChannel,
(message) => this.handleMessage(message),
{ scope: APPLICATION_SCOPE }
);
}
}
unsubscribeToMessageChannel() {
unsubscribe(this.subscription);
this.subscription = null;
}
// Handler for message received by component
handleMessage(message) {
// do something
}
// Standard lifecycle hooks used to subscribe and unsubscribe to the message channel
connectedCallback() {
this.subscribeToMessageChannel();
}
disconnectedCallback() {
this.unsubscribeToMessageChannel();
}
For more information, see Subscribe and Unsubscribe from a Message Channel.