Represents an Aura component definition, such as component markup, a
client-side controller, or an event. This object is available in API version 32.0 and
later. Available in API version 32.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
| AuraDefinitionBundleId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The ID of the
bundle containing the definition. A bundle contains
a Lightning definition and all its related
resources.
|
| DefType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist,
Sort, Update
- Description
-
The definition type. Valid
values are:
-
APPLICATION — Lightning Aura Components
app
-
CONTROLLER — client-side controller
-
COMPONENT
— component markup
-
EVENT —
event definition
-
HELPER —
client-side helper
-
INTERFACE
— interface definition
-
RENDERER
— client-side renderer
-
STYLE —
style (CSS) resource
-
PROVIDER
— reserved for future use
-
MODEL —
deprecated, do not use
-
TESTSUITE
— reserved for future use
-
DOCUMENTATION — documentation
markup
-
TOKENS —
tokens collection
-
DESIGN —
design definition
-
SVG — SVG
graphic resource
|
| Format |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- The format of the definition. Valid values are:
-
XML for
component markup
-
JS for
JavaScript code
-
CSS for
styles
|
| 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.
|
j