getRelatedListInfoBatch

Use this wire adapter to get the metadata for a batch of RelatedLists.

See Get a Batch of Related List Metadata.

  • parentObjectApiName—(Required) The API name of a parent object that you want to get related lists for, like an Account.
  • relatedListNames—(Required) An array of comma-separated strings that contain the API names of supported related lists for the parent object such as Contacts, Opportunities, or Cases.

In the wire adapter code, relatedListNames maps to relatedListIds in the User Interface API resource.
  • recordTypeId—(Optional) The ID of the parent record type. If not provided, the default record type is used.

This code example fetches the metadata for the Contacts and Opportunities related lists in the Account object, then iterates through the list of display columns.

See Also