ApiExecutor クラス

クラウドサイン Web API を実行します。

名前空間

CloudSign

使用方法

このクラスのコンストラクタは、引数をとりません。次に例を示します。

CloudSign.ApiExecutor apiExecutor = new CloudSign.ApiExecutor();

ApiExecutor のメソッド

ApiExecutor のメソッドは次の通りです。すべてインスタンスメソッドです。

beforeExecute

カスタム設定など、送信・リマインドに必要な事前設定をチェックします。このメソッドは、送信・リマインドの前に呼び出す必要があります。

シグネチャ:

List<String> beforeExecute()

戻り値:

エラーがある場合はメッセージのリスト、エラーがない場合は空のリスト

send （個別送信）

クラウドサイン Web API を使用して、指定された1件の書類を送信します。
送信に成功した場合、クラウドサイン管理に関連付けられた送信対象オブジェクトのレコード ID と書類情報を紐づけて、クラウドサイン管理に追加します。

シグネチャ:

ApiExecutor.Result send(ApiExecutor.SendParam sendParam)

パラメータ:

sendParam - 送信パラメータ

戻り値:

成功または失敗したか、および失敗した場合はその理由の確認に使用できるエラーメッセージ、または Web API レスポンスから構成される結果オブジェクト

send （一括送信）

クラウドサイン Web API を使用して、指定された1件以上の書類を送信します。

シグネチャ:

List<ApiExecutor.Result> send(List<ApiExecutor.SendParam> sendParams)

パラメータ:

sendParams - 送信パラメータのリスト

戻り値:

成功または失敗したか、および失敗した場合はその理由の確認に使用できるエラーメッセージ、または Web API レスポンスから構成される結果オブジェクトのリスト

remind （個別送信）

クラウドサイン Web API を使用して、指定された1件のクラウドサイン管理レコード ID に対応する書類をリマインドします。
リマインドは、ステータスが「先方確認中」の書類のみ有効な機能です。
送信先が書類を確認してからバッチ処理で Salesforce にステータスが反映されるまでの間、クラウドサインと Salesforce のステータスが一致しない状態になります。
この状態でメソッドが呼ばれた場合、リマインドメールは送信されず、クラウドサイン Web API からエラーが返されます。
このときの ApiExecutor.Result は、isSuccess() で false、getParamErrors() でエラーメッセージを戻します。

シグネチャ:

ApiExecutor.Result remind(ApiExecutor.RemindParam remindParam)

パラメータ:

remindParam - リマインドパラメータ

戻り値:

成功または失敗したか、および失敗した場合はその理由の確認に使用できるエラーメッセージ、または Web API レスポンスから構成される結果オブジェクト

remind （一括送信）

クラウドサイン Web API を使用して、指定された1件以上のクラウドサイン管理レコード ID に対応する書類をリマインドします。

シグネチャ:

List<ApiExecutor.Result> remind(List<ApiExecutor.RemindParam> remindParams)

パラメータ:

remindParams - リマインドパラメータリスト

戻り値:

成功または失敗したか、および失敗した場合はその理由の確認に使用できるエラーメッセージ、または Web API レスポンスから構成される結果オブジェクトのリスト