Considerations for Using RefreshView API

Keep these considerations in mind when developing features that use RefreshView API.

  • Use RefreshView API when you work with Aura components or data from third parties. In those cases, components participating in RefreshView API can use notifyRecordUpdateAvailable(recordIds) or refreshApex or both to refresh data that they receive from Lightning Data Service.
  • Register the refresh() callback with lightning/refresh only for the components that you want to participate in the refresh.
  • Components aren’t responsible for refreshing their descendants — descendants must register their own callbacks to participate in refresh outside of normal value propagation.
  • To allow for scoped refresh trees, containers register similarly to components that want to refresh themselves.