8.2. IotheCommonTempFiles¶
一時ファイルを操作するクラスです。
一時ファイルは、「 intra-mart Accel Platform 設定ファイルリファレンス 」-「 一時ファイルディレクトリ 」で設定したディレクトリ配下に作成されます。
コラム
本クラスの使用例については、「 スクリプト 」を参照してください。
また、スクリプトの9行目を次のように読み替えてください。
const tempFiles = new IotheCommonTempFiles();
注意
本クラスは、 IM-PDFAutoConverter for Accel Platform 2024 Spring 以降のバージョンで使用可能です。
2023 Autumn 以前のバージョンの場合は、 2024 Spring 以降のバージョンにアップデートしてください。
8.2.1. Constructor¶
8.2.2. Methods¶
8.2.2.1. create(ext)¶
空のファイルを作成します。
Parameters
| Name | Type | Description |
|---|---|---|
| ext | String | ファイル名を生成するために使用される接尾辞文字列
null、または、未指定時は”.tmp” が使用されます。
|
Returns
新規作成された空のファイルを示すFileオブジェクト
Exception
以下のエラーメッセージを持つErrorオブジェクト
- 指定された引数extの値が不正な場合：「接尾辞文字列の値が不正です。」
8.2.2.2. copyFrom(srcFilePath, ext)¶
指定したファイルをコピーし、コピー先のファイルを返します。
Parameters
| Name | Type | Description |
|---|---|---|
| srcFilePath | String | コピー元の対象ファイルのパブリックストレージパス |
| ext | String | コピー先のファイル名を生成するために使用される接尾辞文字列
null、または、未指定時は”.tmp” が使用されます。
|
Returns
コピー先ファイルを示すFileオブジェクト
Exception
以下のエラーメッセージを持つErrorオブジェクト
- 指定された引数srcFilePathの値が不正な場合：「コピー元の対象ファイルパスの値が不正です。」
- 指定された引数extの値が不正な場合：「接尾辞文字列の値が不正です。」
- ファイルのコピーに失敗した場合：「ファイルのコピーに失敗しました。」
8.2.2.3. copyTo(tempFile, destFilePath)¶
指定したファイルを、指定先へコピーします。
Parameters
| Name | Type | Description |
|---|---|---|
| tempFile | File | コピー元の対象ファイル |
| destFilePath | String | コピー先の対象ファイルのパブリックストレージパス |
Exception
以下のエラーメッセージを持つErrorオブジェクト
- 指定された引数tempFileの値が不正な場合：「コピー元の対象ファイルの値が不正です。」
- 指定された引数destFilePathの値が不正な場合：「コピー先の対象ファイルパスの値が不正です。」
- ファイルのコピーに失敗した場合：「ファイルのコピーに失敗しました。」
8.2.2.4. close()¶
一時ファイルを削除し、一時ファイルに関する操作を終了します。
注意
当該メソッドを実行しない場合、一時ファイルディレクトリに一時ファイルが蓄積されていきます。
一時ファイルを残す必要が無い場合は、finallyブロック等を使い、必ず当該メソッドを実行して一時ファイルを削除してください。
Exception
以下のエラーメッセージを持つErrorオブジェクト
- 一時ファイルの削除に失敗した場合：「一時ファイルの削除に失敗しました。」