Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы документов
Редакторы документов
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
ВКС и мессенджер
ВКС и мессенджер
Мобильные редакторы
Мобильные редакторы
Почтовый сервер
Почтовый сервер
Органайзер
Органайзер
Сервер лицензирования
Сервер лицензирования
Файл-Экспресс
Файл-Экспресс
Аналитика
Аналитика
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

InstallPlugin

Обновлено: 20.11.26

Инструкция актуальна для версий продукта: 2026.3.1.3296 – 2026.3.1.3906

Описание. Устанавливает плагин. Редактор скачивает архив плагина из папки deploy по адресу из поля baseUrl, распаковывает его в пользовательскую папку плагинов и сразу добавляет кнопку плагина на вкладку Плагины.

Редакторы: документы, таблицы, презентации.

Параметры

ПараметрТипОписание
configобъектСодержимое файла config.json устанавливаемого плагина с дополнительным полем baseUrl. Обязательны поля guid и baseUrl

Поле baseUrl — адрес папки плагина. В этой папке должна быть подпапка deploy с архивом плагина, имя архива совпадает с именем папки. Например, для

"baseUrl": "file:///C:/plugins/myplugin/"

редактор ищет файл C:/plugins/myplugin/deploy/myplugin.plugin:

myplugin/
└── deploy/
    └── myplugin.plugin

Архив .plugin собирается так же, как для установки через «Настройки»: ZIP с config.json и остальными файлами плагина в корне.

Локальный путь пишите с прямыми косыми чертами: file:///C:/plugins/myplugin/ или C:/plugins/myplugin/. Путь с обратными косыми (C:\\plugins\\myplugin\\) вызывает аварийное закрытие вкладки редактора, плагин при этом не устанавливается.

baseUrl может быть и адресом на сайте, например https://example.com/plugins/myplugin/. Тогда архив должен открываться по адресу https://example.com/plugins/myplugin/deploy/myplugin.plugin без входа на сайт: если сайт требует логин и пароль, плагин не установится и метод вернёт пустой guid.

Возвращаемое значение

Объект с результатом:

ПолеЗначение
typeВсегда «Installed»
guidGUID установленного плагина. Пустая строка, если установить не удалось

Проверяйте именно guid: поле type равно "Installed" и при неудачной установке.

Пример

var config = {
    "name": "My plugin",
    "guid": "asc.{7C3E9A10-2B4D-4F6E-8A1C-5D9B0E2F4A66}",
    "baseUrl": "file:///C:/plugins/myplugin/",
    "variations": [{
        "description": "My plugin",
        "url": "index.html",
        "icons": ["resources/icon.png", "resources/icon@2x.png"],
        "EditorsSupport": ["word"],
        "isVisual": true,
        "isModal": true,
        "buttons": [{ "text": "OK", "primary": true }]
    }]
};

window.Asc.plugin.executeMethod("InstallPlugin", [config], function (result) {
    if (result.guid) {
        console.log("Плагин установлен: " + result.guid);
    } else {
        console.log("Не удалось установить плагин");
    }
});

Строка с адресом config.json вместо объекта не подходит: метод вернёт пустой guid. Установленный плагин можно удалить методом RemovePlugin или корзиной в окне Настройки.

Была ли эта статья полезной?

Поделитесь пожалуйста своим мнением

      В статье есть ошибкиРекомендации не помоглиТекст трудно понятьСодержание статьи не соответствует заголовкуДругое