describeAvailableQuickActions()

API バージョン 28.0 では、指定された親で使用できるアクションの詳細を記述します。API バージョン 29.0 以降では、指定されたコンテキストで使用可能なアクションの詳細を記述します。

構文

1DescribeAvailableQuickActionResult [] = connection.describeAvailableQuickActions(string parentOrContextType );

使用方法

describeAvailableQuickActions() を使用して、親 (API バージョン 28.0) またはコンテキスト (API バージョン 29.0 以降) エンティティ名と、標準およびグローバルアクションが指定されているアクションのリストを取得します。describeAvailableQuickActions() コールは、グローバルアクションに「Account」や「null」などの親エンティティ名を使用し、API バージョン 29.0 以降の場合はコンテキストエンティティ名を使用して、DescribeAvailableQuickActionResult の配列を返します。

サンプル — Java

このサンプルでは、Account オブジェクトについて使用可能なアクション情報を取得して表示します。

1public void example() throws Exception {
2    DescribeAvailableQuickActionResult[] aResult = 
3        conn.describeAvailableQuickActions("Account");
4    for(DescribeAvailableQuickActionResult ar : aResult) { 
5        System.out.println("Action label: " + ar.getLabel());
6        System.out.println("Action name: " + ar.getName());
7        System.out.println("Action type: " + ar.getType());
8    }
9}

引数

応答

DescribeAvailableQuickActionResult オブジェクトの配列。

障害

connection.exception エラー