getListPreferences

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

See Get List View Preferences.

• objectApiName—(Required) The API name of a supported object.

• listViewApiName–(Required) 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.

• data–List Preferences
• error–FetchResponse

This code example fetches the preferences for a list view and displays the column widths for each displayed column.

See Also

• Understand the Wire Service
• Handle Errors in Lightning Data Service
• Salesforce Objects Supported by lightning/ui*Api Modules