`getListInfoByName`

Use this wire adapter to get the metadata for a list view.

Parameter Name	Type	Description	Required?
`objectApiName`	String	The API name of a supported object.
`listViewApiName`	String	The API name of a list view, such as `AllAccounts`.

Read the data that's returned by the wire adapter using a property or function.

propertyOrFunction—A private property or function that receives the stream of data from the wire service.

If a property is decorated with @wire, the results are returned to the property’s data property or error property.
If a function is decorated with @wire, the results are returned in an object with a data property and an error property.

This code example fetches the List Info by API name, then iterates through the list of display columns in the List Info.

To retrieve metadata for a batch of list views, use getListInfosByName instead.

See Also