Class: IOIntegrationRemote

IOIntegrationRemote()

new IOIntegrationRemote()

複数のIOD中間ファイルを結合し、PDFファイルを生成するAPIです。
IOD中間ファイルは Public Storage に保存しておく必要があります。
実行後に作成されるPDFファイルは、Public Storageに作られます。
Author:
  • 株式会社ワイ・エス・エス

Methods

add(path)

IODレイアウトファイルパスを追加します。
連続して呼び出すことにより、複数レイアウトファイルを結合してのPDFファイル生成を実施可能です。
(レイアウトファイルの追加順に結合されます)
Parameters:
Name Type Description
path String IODレイアウトファイルパス(Public Storageからの相対形式で表されるパス名[英数字])

addDelete(path, deleteFlag)

IOD中間ファイルパスを追加します。
連続して呼び出すことにより、複数IOD中間ファイルパスを結合してのPDFファイル生成が可能です。
(IOD中間ファイルパスは、当メソッドの追加順に結合されます)

toPDF(String)後に指定のIOD中間ファイルを削除するフラグを個別に設定可能です。
全体に一度に設定する場合は、setDelete(boolean)を呼び出して下さい。

Parameters:
Name Type Description
path Object IODレイアウトファイルパス(Public Storageからの相対形式で表されるパス名[英数字])
deleteFlag Object 削除フラグ(PDFファイル生成時に削除する)

copySecurity(flgname)

PDFセキュリティのテキスト抽出コピー許可フラグを設定します。
Parameters:
Name Type Description
flgname String テキスト抽出コピー許可フラグ文字列(COPY_AND_ACCESSBILITY_ENABLE/COPY_AND_ACCESSBILITY_DISABLE)

defineApplication(appliname)

PDF文書情報作成アプリケーション名を設定します。
Parameters:
Name Type Description
appliname String 作成アプリケーション名

defineAuthor(author)

PDF文書情報作成者を設定します。
Parameters:
Name Type Description
author String 作成者

defineSubTitle(subtitle)

PDF文書情報サブタイトルを設定します。
Parameters:
Name Type Description
subtitle String 文書サブタイトル

defineTitle(title)

PDF文書情報タイトルを設定します。
Parameters:
Name Type Description
title String 文書タイトル

getMessage() → {String}

実行結果メッセージを取得します。
Returns:
結果メッセージ文字列
Type
String

modifySecurity(flgname)

PDFセキュリティの編集許可フラグを設定します。
Parameters:
Name Type Description
flgname String 編集許可フラグ文字列(MODIFY_FORM_AND_ANNOTATION/MODIFY_FORM_AND_ASSEMBLY/MODIFY_ALL/MODIFY_DISABLE)

printSecurity(flgname)

PDFセキュリティの印刷許可フラグを設定します。
Parameters:
Name Type Description
flgname String 印刷許可フラグ文字列(PRINT_ENABLE/PRINT_DISABLE)

setDelete(deleteFlag)

IODファイル削除フラグを設定します。
Parameters:
Name Type Description
deleteFlag boolean
true : IODファイルを削除する
false : IODファイルを削除しない

setOpenPassword(openpass)

PDFオープンパスワードを設定します。
Parameters:
Name Type Description
openpass String オープンパスワード

setSecurityPassword(secpass)

PDFセキュリティパスワードを設定します。
Parameters:
Name Type Description
secpass String セキュリティパスワード

toPDF(path) → {Number}

PDFファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name Type Description
path String 出力PDFファイル(Public Storageからの相対形式で表されるパス名[英数字])
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
Type
Number