ONLYOFFICE Docs 7.5 para desenvolvedores: atualizações de API e Doc Builder

24 outubro 2023Por Klaibson

Junto com o lançamento dos novos recursos na versão 7.5, atualizamos a API para os editores, Document Builder, plug-ins e aplicativo de desktop. Confira todos os detalhes abaixo.

API para trabalhar com formulários

Ocultar/mostrar o botão Enviar formulário. Usando o parâmetro editorConfig.customization.submitForm , é possível definir se o botão Enviar será exibido ou oculto na barra de ferramentas superior para arquivos OFORM.

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

Parâmetro adicional para Force Save. Na versão 7.5, adicionamos o tipo 3 para o forcesavetype parâmetro do manipulador de retorno de chamada. Se aplicado, a solicitação de salvamento forçado é executada sempre que o formulário é enviado, por exemplo. quando o Submit botão é clicado.

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

API para trabalhar com documentos

Alterando uma fonte de dados externos. O recém-adicionado events.onRequestReferenceSource O evento é chamado quando um usuário está tentando alterar uma fonte de dados externos clicando no botão Alterar fonte nos editores. Um objeto com os dados exclusivos do arquivo e o caminho ou nome do arquivo são enviados no parâmetro data.

Quando o botão é clicado, você deve chamar o setReferenceSource método para alterar uma fonte de dados externos. Ao chamar este método, o token deve ser adicionado para validar os parâmetros. Se o evento não for declarado, o botão Alterar fonte não será exibido.

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 chave. O campo-chave adicionado ao parâmetro document.referenceData define o identificador exclusivo do documento usado pelo serviço para obter os dados da sessão de coedição.

Caso a chave conhecida seja enviada, o documento será retirado do cache. Cada vez que o documento é editado e salvo, a chave deve ser gerada novamente.

O URL do documento pode ser usado como chave, mas sem os caracteres especiais e o comprimento é limitado a 128 símbolos.

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

API de conversão

API de Conversão é estendido com o -9 error code que ocorre quando o conversor não consegue determinar automaticamente o formato do arquivo de saída.

Este erro significa que o cliente deve especificar explicitamente em qual formato o arquivo deve ser convertido – documento de texto ou planilha. É usado para converter XML em OOXML caso o tipo XML seja desconhecido.

{     
"error": -9 
}

Outras atualizações

events.onRequestOpen evento usado para exibir o botão Open source.
deleteForgotten, getForgotten, e getForgottenList comandos para trabalhar com arquivos esquecidos.
O events.onRequestSelectSpreadsheet evento em vez do obsoleto events.onRequestMailMergeRecipients.
O setRequestedSpreadsheet método em vez do obsoleto setMailMergeRecipients.
O events.onRequestSelectDocument evento em vez do obsoleto events.onRequestCompareFile.
O setRequestedDocument método em vez do obsoleto setRevisedFile.

Além disso, no desktop app API, nós adicionamos o parâmetro uiTheme ao comando portal:login que define as configurações do tema do editor ao conectar os editores de desktop à nuvem.

Obtenha a versão mais recente do ONLYOFFICE Docs Developer Edition:

BAIXE AGORA

Aprimoramento de API para plug-ins

O parâmetro de alinhamento recém-adicionado do ShowButton método indica se o botão será exibido no lado direito da janela ou no lado esquerdo. O valor padrão é “esquerda”.

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

Atualizações de API para o Document Builder

Na API da DocBuilder, adicionamos vários novos métodos de controle de conteúdo de marca d’água e caixa de combinação e lista suspensa, vários métodos globais e de slide, incluindo os seguintes:

Verifica a lista completa de novos métodos.

BAIXAR BUILDER