Apex 開発者ガイド
jInvocableMethod アノテーション
呼び出し可能なメソッドは、REST API でコールし、1 つの Apex メソッドを呼び出すために使用します。呼び出し可能なメソッドには動的な入力値と出力値があり、記述用の API コール (describe) をサポートします。
次のサンプルコードは、プリミティブデータ型を取る呼び出し可能なメソッドを示します。
1public class AccountQueryAction {
2 @InvocableMethod(label='Get Account Names' description='Returns the list of account names corresponding to the specified account IDs.' category='Account')
3 public static List<String> getAccountNames(List<ID> ids) {
4 List<String> accountNames = new List<String>();
5 List<Account> accounts = [SELECT Name FROM Account WHERE Id in :ids];
6 for (Account account : accounts) {
7 accountNames.add(account.Name);
8 }
9 return accountNames;
10 }
11}次のサンプルコードは、特定の sObject データ型を取る呼び出し可能なメソッドを示します。
1public class AccountInsertAction {
2 @InvocableMethod(label='Insert Accounts' description='Inserts the accounts specified and returns the IDs of the new accounts.' category= 'Account')
3 public static List<ID> insertAccounts(List<Account> accounts) {
4 Database.SaveResult[] results = Database.insert(accounts);
5 List<ID> accountIds = new List<ID>();
6 for (Database.SaveResult result : results) {
7 if (result.isSuccess()) {
8 accountIds.add(result.getId());
9 }
10 }
11 return accountIds;
12 }
13}次のサンプルコードは、汎用の sObject データ型を取る呼び出し可能なメソッドを示しています。
1public with sharing class GetFirstFromCollection {
2 @InvocableMethod
3 public static List <Results> execute (List<Requests> requestList) {
4 List<SObject> inputCollection = requestList[0].inputCollection;
5 SObject outputMember = inputCollection[0];
6
7 //Create a Results object to hold the return values
8 Results response = new Results();
9
10 //Add the return values to the Results object
11 response.outputMember = outputMember;
12
13 //Wrap the Results object in a List container
14 //(an extra step added to allow this interface to also support bulkification)
15 List<Results> responseWrapper= new List<Results>();
16 responseWrapper.add(response);
17 return responseWrapper;
18 }
19}
20
21public class Requests {
22 @InvocableVariable(label='Records for Input' description='yourDescription' required=true)
23 public List<SObject> inputCollection;
24 }
25
26public class Results {
27 @InvocableVariable(label='Records for Output' description='yourDescription' required=true)
28 public SObject outputMember;
29 }
30}InvocableMethod 修飾子
次の例に示すように、呼び出し可能なメソッドアノテーションでは修飾子がサポートされています。
@InvocableMethod(label='yourLabel' description='yourDescription')
どの修飾子も省略可能です。
- label
- メソッドのラベル。Flow Builder にアクション名として表示されます。デフォルトはメソッド名ですが、ラベルを指定することをお勧めします。
- description
- メソッドの説明。Flow Builder にアクションの説明として表示されます。デフォルトは Null です。
- category
- メソッドのカテゴリ。Flow Builder にアクションのカテゴリとして表示されます。カテゴリが指定されていない場合 (デフォルト)、アクションは [未カテゴリ] に表示されます。
- configurationEditor
- メソッドを使用して登録され、システム管理者がアクションを設定したときに Flow Builder に表示されるカスタムプロパティエディタ。この修飾子を指定しない場合、Flow Builder では標準プロパティエディタが使用されます。
InvocableMethod 関する考慮事項
- 実装メモ
-
- 呼び出し可能なメソッドは、static で、public または global である必要があり、そのクラスは外部クラスである必要があります。
- クラスの 1 つのメソッドにのみ InvocableMethod アノテーションを付加できます。
- 他のアノテーションと InvocableMethod アノテーションを併用することはできません。
- 入力および出力
- 最大 1 つの入力パラメータが存在する可能性があり、そのデータ型は次のいずれかである必要があります。
- プリミティブデータ型のリスト、またはプリミティブデータ型のリストのリスト – 汎用 Object 型はサポートされていません。
- sObject 型のリスト、または sObject 型のリストのリスト。
- 汎用 sObject 型のリスト (List<sObject>)、または汎用 sObject 型のリストのリスト (List<List<sObject>>)。
- 前述のサポートされている型の変数、またはユーザ定義の Apex 型を含み、InvocableVariable アノテーションが付加されているユーザ定義型のリスト。各自のデータ型を実装するカスタムのグローバルまたは公開 Apex クラスを作成し、そのクラスに呼び出し可能な変数アノテーションが付加されているメンバー変数が少なくとも 1 つ含まれていることを確認します。
- プリミティブデータ型のリスト、またはプリミティブデータ型のリストのリスト – 汎用 Object 型はサポートされていません。
- sObject 型のリスト、または sObject 型のリストのリスト。
- 汎用 sObject 型のリスト (List<sObject>)、または汎用 sObject 型のリストのリスト (List<List<sObject>>)。
- 前述のサポートされている型の変数、またはユーザ定義の Apex 型を含み、InvocableVariable アノテーションが付加されているユーザ定義型のリスト。各自のデータ型を実装するカスタムのグローバルまたは公開 Apex クラスを作成し、そのクラスに呼び出し可能な変数アノテーションが付加されているメンバー変数が少なくとも 1 つ含まれていることを確認します。
- 管理パッケージ
-
- パッケージの呼び出し可能なメソッドを使用できますが、呼び出し可能なメソッドを追加すると、パッケージの後続のバージョンからそのメソッドを削除できません。
- 呼び出し可能な公開メソッドは、管理パッケージ内のフローおよびプロセスで参照できます。
- 呼び出し可能なグローバルメソッドは、登録者組織のあらゆる場所で参照できます。呼び出し可能なグローバルメソッドのみが登録者組織の Flow Builder およびプロセスビルダーに表示されます。
呼び出し可能アクションについての詳細は、『Actions Developer’s Guide (アクション開発者ガイド)』を参照してください。