English (English) - Change language

ReplacePageImage

What it does

Replaces a page image.

Important! The added images will become accessible only after they are pre-processed. Use the ProcessBatch method to initiate batch processing after you have added the images or use the CloseTask method to close the task and to send it in the Import stage if the images were added into the documents of a task that was opened with the OpenTask method.

Definition

void ReplacePageImage( int sessionId, int batchId, int documentId, int pageId, File file );
    

Parameters

Name Type Description
sessionId int The ID of the connection to the Application Server
batchId int The ID of the batch that contains the document
documentId int The ID of the document in which to replace a page image
pageId int The ID of the page whose image is to be replaced
file File The file of the image

Note: You can also use a POST request to add page image. Call this method and then execute a POST request with the following parameters:

  • Action = Save
  • objectType = 0
  • objectId = documentId
  • version = 0
  • streamName = "Page pageId", where pageId the ID of the page whose image is to be replaced

Returned value

None.

9/25/2020 9:24:45 AM


Please leave your feedback about this article