ONLYOFFICE Docs 7.5 per sviluppatori: API e Doc Builder aggiornati

23 ottobre 2023By Elena

Insieme al rilascio delle nuove funzionalità nella versione 7.5, abbiamo aggiornato l’API per gli editor, Document Builder, plugin e app desktop. Scopri tutti i dettagli qui sotto.

ONLYOFFICE Docs 7.5 for developers: API and Doc Builder updates

API per lavorare con i moduli

Mostra/nascondi il pulsante Invia modulo. Utilizzando il parametro editorConfig.customization.submitForm è possibile definire se il pulsante Invia viene visualizzato o nascosto nella barra degli strumenti superiore per i file OFORM.

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

Ulteriore parametro per Force Save. Nella versione 7.5, abbiamo aggiunto il tipo 3 per il parametro forcesavetype del gestore di callback. Se applicata, la richiesta di salvataggio forzato viene eseguita ogni volta che il modulo viene inviato, ad es. quando si fa clic sul pulsante Invia.

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

API per lavorare con i documenti

Modifica di un’origine dei dati esterni. L’evento events.onRequestReferenceSource appena aggiunto viene eseguito quando un utente tenta di modificare un’origine dei dati esterni facendo clic sul pulsante Cambia origine negli editor. Nel parametro data viene inviato un oggetto con i dati del file univoci e il percorso o il nome del file.

Quando si fa clic sul pulsante, è necessario eseguire il metodo setReferenceSource per modificare un’origine dei dati esterni. Facendolo, è necessario aggiungere il token per convalidare i parametri. Se l’evento non viene eseguito il pulsante Cambia sorgente non verrà visualizzato.

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

Campo chiave. Il campo chiave aggiunto al parametro document.referenceData definisce l’identificatore univoco del documento utilizzato dal servizio per prendere i dati dalla sessione di co-editing.

Nel caso in cui venga inviata la chiave conosciuta, il documento verrà prelevato dalla cache. Ogni volta che il documento viene modificato e salvato, la chiave deve essere generata nuovamente.

L’URL del documento può essere utilizzato come chiave ma senza caratteri speciali e la lunghezza è limitata a 128 simboli.

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

API di conversione

L’API di conversione è estesa con il codice di errore -9 che si verifica quando il convertitore non è in grado di determinare automaticamente il formato del file di output.

Questo errore significa che il client deve specificare esplicitamente in quale formato il file deve essere convertito: documento di testo o foglio di calcolo. Viene utilizzato per convertire XML in OOXML nel caso in cui il tipo XML sia sconosciuto.

{     
"error": -9 
}

Altri aggiornamenti

events.onRequestOpen evento utilizzato per visualizzare il pulsante Open source.
deleteForgotten, getForgotten e getForgottenList comandi per lavorare con i file dimenticati.
Il events.onRequestSelectSpreadsheet</ a> invece dell’evento deprecato events.onRequestMailMergeRecipients</u .
Il metodo setRequestedSpreadsheet invece dei setMailMergeRecipients deprecati. li>
Il events.onRequestSelectDocument</ a> invece dell’evento deprecato events.onRequestCompareFile</u .
Il metodo setRequestedDocument invece del deprecato setRevisedFile.

Inoltre, nell’API dell’app desktop, abbiamo aggiunto il parametro uiTheme pl comando portale:login che definisce le impostazioni del tema dell’editor quando si collegano gli editor desktop al cloud.

Ottieni l’ultima versione di ONLYOFFICE Docs Developer Edition:

SCARICA ORA

Miglioramento dell’API per i plugin

Il parametro di allineamento appena aggiunto del metodo ShowButton indica se il pulsante verrà visualizzato sul lato destro o sinistro della finestra. Il valore predefinito è “sinistra”.

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

Aggiornamenti API per Document Builder

Nell’API DocBuilder, abbiamo aggiunto più nuovi metodi di controllo del contenuto per filigrana e casella combinata ed elenco a discesa, diversi metodi globali e di diapositiva, inclusi i seguenti:

Controlla l’elenco completo dei nuovi metodi.

SCARICA BUILDER