lightning/stateManagerRelatedListInfo

This state manager gets the metadata for a RelatedList.

Related list details depend on the parent object developer (API) name, related list ID, and optionally the record type.

setConfig()

Provide the entire configuration as an object. This function is equivalent to the factory function when you create the state manager.

setParentObjectApiName()

Set the parent object API (developer) name.

setRelatedListId()

Set the API name of a related list object, such as Contacts, Opportunities, or Cases.

setRecordTypeId()

Set the ID of the parent record type. If not provided, the default record type is used.

status

The current status of the state manager. See status for details.

data

When status is "loaded", a Related List Info.

error

When status is "error", this property contains details. See error for details.

See Also

• getRelatedListInfo wire adapter
• User Interface API Developer Guide: Get Related List Metadata