afv-library/skills/platform-data-and-tooling-api-context-get/assets/tooling_api/LightningComponentBundle.json

{
  "sections": [
    "title",
    "description",
    "supported_soap_calls",
    "supported_rest_api_http_methods",
    "fields",
    "wsdl_segment"
  ],
  "title": "LightningComponentBundle - Tooling API",
  "description": "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_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
  "supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`, `DELETE`",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "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. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
    },
    "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": "If true, the component is available to other namespaces, including namespaces outside of a managed package. If true and TargetConfigs is present, the component is also available to Salesforce builders such as Lightning App Builder and Experience Builder. If false, the component isn't available to builders and other namespaces."
    },
    "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."
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"LightningComponentBundle\">\n  <xsd:complexContent>\n    <xsd:extension base=\"ens:sObject\">\n      <xsd:sequence>\n        <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n        <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:LightningComponentBundle\" nillable=\"true\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"LightningComponentBundle\">\n  <xsd:complexContent>\n    <xsd:extension base=\"mns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"ai\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n        <xsd:element name=\"apiVersion\" minOccurs=\"0\" type=\"xsd:double\"/>\n        <xsd:element name=\"capabilities\" minOccurs=\"0\" type=\"mns:Capabilities\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"isExplicitImport\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"isExposed\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"lwcResources\" minOccurs=\"0\" type=\"mns:LwcResources\"/>\n        <xsd:element name=\"masterLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"runtimeNamespace\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"targetConfigs\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n        <xsd:element name=\"targets\" minOccurs=\"0\" type=\"mns:Targets\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```"
}