ONLYOFFICE Docs 8.1 para desenvolvedores: atualizações de API

25 junho 2024By Klaibson

Junto com o lançamento dos novos recursos da versão 8.1, atualizamos a API para os editores, Document Builder e plugins, bem como adicionamos a seção Office API. Confira todos os detalhes abaixo.

Formulários PDF

A partir da versão 8.1, mudamos completamente para formulários PDF. Para criar e editar um formulário, os usuários não precisam mais de outros formatos. Isso significa que o formato docxf usado anteriormente para criar modelos de formulário agora está obsoleto.

A este respeito, verifique as seguintes atualizações da API:

documentType dos formatos docxf e oform foi alterado para pdf;
pdf field é adicionado à solicitação de conversão;
formsubmit a ação é adicionada à descoberta WOPI;
o parâmetro docs_api_config é adicionado ao elemento de formulário da página host WOPI.

Envio de formulário

O recém-adicionado onSubmit evento é chamado quando o formulário é enviado com sucesso. Isso pode tornar a ação de envio do formulário mais intuitiva para os usuários.

No exemplo de código abaixo, assim que o formulário for enviado com sucesso, uma mensagem será impressa no console. Por exemplo, você pode exibir algo como uma dica para os usuários “Seu formulário foi enviado com sucesso”.

var onSubmit = function (event) {
    console.log("The form was submitted.");
};
var docEditor = new DocsAPI.DocEditor("placeholder", {
    "events": {
        "onSubmit": onSubmit,
        ...
    },
    ...
});

Gerenciamento de funções de destinatário

Caso as funções do destinatário e as cores correspondentes às funções não sejam necessárias para seus formulários, você pode desativar a opção Gerenciar funções.

Para fazer isso, use o campo funções adicionado ao campo o parâmetro editorConfig.customization.features . Define se as configurações de função serão desabilitadas em formulários PDF ou não. Se o parâmetro for definido como falso, o gerenciador de função ficará oculto e a visualização do formulário em nome de uma função específica será desativada. Nesse caso, os botões Gerenciar funções e Visualizar formulário na guia Formulários e uma lista suspensa para definir a função do campo no painel direito não serão exibidos.

API de automação estendida

API de automação que torna possível interagir com arquivos de fora, apresenta vários novos métodos:

addContextMenuItem – para adicionar um item ao menu de contexto;
addToolbarMenuItem – para adicionar um item ao menu da barra de ferramentas;
updateContextMenuItem – para atualizar um item no menu de contexto com os itens especificados.

Por exemplo, se você deseja atualizar os itens do menu de contexto, use o método updateContextMenuItem. Aqui, passe um array com novos itens como argumento, especificando todos os parâmetros necessários para cada item. No exemplo de código abaixo, estamos passando um elemento com o ID “onConvert” e o texto “Converter para Markdown ou HTML”.

var items: [
    {
        "id": "onConvert",
        "text": getMessage("Convert to Markdown or HTML")
    }
]
connector.updateContextMenuItem(items);

Observação: a API de automação está incluída no Teste de 30 dias do ONLYOFFICE Docs Developer, para que você possa testá-lo gratuitamente. Se você planeja usar a API de automação para produção, precisará obter a licença com esta opção incluída.

Costumização

Use os parâmetros recém-adicionados para ajustar a interface dos editores.

O parâmetro editorConfig.customization.layout.header.editMode define se um botão para troca de modos será exibido no cabeçalho ou não.

Observação: este parâmetro de API está disponível para usuários com a licença estendida do Docs Developer. Para acessar essa função, envie sua solicitação.

ONLYOFFICE Docs 8.1 para desenvolvedores: atualizações de API

O campo visível do editorConfig.customization.logo parâmetro mostra ou oculta o logotipo (arquivo de imagem no canto superior esquerdo do cabeçalho do editor). Além disso, agora também está disponível para editores mobile.

