getListInfosByName
Use this wire adapter to get the metadata for a batch of list views.
See Get a Batch of List View Metadata.
Parameter Name | Type | Description | Required? |
---|---|---|---|
names | String[] | An array of comma-separated strings of list view names. A list view name starts with an entity name, a dot, and then the name of the list view, like Account.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’sdata
property orerror
property. - If a function is decorated with
@wire
, the results are returned in an object with adata
property and anerror
property.
- A
results
object with Simplified Batch Results and status codes. error
—FetchResponse
This code example fetches the list information by API name, then iterates through the list of display columns in the list information.
To retrieve metadata for a single list view, use getListInfoByName instead.