getListInfosByObjectName
Use this wire to get the list views associated with a supported object.
See Get List Views for an Object.
objectApiName
—(Required) The API name of a supported objectpageSize
—The number of list records viewed at one time. The default value is 20. Valid values are 1–2000.pageToken
—A token that represents the page offset. To indicate where the page starts, use this value with thepageSize
parameter. The maximum offset is 2000, and the default is 0.q
—A search term to filter the results. Wildcards are supported.recentListsOnly
—Indicates whether to get recent lists only (true
) or not (false
). The default isfalse
.
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.
data
–List Info Summary Collectionerror
–FetchResponse
This code example fetches the list of list views for an object and displays the list view labels.
See Also
- Understand the Wire Service
- Handle Errors in Lightning Data Service
- Salesforce Objects Supported by lightning/ui*Api Modules