メタデータ API 開発者ガイド
jActionOverride
標準オブジェクトまたはカスタムオブジェクトの override アクションを表します。これを使用して、override アクションを作成、更新、編集、または削除します。ActionOverride には、これを含む CustomObject にアクセスすることによってのみアクセスできます。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
override アクションは標準オブジェクトまたはカスタムオブジェクトの一部として定義されます。
バージョン
override アクションは、API バージョン 18.0 以降で使用できます。Summer ’13 以降では、override アクションを標準オブジェクトとカスタムオブジェクトの両方に適用できます。以前は、カスタムオブジェクトのみに適用できました。
項目
別途記載がない限り、すべての項目は作成可能、除外可能で、null にすることもできます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| actionName | string | 必須。使用できる値は、上書きできるアクションと同じです。
|
| comment | string | override に関連付けるすべてのコメント。 |
| content | string | flexipage、lightningcomponent、scontrol、または visualforce に type が設定されている場合は、この項目を設定します。override として使用する Lightning ページ、Lightning コンポーネント、Sコントロールまたは、Visualforce ページの名前を参照します。インストールされたコンポーネントを参照するには、Component_namespace__Component_name の形式を使用します。 |
| formFactor | FormFactor (string 型の列挙) |
上書きするページのサイズ。Large 値のみがサポートされています。他の値 (Small や Medium) は、将来の使用のために予約されています。 type 項目が flexipage に設定されている場合、この項目を Large に設定して [表示] アクションを Lightning Experience の Lightning ページで上書きします。 Large 値は Lightning Experience デスクトップ環境を表し、flexipage 型でのみ有効です。その他の型の場合、この項目のデフォルトは null です。 この項目は、API バージョン 37.0 以降で使用でき、Lightning Experience でのレコードページの作成と編集のための機能の一部です。 |
| skipRecordTypeSelect | boolean | この override アクションによって作成された新しいレコードをレコードタイプ選択ページに転送されないようにするには、この項目を true に設定します。この項目は、actionName が "create" 種別 (new など) で、type が visualforce に設定されている場合にのみ有効です。この項目は、API バージョン 21.0 以降で使用できます。 |
| type | ActionOverrideType(string 型の列挙) | 必須。override アクションの種別を表します。有効な値は、「ActionOverrideType」 に記述されています。 |
ActionOverrideType
ActionOverrideType は、使用する override アクションの種別を定義する string 型の列挙です。有効な値は、次のとおりです。
- default — override はインストールされたパッケージが提供するカスタム override を使用します。利用できるものがない場合、標準の Salesforce の動作が使用されます。
- flexipage — override は Lightning ページの動作を使用し、Lightning Experience の [表示] アクションでのみ有効です。
- lightningcomponent — override は Lightning コンポーネントの動作を使用します。
- scontrol — override は Sコントロールの動作を使用します。
- standard — override は通常の Salesforce の動作を使用します。
- visualforce — override は Visualforce ページの動作を使用します。
宣言的なメタデータの定義のサンプル
アクションを次のように定義することができます。
1<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
2 <actionOverrides>
3 <actionName>edit</actionName>
4 <type>visualforce</type>
5 <content>myEditVFPage</content>
6 <comment>This edit action is a lot safer.</comment>
7 </actionOverrides>
8</CustomObject>上記の定義では、retrieve() をコールすると次のコードが表示されます。
1<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
2 <actionOverrides>
3 <actionName>edit</actionName>
4 <type>default</type>
5 </actionOverrides>
6</CustomObject>1<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
2 <actionOverrides>
3 <actionName>edit</actionName>
4 <type>standard</type>
5 </actionOverrides>
6</CustomObject>Lightning Experience の [表示] 標準ボタンに Lightning ページアクション override を設定するには、次のコードを使用します。
1<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
2 <actionOverrides>
3 <actionName>View</actionName>
4 <content>myLightningPage</content>
5 <formFactor>Large</formFactor>
6 <type>flexipage</type>
7 </actionOverrides>
8</CustomObject>