WebLink

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

バージョン

WebLink は、API バージョン 12.0 以降で使用できます。

項目

項目名	項目の型	説明
availability	WebLinkAvailability (string 型の列挙)	必須。ボタンまたはリンクをオンラインでのみ使用できるか (`online`)、オフラインでも使用できるか (`offline`) を示します。
description	string	ボタンまたはリンクの説明。
displayType	WebLinkDisplayType (string 型の列挙)	ボタンまたはリンクの表示方法を表します。有効な値は、次のとおりです。ハイパーリンクの `link`。ボタンの `button`。関連リストに添付されるボタンの `massActionButton`。
encodingKey	Encoding (string 型の列挙)	必須。デフォルトの文字コード設定は Unicode (`UTF-8`) です。テンプレートが別形式のデータを必要とする場合は、この設定を変更します。この指定は、コンテンツの提供元が URL の場合に使用できます。使用できる値は次のとおりです。 `UTF-8` — Unicode (UTF-8) `ISO-8859-1` — 米国一般および西ヨーロッパ (ISO-8859-1、ISO-LATIN-1) `Shift_JIS` — 日本語 (Shift-JIS) `ISO-2022-JP` — 日本語 (JIS) `EUC-JP` — 日本語 (EUC-JP) `x-SJIS_0213` — 日本語 (Shift-JIS_2004) `ks_c_5601-1987` — 韓国語 (ks_c_5601-1987) `Big5` — 繁体字中国語 (Big5) `GB2312` — 簡体字中国語 (GB2312) `Big5-HKSCS` — 繁体字中国語香港 (Big5–HKSCS)
fullName	string	有効性のために空白と特殊文字がエスケープされたカスタムボタンまたはリンクの名前。名前には、英数字およびアンダースコア (_) 文字のみを使用できます。また、英字で始まる必要があり、アンダースコアで終わったり、連続した 2 つのアンダースコア文字が含まれていたりすることはできません。この項目は Metadata コンポーネントから継承するため、この項目はこのコンポーネントの WSDL で定義されません。作成時、更新時、または削除時に指定する必要があります。コールにおけるこの項目の例を確認するには、「`create()`」を参照してください。
hasMenubar	boolean	openType が `newWindow` である場合、この項目はウィンドウにブラウザメニューバーを表示するか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
hasScrollbars	boolean	openType が `newWindow` である場合、この項目はウィンドウにスクロールバーを表示するか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
hasToolbar	boolean	openType が `newWindow` である場合、この項目はウィンドウにブラウザツールバーを表示するか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
height	int	カスタムボタンまたはリンクによって開かれたウィンドウの高さ (ピクセル単位)。openType が `newWindow` である場合は必須です。それ以外の場合は、この項目を空のままにします。
isResizable	boolean	openType が `newWindow` である場合、この項目はウィンドウのサイズを変更できるか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
linkType	WebLinkType (string 型の列挙)	必須。ボタンまたはリンクのコンテンツが URL、Sコントロール、JavaScript コードブロック、または Visualforce ページによって指定されているかどうかを表します。 `url` `sControl` `javascript` `page` `flow` — 今後の使用のために予約されています。
masterLabel	string	このオブジェクトのマスタ表示ラベル。この表示値は、翻訳されない内部ラベルです。
openType	WebLinkWindowType (string 型の列挙)	必須。ボタンまたはリンクがクリックされたときのコンテンツの表示に使用されるウィンドウのスタイルを指定します。有効な値は次のとおりです。 `newWindow` `sidebar` `noSidebar` `replace` `onClickJavaScript`
page	string	linkType の値が `page` である場合、この項目は Visualforce ページを表します。それ以外の場合は、この項目を空のままにします。
position	WebLinkPosition (string 型の列挙)	OpenType の値が `newWindow` である場合、この項目は新規ウィンドウの表示方法を示します。それ以外の場合は、値を指定しないでください。有効な値は、次のとおりです。 `fullScreen` `none` `topLeft`
protected	boolean	必須。この下位コンポーネントが保護されるか (`true`)、否か (`false`) を示します。保護される下位コンポーネントは、インストールする組織で作成されたコンポーネントまたは下位コンポーネントによってリンク設定したり参照したりすることはできません。
requireRowSelection	boolean	displayType が `massActionButton` である場合、この項目はこのボタンのアクションを実行するために個々の行を選択する必要があるか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
scontrol	string	linkType の値が `sControl` である場合、この項目は Sコントロールの名前を表します。それ以外の場合は、この項目を空のままにします。
showsLocation	boolean	openType が `newWindow` である場合、この項目はウィンドウにブラウザのロケーションバーを表示するか (`true`)、否か (`false`) を示します。それ以外の場合は、この項目を空のままにします。
showsStatus	boolean	openType が `newWindow` である場合、この項目はウィンドウにブラウザのステータスバーを表示するかどうかを示します。それ以外の場合は、この項目を空のままにします。
url	string	linkType が `url` である場合、これは URL 値です。linkType の値が `javascript` である場合、これは JavaScript コンテンツです。値がこのいずれでもない場合、この項目を空のままにします。コンテンツは、XML 解析ルールと同じ方法でエスケープする必要があります。
width	int	ボタンまたはリンクによって開かれたウィンドウの幅 (ピクセル単位)。 openType が `newWindow` である場合は必須です。それ以外の場合は、この項目を空のままにします。

