ONLYOFFICE Docs 8.2 für Entwickler: API-Updates

Zusammen mit der Veröffentlichung der neuen Funktionen in Version 8.2 haben wir die API für die Editoren, die Office-API und die Plugins aktualisiert und das Java Framework für Document Builder sowie das PHP-Integrations-SDK hinzugefügt. Alle Details finden Sie unten.

Bereitstellung ohne Ausfallzeiten

Die Bereitstellung ohne Ausfallzeiten ist eine großartige Möglichkeit, eine Anwendung zu aktualisieren, ohne dass Pausen erforderlich sind. So ist es möglich, die Editoren zu aktualisieren, ohne sie offline nehmen zu müssen.

Wie funktioniert das? Die Instanz von ONLYOFFICE Docs (Document Server, DS) mit der neuen Version wird parallel zum aktuell laufenden Document Server gestartet. Neue Bearbeitungssitzungen werden im neuen DS eröffnet. Die vorherige DS-Version funktioniert so lange, bis die Benutzer ihre Bearbeitungssitzungen selbst beenden. Erst danach stoppt der bisherige DS.

Wenn wir über ONLYOFFICE Docs Shards sprechen, sind wir in der Lage, eine Bearbeitungssitzung an den spezifischen DS im Cluster zu leiten. Daher ist es möglich, Dokumentenserver mit unterschiedlichen Versionen parallel arbeiten zu lassen. Vergessen Sie nicht, dass die Duplizierung von Ressourcen und der Aktualisierungsprozess selbst einige Zeit in Anspruch nehmen können.

Bitte beachten Sie: Die Zero-Downtime-Bereitstellung ist für ONLYOFFICE Docs verfügbar, die als Kubernetes Shards bereitgestellt werden. Möchten Sie mehr erfahren? Kontaktieren Sie uns einfach über sales@onlyoffice.com.

SDK für die PHP-Integration

Integrieren Sie ONLYOFFICE Docs ganz einfach in Ihre PHP-Anwendung. Das SDK enthält den allgemeinen Code für PHP-Integrationen, die Erstellung der Initialisierungskonfiguration und die Handhabung gängiger Methoden im Backend. Probieren Sie es aus

Das PHP SDK ist jetzt zum Beispiel in der ONLYOFFICE und Chamilo Integration implementiert .

Neue Schnittstellenstile

Der Parameter editorConfig.customization.features bringt zwei weitere Felder – tabStyle und tabBackground. Auf diese Weise können Sie das Erscheinungsbild des Editors nach Ihren Wünschen anpassen.

Ersteres ermöglicht die Einstellung der Füllung (die Registerkarten der oberen Symbolleiste werden deutlich angezeigt) oder des Linienstils (die Registerkarten der oberen Symbolleiste werden durch Unterstreichung hervorgehoben).

Letzteres legt fest, ob der Hintergrund der Registerkarten der oberen Symbolleiste dem Hintergrund der Kopfzeile oder dem Hintergrund der Symbolleiste entspricht.

Außerdem haben wir das Feld imageLight zum Parameter editorConfig.customization.logo hinzugefügt. Es definiert den Pfad zu der Bilddatei, die für die helle Kopfzeile verwendet wird, zum Beispiel im neu hinzugefügten Thema “Grau”.

const logo = {
  image: "https://example.com/logo.png",
  imageDark: "https://example.com/dark-logo.png",
  imageLight: "https://example.com/light-logo.png",
  url: "https://example.com",
  visible: true,
}

Einfügen von Text aus Drittquellen

Der Parameter c der Methode setRequestedDocument wird um den Typ insert-text der Dokumentauswahl erweitert. Auf diese Weise können Benutzer ein Dokument aus der lokalen/URL/Speicherdatei auswählen, um dessen Inhalt in das aktuelle Dokument einzufügen.

docEditor.setRequestedDocument({
  c: "insert-text",
  fileType: "docx",
  url: "https://example.com/url-to-example-document.docx",
...

Prüfung des Dokumentstatus

Der Parameter users wird nun in die Antwort des Befehls info aufgenommen. Dieser Parameter definiert die Liste der Identifikatoren der Benutzer, die das Dokument zur Bearbeitung geöffnet haben. Wenn das Dokument geändert wurde, gibt users die Kennung des Benutzers zurück, der das Dokument als letzter bearbeitet hat.

{
  "error": 0,
  "key": "Khirz6zTPdfd7",
  "users": ["6d5a81d0", "78e1e841"]
}

Was sich sonst noch bei der Docs API geändert hat

• Neue Abfrageparameter für die WOPI-Konvertierungs-API zur Arbeit mit geschützten Dokumenten: Passwort und PasswordToOpen.
• Die Adresse https://documentserver/coauthoring/CommandService.ashx des Befehlsdienstes wird durch https://documentserver/command ersetzt .
• Für den Konvertierungsdienst verwenden Sie bitte die Adresse https://documentserver/converter.
• Das Feld editorConfig.location ist veraltet. Bitte verwenden Sie stattdessen das Feld editorConfig.region, um die Standardmaßeinheiten in allen Editortypen zu definieren.
• Das Feld editorConfig.customization.toolbarNoTabs ist veraltet, bitte verwenden Sie stattdessen die Felder editorConfig.customization.features.tabStyle und editorConfig.customization.features.tabBackground.

Erhalten Sie die neueste Version von ONLYOFFICE Docs Developer:

JETZT HERUNTERLADEN

E-Mail-Benachrichtigungen: Warnungen zu Lizenz- und Kontingentgrenzen

Es ist jetzt möglich, E-Mail-Benachrichtigungen zu versenden, z. B. dass die Lizenz bald abläuft oder das Verbindungslimit bald erreicht ist.

Wie funktioniert das? Wir haben der Serverkonfiguration die Möglichkeit hinzugefügt, Mailserver-Einstellungen festzulegen. Für den Versand von Benachrichtigungen wird ein externer Mailserver verwendet, zu dem die Verbindung über die Nodemailer-Bibliothek hergestellt wird. Viele Einstellungen aus der Serverkonfiguration werden direkt in diese Bibliothek übertragen.

API-Verbesserungen für Plugins

Die Plugin-API bringt auch nützliche Verbesserungen mit sich, nämlich Methoden zur Durchführung von Rückgängig- und Wiederherstellungsaktionen .

• api.prototype.Undo = function()
• api.prototype.Redo = function()
• api.prototype.CanUndo = function()
• api.prototype.CanRedo = function()

Sehen Sie sich die vollständige Liste der Plugin-API-Updates an.

Java-Framework für Document Builder

Für ONLYOFFICE Document Builder gibt es jetzt ein Java Builder Framework. Es enthält eine Sammlung von Bibliotheken, Klassen und Funktionen, die die schnelle Entwicklung von Anwendungen in Java mit Funktionen zur Dokumentenerstellung erheblich erleichtern.

DOCUMENT BUILDER ERHALTEN

Office API

Für die Office JavaScript-API wurden für die Version 8.2 viele neue Methoden hinzugefügt, einschließlich der Methoden für:

• Bereiche;
• Pivot-Tabellen;
• Platzhalter;
• Suchen und Ersetzen von Wörtern/Sätzen;
• alle Felder aktualisieren;
• Gliederungen;
• und andere.

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