メインコンテンツへスキップ

​
機能

ドキュメントにページ画像を追加します。
追加した画像にアクセスできるようになるのは、前処理が完了した後です。画像を追加した後にバッチ処理を開始するには、ProcessBatch メソッドを使用します。別の方法として、OpenTask メソッドで開いたタスクのドキュメントに画像を追加した場合は、CloseTask メソッドを使用してタスクを閉じ、Import ステージに送信することもできます。

​
定義

int AddNewPage( int sessionId, int batchId, int documentId, int previousItemId, Page page, File file );

​
パラメーター

sessionId

int

Application Server への接続の ID

batchId

int

ドキュメントを含むバッチの ID

documentId

int

ページの追加先となるドキュメントの ID

previousItemId

int

set 内で新しいページの位置を明示的に指定するための ID:

  • -1 - 新しいページは set の末尾に追加されます
  • 0 - 新しいページは set の先頭に追加されます
  • ページ ID - 新しいページはこの ID を持つページの後に追加されます
    注: この ID を持つページが存在している必要があります。

page

Page

ページの説明です。事前定義された ID field を持つページを追加することをお勧めします

file

File

ページ画像を含むファイル

画像を含むファイルから新しいページを追加するには、POST request を使用することもできます。これを行うには、このメソッドを使用して空のファイルを持つページを作成します: (file.Name = “FileName”, file.Bytes = new bytes [0])。次に、以下のパラメーターを指定して POST request を実行します:
  • Action = Save
  • objectType = 1
  • objectId = documentId (documentId は、ページを追加するドキュメントの ID を表します)
  • version = 0
  • streamName = “Page 1” (1 は AddNewPage メソッドによって返されるページ ID を表します)

​
戻り値

型説明
int追加されたページの ID