Java のサンプル

次の Java のサンプルは、WebLink の項目のサンプル値を示します。

1public void WebLinkSample(String name) throws Exception {
2    WebLink WebLink = new WebLink();
3    // name variable represents the full name of the object 
4    // on which to create the WebLink, for example, customObject__c
5    WebLink.setFullName(name + ".googleButton");
6    WebLink.setUrl("http://www.google.com");
7    WebLink.setAvailability(WebLinkAvailability.online);
8    WebLink.setLinkType(WebLinkType.url);
9    WebLink.setEncodingKey(Encoding.fromString("UTF-8"));
10    WebLink.setOpenType(WebLinkWindowType.newWindow);
11    WebLink.setHeight(600);
12    WebLink.setWidth(600);
13    WebLink.setShowsLocation(false);
14    WebLink.setHasScrollbars(true);
15    WebLink.setHasToolbar(false);
16    WebLink.setHasMenubar(false);
17    WebLink.setShowsStatus(false);
18    WebLink.setIsResizable(true);
19    WebLink.setPosition(WebLinkPosition.none);
20    WebLink.setMasterLabel("google");
21    WebLink.setDisplayType(WebLinkDisplayType.link);
22
23    AsyncResult[] asyncResults = metadataConnection.create(new WebLink[]{WebLink});
24    // After the create() call completes, we must poll the results of checkStatus() 
25    // 
26
27}

宣言的なメタデータの定義のサンプル

カスタムオブジェクト内の WebLink の定義を次に示します。関連するサンプルについては、「HomePageComponent」および「HomePageLayout」を参照してください。

1<?xml version="1.0" encoding="UTF-8"?>
2<CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
3....
4    <WebLinks>
5        <fullName>googleButton</fullName>
6        <availability>online</availability>
7        <displayType>link</displayType>
8        <encodingKey>UTF-8</encodingKey>
9        <hasMenubar>false</hasMenubar>
10        <hasScrollbars>true</hasScrollbars>
11        <hasToolbar>false</hasToolbar>
12        <height>600</height>
13        <isResizable>true</isResizable>
14        <linkType>url</linkType>
15        <masterLabel>google</masterLabel>
16        <openType>newWindow</openType>
17        <position>none</position>
18        <protected>false</protected>
19        <showsLocation>false</showsLocation>
20        <showsStatus>false</showsStatus>
21        <url>http://www.google.com</url>
22        <width>600</width>
23    </WebLinks>
24....
25</CustomObject>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。

メタデータ API 開発者ガイド

バージョン

項目

Java のサンプル

宣言的なメタデータの定義のサンプル

マニフェストファイル内のワイルドカードのサポート

関連項目: