Newer Version Available

This content describes an older version of this product. View Latest

LightningComponentResource

Represents a Lightning web component resource, such as HTML markup, JavaScript code, a CSS file, an SVG resource, or an XML configuration file. Available in API version 45.0 and later.

Supported SOAP API Calls

create()delete()describeSObjects()query()retrieve()update()upsert()

Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

Special Access Rules

As of Summer ’20 and later, only your Salesforce org's internal users can access this object.

Fields

Field Name Details
FilePath
Type
string
Properties
Create,Filter, Group, Sort,Update
Description
The path to the resource.
Format
Type
picklist
Properties
Create, Filter Group, Restricted picklist, Sort, Update
Description
The format of the resource. The possible values are:
  • css
  • html
  • js
  • json
  • svg
  • xml
LightningComponentBundleId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the bundle containing the resource.
ManageableState
Type
ManageableState enumerated list
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package:
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged

This field is available in API version 38.0 and later.

Source
Type
textarea
Properties
Create, Update
Description
The contents of the definition. This is all the markup or code for the definition.

Usage

For more information about Lightning web components, see Lightning Web Components Developer Guide.