ONLYOFFICE Docs 8.0 pour les développeurs : API et Doc Builder mis à jour

5 février 2024By Dasha

Outre les nouvelles fonctionnalités de la version 8.0, nous avons mis à jour l’API pour les éditeurs, Document Builder et les plugins. Consultez tous les détails ci-dessous.

ONLYOFFICE Docs 8.0 for developers: API and Doc Builder updates

Prise en charge de PDF

Nous avons ajouté le type de document pdf au paramètre documentType. Cela signifie que les fichiers PDF*, y compris ceux qui contiennent des champs à remplir, sont maintenant entièrement pris en charge et peuvent être ouverts pour être annotés et remplis dans l’éditeur PDF de ONLYOFFICE (auparavant, ces fichiers étaient reconnus comme des documents texte et ouverts dans l’éditeur correspondant).

var docEditor = new DocsAPI.DocEditor("placeholder", {     
    "documentType": "pdf",

*Egalement DjVu, OXPS et XPS

API pour travailler avec des formulaires

The formsdataurl parameter added to the Callback handler allows defining the URL to the JSON file with the submitted form data. This file contains the following parameters:

Le paramètre formsdataurl ajouté au gestionnaire de rappel permet de définir l’URL du fichier JSON contenant les données du formulaire soumis. Ce fichier contient les paramètres suivants :

clé
étiquette
valeur
type (texte, case à cocher, image, boîte combo, liste déroulante, date/heure, bouton radio)

De plus, vous trouverez de nouvelles méthodes de formulaire dans l’API DocBuilder :

ApiDocument/GetFormsData qui renvoie les données de tous les formulaires présents dans le document actuel ;
ApiDocument/SetFormsData qui définit les données dans les formulaires spécifiés.

builder.CreateFile("docx"); 
var oDocument = Api.GetDocument(); 
var oParagraph1 = oDocument.GetElement(0); 
var oCheckBox = Api.CreateCheckBoxForm({"key": "BestCompany"}); 
oParagraph1.Push(oCheckBox); 
var oTextForm = Api.CreateTextForm({"key": "CompanyName"}); 
oParagraph1.Push(oTextForm); 
oDocument.SetFormsData([    
   {"key": "BestCompany", "value": true},     
   {"key": "CompanyName", "value": "ONLYOFFICE"} 
]); 
builder.SaveFile("docx", "SetFormsData.docx"); 
builder.CloseFile();

Support WOPI amélioré

La dernière version apporte le paramètre de requête WOPISrc qui est ajouté aux requêtes du navigateur vers le serveur. Cela vous permet de créer plusieurs instances indépendantes d’ONLYOFFICE. Les requêtes de répartition de charge avec WOPISrc garantissent le bon fonctionnement de l’édition collaborative : tous les utilisateurs qui éditent le même document sont servis par le même serveur.

Pour WOPI, le paramètre envoyé par l’intégrateur est utilisé. Pour l’API Docs, le paramètre document.key est écrit dans WOPISrc.

API de conversion

Le champ filigrane ajouté à la demande de conversion définit un objet JSON contenant les propriétés d’un filigrane qui est inséré dans les fichiers PDF et image lors de la conversion.

"async": false,    
"filetype": "docx",     
"key": "Khirz6zTPdfd7",     
"outputtype": "pdf",     
"title": "Example Document Title.docx",     
"url": "https://example.com/url-to-example-document.docx",     
"watermark": {         
  "align": 1,         
  "fill": [255, 0, 0],        
  "height": 100,        
  "margins": [ 10, 10, 10, 10 ],
  ...

Prise en charge des bases de données Oracle et Microsoft SQL Server

Parmi les bases de données prises en charge figurent désormais Oracle et Microsoft SQL Server. Pour les connecter, changez le type de base de données en oracle / mssql. Pour Docker, il faudra ajuster le paramètre DB_TYPE.

En outre, vous pouvez utiliser :

Paramètres de connexion avancés pour oracle – oracleExtraOptions
Paramètres de connexion avancés pour mssql – msSqlExtraOptions

Avatars d’utilisateurs

À partir de la version 8.0, il est possible d’ajouter des avatars d’utilisateurs à afficher dans les éditeurs pour une meilleure visualisation de l’équipe.

Ainsi, le type d’opération info est ajouté à la méthode setUsers et à l’événement onRequestUsers pour définir les avatars des utilisateurs dont l’ID est spécifié dans le paramètre data.id. Le champ users.image nouvellement ajouté définit le chemin d’accès à l’avatar de l’utilisateur.

var onRequestUsers = function (event) {     
   var c = event.data.c;     
   var id = event.data.id;    
   ...      
docEditor.setUsers({         
   "c": event.data.c,         
   "users": [             
     {                 
     "email": "john@example.com",                 
     "id": "78e1e841",                 
     "image": "https://example.com/url-to-user-avatar1.png",                 
     "name": "John Smith"             
     },

En outre, le paramètre editorConfig.user contient désormais le champ image permettant de définir le chemin d’accès à l’avatar de l’utilisateur :

var docEditor = new DocsAPI.DocEditor("placeholder", {    
"editorConfig": {
...
    "user": {             
    "group": "Group1",             
    "id": "78e1e841",             
    "image": "https://example.com/url-to-user-avatar.png",             
    "name": "John Smith"         
     }

Plus de mises à jour de l’API pour les éditeurs

Le paramètre editorConfig.customization.mobileForceView permet de définir si l’éditeur de documents mobiles est ouvert en mode affichage/édition au lancement. La valeur par défaut est true.
Champ de lien dans l’objet de données envoyé à l’événement events.onRequestReferenceData.

Obtenez la dernière version d’ONLYOFFICE Docs Developer :

TÉLÉCHARGER MAINTENANT

Améliorations de l’API pour les plugins

Les nouvelles méthodes du plugin permettent de lancer et de gérer des diaporamas :

Vous trouverez ci-dessous plusieurs exemples de code :

window.Asc.plugin.executeMethod ("StartSlideShow");

window.Asc.plugin.executeMethod ("GoToSlideInSlideShow", [2]);

window.Asc.plugin.executeMethod ("EndSlideShow");

Autres mises à jour de l’API pour Document Builder

Dans l’API de DocBuilder, nous avons également ajouté plusieurs panneaux d’arrêt sur image et des méthodes de commentaire, ainsi que d’autres éléments, dont les suivants :

ApiFreezePanes/GetLocation qui renvoie une plage décrivant les cellules gelées dans la vue active de la feuille de calcul.
ApiBlockLvlSdt/AddComment qui ajoute un commentaire au contrôle du contenu du bloc en cours.
ApiSection/GetPageHeight qui permet d’obtenir la hauteur de la page pour la section en cours.
ApiDocument/AddDrawingToPage qui ajoute une forme à la page spécifiée.

Consultez la liste complète des nouvelles méthodes.

TÉLÉCHARGER BUILDER