Chave de fragmento para um cluster confiável

O WOPISrc O parâmetro de consulta introduzido na versão anterior é adicionado às solicitações do navegador para o servidor. Isso permite criar várias instâncias independentes do ONLYOFFICE. As solicitações de balanceamento de carga com WOPISrc garantem que a edição colaborativa funcione corretamente: todos os usuários que editam o mesmo documento são atendidos pelo mesmo servidor. Para WOPI é utilizado o parâmetro enviado pelo integrador. Para a API Docs, o novo parâmetro Shard key é usado.

O shardkey é adicionado ao URL QueryString ao enviar solicitações para o Document Command Service, Document Conversion Service ou Document Builder Service. O campo chave é usado como valor. Por exemplo, ?shardkey=Khirz6zTPdfd7. Se não houver chave no corpo, você não precisa enviá-la (por exemplo, no comando getForgottenList).

Outras atualizações de API para os editores

O -10 error code (limite de tamanho excedido) é adicionado à API de conversão.
O valor padrão do editorConfig.customization.hideRightMenu o parâmetro é alterado para verdadeiro (ou seja, o menu direito ficará oculto no primeiro carregamento).
O campo editorConfig.customization.layout.toolbar.home.mailmerge está obsoleto, use oeditorConfig.customization.layout.toolbar.collaboration.mailmerge em vez disso (já que o botão Mala direta foi movido para a guia Colaboração).
O editorConfig.customization.goback.requestClose campo está obsoleto, use o editorConfig.customization.close campo em vez disso.

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

BAIXE AGORA

Melhorias de API para plug-ins

A partir da versão 8.1, os plugins podem alterar a barra de ferramentas: criar suas próprias abas e preenchê-las, adicionar botões às abas padrão. Para fazer isso, use o método AddToolbarMenuItem .

ONLYOFFICE Docs 8.1 para desenvolvedores: atualizações de API

var oToolbarMenuItem = {
    "id": "MeaningItem",
    "type": "button",
    "text": "Meaning",
    "hint": "Meaning",
    "icons": "resources/light/icon.png",
    "disabled": false,
    "enableToggle": false,
    "lockInViewMode": false,
    "separator": true,
    "split": true,
    "items": [
        {
            "id": "onMeaningT",
            "text": "Explain text in comment"
        },
        {
            "id": "onFixSpelling",
            "text": "Fix spelling &amp; grammar"
        },
        {
            "id": "onMakeLonger",
            "text": "Make longer"
        },
        {
            "id": "onMakeShorter",
            "text": "Make shorter"
        }
    ]
};
var oToolbarMenuTab = {
    "id": "ChatGPT",
    "text": "AI Assistant",
    "items": [oToolbarMenuItem]
};
var oToolbarMenuMainItem = {
    "guid": "asc.{9DC93CDB-B576-4F0C-B55E-FCC9C48DD007}",
    "tabs": [oToolbarMenuTab]
};
window.Asc.plugin.executeMethod ("AddToolbarMenuItem", [[oToolbarMenuMainItem]]);

Além disso, os plugins agora podem criar não apenas múltiplas janelas, mas também vários painéis esquerdos. O parâmetro variations.menu especifica onde o plugin será colocado – no painel direito ou esquerdo.

Entre os novos métodos de plugin você encontrará:

Veja aqui a lista completa de plugins atualizados da API.

Python Framework para Document Builder

Para o ONLYOFFICE Document Builder, agora existe uma opções disponível do Python Builder Framework . Ele contém uma coleção de bibliotecas, classes e funções que tornam muito mais fácil o desenvolvimento rápido de aplicativos em Python que apresentam habilidades de criação de documentos.

Office API

Para sua conveniência e navegação mais fácil, movemos a biblioteca JavaScript para trabalhar com os editores para uma seção separada – Office JavaScript API.

Aqui, também adicionamos vários novos métodos para a versão 8.1, incluindo aqueles para: