SOAP API 開発者ガイド
jdescribeTabs()
ページ上部の Lightning プラットフォームアプリケーションメニューに表示される、ログインユーザが使用できる標準アプリケーションおよびカスタムアプリケーションに関する情報を返します。アプリケーションは、アプリケーション機能を提供するために 1 つの単位として機能するタブのセットです。たとえば、標準 Salesforce アプリケーションとして「セールス」と「サービス」があります。
構文
1describeTabSetResult [] = connection.describeTabs();使用方法
ログインユーザがアクセスできる標準アプリケーションとカスタムアプリケーションの情報を取得するのに、describeTabs() コールを使用します。describeTabs() コールは、アプリケーションを別のユーザインターフェースで表示するのに必要な最小限のメタデータを返します。通常このコールは、Salesforce データを別のユーザインターフェースで表示するためにパートナーアプリケー���ョンからコールされます。
各タブに対するコールでは、タブ名、タブに表示されるメインの sObject、タブを参照する URL のほか、そのタブがカスタムタブかどうかといった情報が返されます。[すべてのタブ] タブおよび Lightning ページのタブは、タブリストには含まれません。
サンプルコード — Java
このサンプルでは、describeTabs() をコールします。これは、タブセットの結果の配列を返します。次に、アプリケーションを表すタブセットの結果ごとに、プロパティの一部を取得し、このアプリケーションのすべてのタブを取得します。このサンプルでは、取得したすべてのプロパティをコンソールに書き込みます。
1public void describeTabsSample() {
2 try {
3 // Describe tabs
4 DescribeTabSetResult[] dtsrs = connection.describeTabs();
5 System.out.println("There are " + dtsrs.length +
6 " tab sets defined.");
7
8 // For each tab set describe result, get some properties
9 for (int i = 0; i < dtsrs.length; i++) {
10 System.out.println("Tab Set " + (i + 1) + ":");
11 DescribeTabSetResult dtsr = dtsrs[i];
12 System.out.println("Label: " + dtsr.getLabel());
13 System.out.println("\tLogo URL: " + dtsr.getLogoUrl());
14 System.out.println("\tTab selected: " +
15 dtsr.isSelected());
16
17 // Describe the tabs for the tab set
18 DescribeTab[] tabs = dtsr.getTabs();
19 System.out.println("\tTabs defined: " + tabs.length);
20
21 // Iterate through the returned tabs
22 for (int j = 0; j < tabs.length; j++) {
23 DescribeTab tab = tabs[j];
24 System.out.println("\tTab " + (j + 1) + ":");
25 System.out.println("\t\tName: " +
26 tab.getSobjectName());
27 System.out.println("\t\tLabel: " + tab.getLabel());
28 System.out.println("\t\tURL: " + tab.getUrl());
29 DescribeColor[] tabColors = tab.getColors();
30 // Iterate through tab colors as needed
31 DescribeIcon[] tabIcons = tab.getIcons();
32 // Iterate through tab icons as needed
33 }
34 }
35 } catch (ConnectionException ce) {
36 ce.printStackTrace();
37 }
38}サンプルコード — C#
このサンプルでは、describeTabs() をコールします。これは、タブセットの結果の配列を返します。次に、アプリケーションを表すタブセットの結果ごとに、プロパティの一部を取得し、このアプリケーションのすべてのタブを取得します。このサンプルでは、取得したすべてのプロパティをコンソールに書き込みます。
1public void describeTabsSample() {
2 try {
3 // Describe tabs
4 DescribeTabSetResult[] dtsrs = binding.describeTabs();
5 Console.WriteLine("There are " + dtsrs.Length +
6 " tab sets defined.");
7
8 // For each tab set describe result, get some properties
9 for (int i = 0; i < dtsrs.Length; i++) {
10 Console.WriteLine("Tab Set " + (i + 1) + ":");
11 DescribeTabSetResult dtsr = dtsrs[i];
12 Console.WriteLine("Label: " + dtsr.label);
13 Console.WriteLine("\tLogo URL: " + dtsr.logoUrl);
14 Console.WriteLine("\tTab selected: " +
15 dtsr.selected);
16
17 // Describe the tabs for the tab set
18 DescribeTab[] tabs = dtsr.tabs;
19 Console.WriteLine("\tTabs defined: " + tabs.Length);
20
21 // Iterate through the returned tabs
22 for (int j = 0; j < tabs.Length; j++) {
23 DescribeTab tab = tabs[j];
24 Console.WriteLine("\tTab " + (j + 1) + ":");
25 Console.WriteLine("\t\tName: " +
26 tab.sobjectName);
27 Console.WriteLine("\t\tLabel: " + tab.label);
28 Console.WriteLine("\t\tURL: " + tab.url);
29 DescribeColor[] tabColors = tab.colors;
30 // Iterate through tab colors as needed
31 DescribeIcon[] tabIcons = tab.icons;
32 // Iterate through tab icons as needed
33 }
34 }
35 } catch (SoapException e) {
36 Console.WriteLine("An unexpected error has occurred: " +
37 e.Message + "\n" + e.StackTrace);
38 }
39}引数
なし。