getListObjectInfo
This wire adapter gets the metadata for a list view object.
See Get Metadata for a List View Object.
Parameter Name | Type | Description | Required? |
---|---|---|---|
objectApiName | String | The API name of a supported object. |
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 Object Infoerror
–FetchResponse
This code example fetches the list object info for an object and then displays the list of columns for the object.
See Also
- Understand the Wire Service
- Handle Errors in Lightning Data Service
- Salesforce Objects Supported by lightning/ui*Api Modules