メタデータ API 開発者ガイド
jApexPage
1 つの Visualforce ページを表します。詳細は、Salesforce オンラインヘルプの「Visualforce」を参照してください。MetadataWithContent メタデータ型を拡張し、その content 項目と fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
ページファイルのファイルサフィックスは、 .page です。付随するメタデータファイルには、PageName-meta.xml という名前が付けられます。
Visualforce ページは、対応するパッケージディレクトリの pages フォルダに保存されます。
バージョン
Visualforce ページは、API バージョン 11.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | データ型 | 説明 |
|---|---|---|
| apiVersion | double | 必須。このページの API バージョン。すべてのクラスには、作成時に指定された API バージョンが割り当てられています。この項目は API バージョン 15.0 以降で使用できます。この項目を 15.0 より小さい数値に設定すると、15.0 に変更されます。 |
| content | base64Binary | ページコンテンツ。Base 64 で符号化されたバイナリデータAPI コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、通常 SOAP クライアントによって処理されます。この項目は、MetadataWithContent コンポーネントから継承されます。 |
| description | string | ページが実行する内容の説明。 |
| fullName | string | API アクセスの一意の識別子として使用されるページの開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、Metadata コンポーネントから継承されています。 |
| availableInTouch | boolean | Visualforce ページに関連付けられている Visualforce タブを Salesforce1 アプリケーションで使用できるかどうかを示します(Salesforce Touch でのこの項目の使用は廃止されました)。この項目は、API バージョン 27.0 以降で使用できます。 Visualforce ページで上書きされる標準オブジェクトタブは、そのページにこの項目を設定しても、Salesforce1 でサポートされません。Visualforce ページの代わりに、オブジェクトのデフォルトの Salesforce1 ページが表示されます。 |
| confirmationTokenRequired | boolean |
ページの GET 要求に CSRF 確認トークンが必要かどうかを示します。この項目は API バージョン 28.0 以降で使用できます。 この項目の値を false から true に変更した場合は、ページへのリンクに CSRF トークンを追加しないとページにアクセスできなくなります。 |
| label | string | 必須。このページの表示ラベル。 |
| packageVersions | PackageVersion[] | この Visualforce ページによって参照される、インストールされた管理パッケージバージョンのリスト。 |
宣言的なメタデータの定義のサンプル
次のサンプルでは MyPage.page ページ、および対応する MyPage.page-meta.xml メタデータファイルを作成します。
SampleApexPage.page ファイル:
1<apex:page>
2<h1>Congratulations</h1>
3This is your new Page.
4</apex:page>SampleApexPage.page-meta.xml:
1<?xml version="1.0" encoding="UTF-8"?>
2<ApexPage xmlns="http://soap.sforce.com/2006/04/metadata">
3 <description>This is a sample Visualforce page.</description>
4 <label>SampleApexPage</label>
5</ApexPage>