ONLYOFFICE Docs 7.5 pour les développeurs : Mises à jour de l’API et du Doc Builder

23 octobre 2023Par Dasha

En plus des nouvelles fonctionnalités de la version 7.5, nous avons mis à jour l’API pour les éditeurs, Document Builder, les plugins et l’application de bureau. Consultez tous les détails ci-dessous.

ONLYOFFICE Docs 7.5 pour les développeurs : Mises à jour de l'API et du Doc Builder

API pour travailler avec des formulaires

Masquer/afficher le bouton de soumission du formulaire. En utilisant le paramètre editorConfig.customization.submitForm, il est possible de définir si le bouton Submit est affiché ou caché dans la barre d’outils supérieure pour les fichiers OFORM.

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"editorConfig": {         
"customization": {
...
"submitForm": true,

Paramètre supplémentaire pour option “Force Save”. Dans la version 7.5, nous avons ajouté le type 3 pour le paramètre forcesavetype du gestionnaire de rappel. S’il est appliqué, la demande d’enregistrement forcé est exécutée chaque fois que le formulaire est soumis, par exemple lorsque l’on clique sur le bouton Soumettre.

{    
 "changesurl": "https://documentserver/url-to-changes.zip",     
"forcesavetype": 3,
....

API pour travailler avec des documents

Modification d’une source de données externes. L’événement events.onRequestReferenceSource nouvellement ajouté est appelé lorsqu’un utilisateur tente de modifier une source de données externes en cliquant sur le bouton Modifier la source dans les éditeurs. Un objet contenant les données uniques du fichier et le chemin d’accès ou le nom du fichier est envoyé dans le paramètre data.

Lorsque le bouton est cliqué, vous devez appeler la méthode setReferenceSource pour modifier la source des données externes. Lors de l’appel de cette méthode, le jeton doit être ajouté pour valider les paramètres. Si l’événement n’est pas déclaré, le bouton Modifier la source ne sera pas affiché.

var onRequestReferenceSource = function () 
{     var referenceData =  event.data.referenceData;     
var path = event.data.path; 
...
    docEditor.setReferenceSource({        
"fileType": "xlsx",         
"path": "sample.xlsx",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

Champ clé. Le champ clé ajouté au paramètre document.referenceData définit l’identifiant unique du document utilisé par le service pour extraire les données de la session de coédition.

Si la clé connue est envoyée, le document sera extrait du cache. Chaque fois que le document est modifié et enregistré, la clé doit être générée à nouveau.

L’URL du document peut être utilisé comme clé, mais sans les caractères spéciaux et la longueur est limitée à 128 symboles.

var docEditor = new DocsAPI.DocEditor("placeholder", {     
"document": {         
"fileType": "docx",         
"key": "Khirz6zTPdfd7",         
"referenceData": {             
"fileKey": "BCFA2CED",             
"instanceId": "https://example.com",             
"key": "Khirz6zTPdfd7"        
},

API de conversion

L’API de conversion est étendue avec le code d’erreur -9 qui se produit lorsque le convertisseur ne peut pas déterminer automatiquement le format du fichier de sortie.

Cette erreur signifie que le client doit explicitement spécifier dans quel format le fichier doit être converti – document texte ou feuille de calcul. Elle est utilisée pour convertir XML en OOXML dans le cas où le type XML est inconnu.

{     
"error": -9 
}

Autres mises à jour

Événement events.onRequestOpen utilisé pour afficher le bouton Open source.
Commandes deleteForgotten, getForgotten et getForgottenList pour travailler avec les fichiers oubliés.
Événement events.onRequestSelectSpreadsheet au lieu de l’événement obsolète events.onRequestMailMergeRecipients.
Méthode setRequestedSpreadsheet au lieu de la méthode setMailMergeRecipients, qui est obsolète.
Événement events.onRequestSelectDocument au lieu de l’événement events.onRequestCompareFile, qui est obsolète.
Méthode setRequestedDocument au lieu de la méthode setRevisedFile, qui est obsolète.

En outre, dans l’API de l’application de bureau, nous avons ajouté le paramètre uiTheme à la commande portal:login qui définit les paramètres du thème de l’éditeur lors de la connexion des éditeurs de bureau au nuage.

Obtenez la dernière version de ONLYOFFICE Docs Developer Edition :

TÉLÉCHARGER MAINTENANT

Amélioration de l’API pour les plugins

Le nouveau paramètre align de la méthode ShowButton indique si le bouton sera affiché sur le côté droit de la fenêtre ou sur le côté gauche. La valeur par défaut est “left”.

window.Asc.plugin.executeMethod ("ShowButton", ["back", false, "right"]);

Mises à jour de l’API pour Document Builder

Dans l’API DocBuilder, nous avons ajouté plusieurs nouvelles méthodes de filigrane et de contrôle de contenu de boîte combinée et de liste déroulante, plusieurs méthodes globales et de diapositives, y compris les suivantes :

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

TÉLÉCHARGER BUILDER