SOAP API 開発者ガイド
jdescribeQuickActions()
構文
1DescribeQuickActionResult[] = connection.describeQuickActions(string[] quickActionNames);使用方法
describeQuickActions() コールは、指定されたアクションの詳細を取得するために使用します。API バージョン 28.0 では、describeQuickActions() コールは ParentEntity.ActionName の形式でアクション名を取得します。API バージョン 29.0 以降では、ContextEntity.ActionName 形式でアクション名を取得します。DescribeQuickActionResult の配列を返します。最初に describeAvailableQuickActions() をコールして指定されたコンテキストで使用できるアクションのリストを取得し、次に describeQuickActions() を使用して特定のアクションに関する詳細を取得します。
サンプル — Java
このサンプルでは、Account オブジェクトに対する作成アクションについてパブリッシャーアクションの詳細を取得して表示します。
1public void example() throws Exception {
2 DescribeQuickActionResult[] result =
3 conn.describeQuickActions(new String[]
4 { "Account.QuickCreateContact", "Account.QuickCreateTask" });
5 for(DescribeQuickActionResult r : result) {
6 assert r != null;
7 DescribeQuickActionDefaultValue [] describeQuickActionDefaultValues = r.getDefaultValues();
8 for(DescribeQuickActionDefaultValue defaultValue : describeQuickActionDefaultValues) {
9 System.out.println("Target Object Field: " + defaultValue.getField() );
10 System.out.println("Target Object Field's default Value: " + defaultValue.getDefaultValue );
11}
12 System.out.println("Action name: " + r.getName());
13 System.out.println("Action label: " + r.getLabel());
14 System.out.println("ParentOrContext object: " + r.getSourceSobjectType());
15 System.out.println("Target object: " + r.getTargetSobjectType());
16 System.out.println("Target object record type: " + r.getTargetRecordTypeId());
17 System.out.println("Relationship field: " + r.getTargetParentField());
18 System.out.println("Quick action type: " + r.getType());
19 System.out.println("VF page name for custom actions: " +
20 r.getVisualforcePageName());
21 System.out.println("Icon name: " + r.getIconName());
22 System.out.println("Icon URL: " + r.getIconUrl());
23 System.out.println("Mini icon URL: " + r.getMiniIconUrl());
24 assert r.getLayout() != null;
25 System.out.println("Height of VF page for custom actions: " + r.getHeight());
26 System.out.println("Width of VF page for custom actions: " + r.getWidth());
27 }
28}引数
| 名前 | 型 | 説明 |
|---|---|---|
| quickActions | string[] | 取得するクイックアクションの配列。 |