ONLYOFFICE Docs 7.5 für Entwickler: Updates für API und Doc Builder

23 Oktober 2023By Ksenija

Zusammen mit der Veröffentlichung der neuen Funktionen in Version 7.5 haben wir auch die API für die Editoren, den Document Builder, die Plugins und die Desktop-App aktualisiert. Alle Details finden Sie unten.

ONLYOFFICE Docs 7.5 for developers: API and Doc Builder updates

API für die Arbeit mit Formularen

Ausblenden/Einblenden der Schaltfläche “Formular senden”. Mit dem Parameter editorConfig.customization.submitForm können Sie festlegen, ob die Schaltfläche “Senden” in der oberen Symbolleiste für OFORM-Dateien angezeigt oder ausgeblendet werden soll.

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

Weiterer Parameter für Force Save. In Version 7.5 haben wir den 3-Typ für den forcesavetype-Parameter des Callback-Handlers hinzugefügt. Wenn er angewendet wird, wird die Anforderung zum Erzwingen des Speicherns jedes Mal ausgeführt, wenn das Formular gesendet wird, z. B. wenn die Schaltfläche “Senden” angeklickt wird.

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

API für die Arbeit mit Dokumenten

Ändern einer Quelle der externen Daten. Das neu hinzugefügte Ereignis events.onRequestReferenceSource wird aufgerufen, wenn ein Benutzer versucht, eine Quelle der externen Daten zu ändern, indem er in den Editoren auf die Schaltfläche “Quelle ändern” klickt. Ein Objekt mit den eindeutigen Dateidaten und dem Dateipfad oder -namen wird im Datenparameter gesendet.

Wenn die Schaltfläche angeklickt wird, müssen Sie die setReferenceSource-Methode aufrufen, um eine Quelle der externen Daten zu ändern. Beim Aufruf dieser Methode muss das Token zur Validierung der Parameter hinzugefügt werden. Wenn das Ereignis nicht deklariert ist, wird die Schaltfläche Quelle ändern nicht angezeigt.

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"        
},

Feld “Key”. Das dem Parameter document.referenceData hinzugefügte Feld “Key” definiert die eindeutige Dokumentenkennung, die vom Dienst verwendet wird, um die Daten aus der Mitbearbeitungssitzung zu übernehmen.

Wenn der bekannte Schlüssel (Key) gesendet wird, wird das Dokument aus dem Cache genommen. Jedes Mal, wenn das Dokument bearbeitet und gespeichert wird, muss der Schlüssel neu generiert werden.

Die URL des Dokuments kann als Schlüssel verwendet werden, allerdings ohne die Sonderzeichen und mit einer auf 128 Zeichen begrenzten Länge.

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

Konvertierungs-API

Die Konvertierungs-API wurde um den Fehlercode -9 erweitert, der auftritt, wenn der Konverter das Format der Ausgabedatei nicht automatisch bestimmen kann.

Dieser Fehler bedeutet, dass der Kunde ausdrücklich angeben muss, in welches Format die Datei konvertiert werden soll – Textdokument oder Tabellenkalkulation. Er wird verwendet, um XML in OOXML zu konvertieren, wenn der XML-Typ unbekannt ist.

{     
"error": -9 
}

Sonstige Aktualisierungen

events.onRequestOpen-Ereignis, das zur Anzeige der Schaltfläche “Quelle öffnen” verwendet wird.
Befehle deleteForgotten, getForgotten und getForgottenList, um mit vergessenen Dateien zu arbeiten.
Das Ereignis events.onRequestSelectSpreadsheet anstelle des veralteten events.onRequestMailMergeRecipients.
Die Methode setRequestedSpreadsheet anstelle der veralteten Methode setMailMergeRecipients.
Das Ereignis events.onRequestSelectDocument anstelle des veralteten events.onRequestCompareFile.
Die Methode setRequestedDocument anstelle der veralteten Methode setRevisedFile.

Außerdem haben wir in der Desktop-App-API den Parameter uiTheme zum Befehl portal:login hinzugefügt, der die Editor-Theme-Einstellungen definiert, wenn die Desktop-Editoren mit der Cloud verbunden werden.

Erhalten Sie die neueste Version von ONLYOFFICE Docs Developer Edition:

JETZT HERUNTERLADEN

API-Erweiterung für Plugins

Der neu hinzugefügte Parameter align der Methode ShowButton gibt an, ob die Schaltfläche auf der rechten oder linken Seite des Fensters angezeigt werden soll. Der Standardwert ist “left”.

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

API-Updates für Document Builder

In der DocBuilder-API wurden mehrere neue Methoden für Wasserzeichen und Combo-Box- & Drop-Down-Listen-Content-Control sowie mehrere globale Methoden und Folienmethoden hinzugefügt, darunter die folgenden:

Hier finden Sie die vollständige Liste der neuen Methoden.

BUILDER HERUNTERLADEN