メタデータ API 開発者ガイド
jAuraDefinitionBundle
Lightning 定義バンドルを表します。バンドルには、Lightning 定義とそれに関連するすべてのリソースが含まれます。定義には、コンポーネント、アプリケーション、イベント、インターフェース、トークンコレクションを使用できます。
ファイルのサフィックスおよびディレクトリの場所
Lightning バンドルは、定義ファイルが含まれるフォルダです。他のメタデータコンポーネントと異なり、AuraDefinitionBundle コンポーネントは 1 つのコンポーネントファイルでは表されず、コンポーネント定義ファイルのコレクションで表されます。各定義ファイルは、マークアップ、アプリケーション、コードファイル (コントローラとヘルパーを含む)、イベント、ドキュメント、インターフェースなど、バンドル内のリソースを表します。たとえば、次のディレクトリ構造は、bundle1 と bundle2 という 2 つのバンドルのフォルダおよびファイルの階層を示します。
Lightning バンドルは、aura という名前の最上位フォルダの下に配置する必要があります。各バンドルには、aura フォルダの下に独自のサブフォルダが必要です。各定義ファイルの名前は、バンドル名で開始する必要があります。
バンドルにはサフィックスはありません。定義ファイルには、次のいずれかのサフィックスを使用できます。
| サフィックス | コンポーネントの種類 |
|---|---|
| .app | アプリケーション |
| .cmp | コンポーネント |
| .design | 設計 |
| .evt | イベント |
| .intf | インターフェース |
| .js | コントローラ、ヘルパー、またはレンダラ |
| .svg | SVG 画像 |
| .css | スタイル |
| .auradoc | ドキュメント |
| .tokens | トークンコレクション |
各バンドルには、サフィックスがそれぞれ .app、.cmp、.design、.evt、.intf、または .tokens のファイルを 1 つのみ使用できます。
バージョン
AuraDefinitionBundle コンポーネントは、API バージョン 32.0 以降で使用できます。
設計コンポーネントと SVG コンポーネントは、API バージョン 33.0 以降で使用できます。
特別なアクセスルール
定義は、名前空間が定義されている組織でのみ作成できます。
項目
| 項目名 | データ型 | 説明 |
|---|---|---|
| apiVersion | double | この定義バンドルの API バージョン。Aura バンドルを作成するとき、保存に使用する API バージョンを指定できます。API バージョン 35.0 以降で使用できます。 |
| controllerContent | base64Binary | JavaScript のクライアント側コントローラの内容。 |
| description | string | Aura バンドルの仕様。API バージョン 35.0 以降で使用できます。 |
| designContent | base64Binary | 設計定義の内容。コンポーネントバンドル内部でのみ有効です。 |
| documentationContent | base64Binary | ドキュメント定義の内容。 |
| helperContent | base64Binary | JavaScript ヘルパーの内容。 |
| markup | base64Binary | 定義のマークアップの内容。 |
| modelContent | base64Binary | 非推奨。使用しません。 |
| packageVersions | PackageVersion[] | この Aura 定義バンドルによって参照される、インストール済みの管理パッケージバージョンのリスト。API バージョン 35.0 以降で使用できます。 |
| rendererContent | base64Binary | JavaScript のクライアント側レンダラの内容。 |
| styleContent | base64Binary | 定義の CSS。 |
| SVGContent | base64Binary | 定義の SVG 画像。 |
| testsuiteContent | base64Binary | 将来の使用のために予約されています。 |
| type | AuraBundleType (string 型の列挙) | 定義種別。有効な値は、次のとおりです。
|