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

Zusammen mit der Veröffentlichung der neuen Funktionen in Version 8.0 haben wir die API für die Editoren, den Document Builder und die Plugins aktualisiert. Alle Details finden Sie in diesem Beitrag.

PDF-Unterstützung

Wir haben den Parameter documentType um den PDF-Dokumententyp erweitert. Das bedeutet, dass PDF-Dateien*, einschließlich solcher mit ausfüllbaren Feldern, jetzt vollständig unterstützt werden und zum Kommentieren und Ausfüllen in ONLYOFFICE PDF Editor geöffnet werden können (früher wurden solche Dateien als Dokumente erkannt und im Dokumenteditor geöffnet).

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

*Auch DjVu, OXPS und XPS

API für die Arbeit mit Formularen

Der zum Callback-Handler hinzugefügte Parameter formsdataurl ermöglicht die Definition der URL zur JSON-Datei mit den übermittelten Formulardaten. Diese Datei enthält die folgenden Parameter:

• key
• tag
• value
• type (text, checkBox, picture, comboBox, dropDownList, dateTime, radio)

Außerdem finden Sie neue Formularmethoden in der DocBuilder API:

• ApiDocument/GetFormsData gibt die Daten aller im aktuellen Dokument vorhandenen Formulare zurück;
• ApiDocument/SetFormsData setzt die Daten auf die angegebenen Formulare.

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();

Verbesserte WOPI-Unterstützung

Die neueste Version enthält den WOPISrc–Abfrageparameter, der zu den Anfragen des Browsers an den Server hinzugefügt wird. Dies ermöglicht es Ihnen, mehrere unabhängige Instanzen von ONLYOFFICE zu erstellen. Anfragen zur Lastverteilung mit WOPISrc stellen sicher, dass die kollaborative Bearbeitung korrekt funktioniert: alle Benutzer, die das gleiche Dokument bearbeiten, werden vom gleichen Server bedient.

Für WOPI wird der vom Integrator gesendete Parameter verwendet. Für die Docs-API wird der Parameter document.key in WOPISrc geschrieben.

Konvertierungs-API

Das der Konvertierungsanforderung hinzugefügte Feld watermark definiert ein JSON-Objekt, das die Eigenschaften eines Wasserzeichens enthält, das während der Konvertierung in die PDF- und Bilddateien eingefügt wird.

"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 ],
  ...

Unterstützung für Oracle- und Microsoft SQL Server-Datenbanken

Unter den unterstützten Datenbanken befinden sich nun auch Oracle und Microsoft SQL Server. Um eine Verbindung herzustellen, ändern Sie den Datenbanktyp in oracle / mssql. Für Docker, müssen Sie den Parameter DB_TYPE anpassen.

Dies können Sie auch benutzen:

• Erweiterte Verbindungseinstellungen für oracle – oracleExtraOptions
• Erweiterte Verbindungseinstellungen für mssql – msSqlExtraOptions

Avatare der Benutzer

Ab Version 8.0 ist es möglich, Avatare der Benutzer hinzuzufügen, die in den Editoren zur besseren Visualisierung des Teams angezeigt werden.

Daher wurde der Operationstyp info zur Methode setUsers und zum Ereignis onRequestUsers hinzugefügt, um die Avatare für die Benutzer mit den im Parameter data.id angegebenen IDs zu setzen. Und das neu hinzugefügte Feld users.image definiert den Pfad zum Avatar.

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

Außerdem enthält der Parameter editorConfig.user jetzt das Feld image, um den Pfad zum Avatar zu definieren:

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

Weitere API-Aktualisierungen für die Editoren

• Der Parameter editorConfig.customization.mobileForceView legt fest, ob der mobile Dokumenteditor beim Start im Ansichts-/Bearbeitungsmodus geöffnet wird. Der Standardwert ist true.
• Das Feld link im Objekt data, das an das Ereignis events.onRequestReferenceData gesendet wird.

Holen Sie sich die neueste Version von ONLYOFFICE Docs Developer:

HERUNTERLADEN

API-Updates für Plugins

Die neu hinzugefügten Plugin-Methoden ermöglichen das Starten und Verwalten von Diashows:

• EndSlideShow
• GoToNextSlideInSlideShow
• GoToPreviousSlideInSlideShow
• GoToSlideInSlideShow
• PauseSlideShow
• ResumeSlideShow
• StartSlideShow

Unten sind einige Codebeispiele:

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

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

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

Weitere API-Updates für Document Builder

In der DocBuilder API haben wir auch mehrere Einfrierbereiche und Kommentarmethoden hinzugefügt, sowie einige andere, einschließlich der folgenden:

• ApiFreezePanes/GetLocation, die einen Bereich zurückgibt, der die eingefrorenen Zellen in der aktiven Arbeitsblattansicht beschreibt.
• ApiBlockLvlSdt/AddComment, die einen Kommentar zum aktuellen Blockinhaltssteuerelement hinzufügt.
• ApiSection/GetPageHeight, die Seitenhöhe für den aktuellen Abschnitt ermittelt.
• ApiDocument/AddDrawingToPage, die der angegebenen Seite eine Form hinzufügt.

Die vollständige Liste von Methoden.

BUILDER ERHALTEN