ONLYOFFICE Docs 8.0 para desenvolvedores: atualizações da API e do Doc Builder

5 fevereiro 2024By Klaibson

Juntamente com o lançamento dos novos recursos na versão 8.0, atualizamos a API para os editores, o Criador de documentos e os plug-ins. Verifique todos os detalhes abaixo.

ONLYOFFICE Docs 8.0 para desenvolvedores: API e Doc Builder updates

Suporte PDF

Adicionamos o tipo de documento pdf ao parâmetro documentType . Isto significa que os ficheiros PDF*, incluindo os que contêm campos preenchíveis, são agora totalmente suportados e podem ser abertos para anotação e preenchimento no ONLYOFFICE PDF Editor (anteriormente, esses ficheiros eram reconhecidos como documentos e abertos no editor de documentos).

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

*Também DjVu, OXPS e XPS

API para trabalhar com formulários

O parâmetro formsdataurl adicionado ao manipulador de retorno de chamada permite definir a URL para o arquivo JSON com os dados do formulário enviado. Este ficheiro contém os seguintes parâmetros:

  • key
  • tag
  • value
  • type (texto, caixa de seleção, imagem, caixa de combinação, lista suspensa, data e hora, rádio)

Além disso, você encontrará novos métodos de formulário no DocBuilder API:

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

Suporte WOPI aprimorado

A última versão traz o parâmetro de consulta WOPISrc  que é adicionado às solicitações do navegador para o servidor. Isto permite-lhe criar várias instâncias independentes do ONLYOFFICE. Pedidos de balanceamento de carga com WOPISrc certifique-se de que a edição colaborativa funciona corretamente: todos os utilizadores que editam o mesmo documento são servidos pelo mesmo servidor.

Para o WOPI, é utilizado o parâmetro enviado pelo integrador. Para a API Docs, o document.key parâmetro é escrito para WOPISrc.

Conversão API

A marca d’água o campo adicionado à solicitação de conversão define um objeto JSON contendo o propriedades de uma marca d’água que é inserida nos ficheiros PDF e de imagem durante a conversão.

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

Suporte para Bancos de dados Oracle e Microsoft SQL Server

Entre os bancos de dados suportados, existem agora também Oracle e Microsoft SQL Server. Para conectá-lo, altere o tipo de banco de dados para oracle / mssql. Para o Docker, você precisará ajustar o parâmetro DB_TYPE .

Além disso, você pode usar:

  • Advanced connection settings for oracle – oracleExtraOptions
  • Advanced connection settings for mssql – msSqlExtraOptions

Avatares de usuários

A partir da versão 8.0, é possível adicionar avatares de usuário a serem exibidos nos editores para melhor visualização da equipe.

Assim, o info o tipo de operação é adicionado ao setUsers método e onRequestUsers evento para definir os avatares para os utilizadores com os IDs especificados no parâmetro data.id . E o recém-adicionado users.image campo define o caminho para o avatar do utilizador.

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

Além disso, o parâmetro editorConfig.user agora contém o campo de imagem para definir o caminho para o avatar do Usuário:

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

Mais atualizações de API para os editores

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

BAIXE AGORA

Melhorias na API para plugins

Os métodos de plug-in recém-adicionados permitem lançar e gerenciar apresentações de slides:

Veja abaixo vários exemplos de código:

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

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

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

Outras atualizações da API para o Document Builder

No DocBuilder API, também adicionamos vários painéis de congelamento e métodos de comentário, e alguns outros, incluindo os seguintes:

Verifique a lista completa dos novos métodos.

BAIXE O BUILDER