Newer Version Available

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

LightningComponentBundle

Represents a Lightning web component bundle. A bundle contains a Lightning web component and its related resources. 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

Fields

Field Name Details
ApiVersion
Type
double
Properties
Filter, Nillable, Sort
Description
The API version for this bundle. Every bundle has an API version specified at creation.
Description
Type
textarea
Properties
Filter, Group, Nillable, Sort
Description
The text description of the bundle. Maximum size of 255 characters.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the record in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated but you can supply your own value if you create the record using the API.

When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record.

Note

FullName
Type
string
Properties
Create, Group, Nillable
Description
The unique name used as the LightningComponentBundle identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
IsExplicitImport
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether imports between files are done explicitly by the developer (true) or implicitly by the framework (false).
IsExposed
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether a component is usable in a managed package (true) or not (false).
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
The language of the MasterLabel.
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
MasterLabel
Type
string
Properties
Filter, Group, Sort
Description
Master label for the Lightning bundle. This internal label doesn’t get translated.
Metadata
Type
mns:LightningComponentBundle
Properties
Create, Nillable, Update
Description
The LightningComponentBundle metadata.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values.

  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
TargetConfigs
Type
textarea
Properties
Nillable
Description
Configurations for each target. Each target is a Lightning page type that can be configured in Lightning App Builder.

Usage

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