メタデータ API 開発者ガイド
jScontrol
MetadataWithContent メタデータ型を拡張し、その content 項目と fullName 項目を継承します。
宣言的なメタデータファイルのサフィックスおよびディレクトリの場所
Sコントロールファイルのファイルサフィックスは .scf です。付随するメタデータファイルには、ScontrolName-meta.xml という名前が付けられます。
Scontrol コンポーネントは、対応するパッケージディレクトリの scontrols フォルダーに保存されます。
バージョン
Sコントロールは、API バージョン 10.0 以降で使用できます。
項目
このメタデータ型には、次の項目が含まれます。
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| content | base64Binary | Sコントロールのコンテンツ。Base 64 で符号化されたバイナリデータ。API コールを行う前に、クライアントアプリケーションはバイナリ添付データを base64 に符号化する必要があります。応答を受信したら、クライアントアプリケーションは、base64 データをバイナリに復号化する必要があります。この変換は、SOAP クライアントによって処理されます。この項目は、MetadataWithContent コンポーネントから継承されます。 |
| contentSource | SControlContentSource (string 型の列挙) | 必須。Sコントロールの使用目的を判断します。 |
| description | string | Sコントロールを説明するテキストです (省略可能)。これは「すべてのデータの参照」権限を持つユーザー (システム管理者) にのみ表示されます。 |
| encodingKey | Encoding (string 型の列挙) | 必須。デフォルトの文字コード設定は Unicode (UTF-8) です。情報を渡す URL が別形式のデータを必要とする場合は、この設定を変更します。このオプションは、contentSource の値として URL を選択すると使用できます。 |
| fileContent | base64 | この Sコントロールをカスタムリンクに追加した場合に表示されるファイルの内容。ファイルには、Java アプレット、Active-X コントロール、またはその他の任意のコンテンツを含めることができます。このオプションは、contentSource の値が HTML の Sコントロールにのみ適���されます。 |
| fileName | string | Sコントロールにつける一意の名前です。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目は、管理パッケージによってインストールされたコンポーネントでは変更できません。fileContent 項目にも値がある場合にのみ該当します。この項目は API バージョン 14.0 で使用できます。 |
| fullName | string | API アクセスの一意の識別子として使用される、Sコントロールの開発者名。fullName には、アンダースコアと英数字のみを使用できます。一意であること、最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。この項目が、使用できなくなったバージョン 14.0 より前の文字を含んでいた場合は、それらの文字はこの項目から削除され、その項目の以前の値は name 項目に保存されていました。この項目は、Metadata コンポーネントから継承されています。 |
| name | string | 必須。Sコントロールにつける一意の名前です。文字で始まり、英数字のみが含まれる必要があります。たとえば、example_s_control などです。 |
| supportsCaching | boolean | 必須。Sコントロールがキャッシュをサポートしているか (true)、否か (false) を示します。キャッシュによりページを最適化し、ページの再読み込み時にページに含まれる Sコントロールを記憶します。このオプションは、HTML Sコントロールにのみ適用されます。 |
宣言的なメタデータの定義のサンプル
次のサンプルでは、Myriad_Publishing.scf という Sコントロールを作成し、Sコントロール内に指定された Web サイトへのリンクを作成します。対応する Myriad_Publishing.scf-meta.xml メタデータファイルは、Sコントロールファイルの次に示します。
Myriad_Publishing.scf ファイル:
1http://www.myriadpubs.comMyriad_Publishing.scf-meta.xml:
1<?xml version="1.0" encoding="UTF-8"?>
2<Scontrol xmlns="http://soap.sforce.com/2006/04/metadata">
3 <contentSource>URL</contentSource>
4 <description>s-control to open Myriad Publishing website.</description>
5 <encodingKey>UTF-8</encodingKey>
6 <name>Myriad Publishing</name>
7 <supportsCaching>true</supportsCaching>
8</Scontrol>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。