Passer au contenu principal

Ce que fait cette méthode

Ajoute une image de la page à un document.
Les images ajoutées ne seront accessibles qu’une fois prétraitées. Utilisez la méthode ProcessBatch pour lancer le traitement du lot après avoir ajouté les images. Vous pouvez aussi utiliser la méthode CloseTask pour fermer la tâche et l’envoyer à l’étape Import si les images ont été ajoutées dans les documents d’une tâche ouverte avec la méthode OpenTask.

Définition

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

Paramètres

sessionId

int

ID de la connexion à l’Application Server

batchId

int

ID du lot contenant le document

documentId

int

ID du document auquel une page doit être ajoutée

previousItemId

int

ID permettant de spécifier explicitement la position de la nouvelle page dans l’ensemble :

  • -1 - la nouvelle page sera ajoutée à la fin de l’ensemble
  • 0 - la nouvelle page sera ajoutée au début de l’ensemble
  • ID de page - la nouvelle page sera ajoutée après la page ayant cet ID
    Remarque : une page avec cet ID doit exister.

page

Page

Description de la page. Il est recommandé d’ajouter des pages avec un champ ID prédéfini

file

File

Fichier contenant l’image de la page

Vous pouvez également utiliser une requête POST pour ajouter une nouvelle page à partir du fichier contenant une image. Pour ce faire, créez une page avec un fichier vide à l’aide de cette méthode : (file.Name = “FileName”, file.Bytes = new bytes [0]). Exécutez ensuite une requête POST avec les paramètres suivants :
  • Action = Save
  • objectType = 1
  • objectId = documentId, où documentId représente l’ID du document auquel une page doit être ajoutée
  • version = 0
  • streamName = “Page 1”, où 1 représente l’ID de la page renvoyé par la méthode AddNewPage

Valeur de retour

TypeDescription
intL’ID de la page ajoutée