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

OnEncryption

Обновлено: 13.08.25

window.Asc.plugin.executeMethod («OnEncryption», [args], callback)

Описание
Определяет метод, позволяющий зашифровать документ.

Применение
Этот метод следует использовать следующим образом:

window.Asc.plugin.executeMethod ("OnEncryption", [obj]);
Параметры
Параметр Описание Тип Пример
obj Свойства шифрования. Этот объект может иметь следующие значения:

  • type — тип операции шифрования (generatePassword — генерирует пароль к документу, getPasswordByFile — отправляет пароль при открытии документа, setPasswordByFile — устанавливает пароль к документу, encryptData — шифрует изменения при совместном редактировании, decryptData — расшифровывает изменения при совместном редактировании редактирование),
    тип: строковый,
    пример: «encryptData»;
  • password -строковое значение, указывающее пароль для доступа к документу,
    тип: строковый,
    пример: «password»;
  • data — зашифрованные/расшифрованные изменения,
    тип: строковый,
    пример: «{data}»;
  • check — проверяет успешность операции шифрования/дешифрования (используется только для типов encryptData/decryptData),
    тип: логический,
    пример: true;
  • docinfo — незашифрованная часть зашифрованного файла,
    тип: строковый,
    пример: «{docinfo}»;
  • hash — строковое значение, указывающее хэш файла (по умолчанию sha256),
    тип: строковый,
    пример: «sha256»;
  • error — строковое значение, указывающее возникшую ошибку (значение «» означает, что операция прошла успешно),
    тип: строковый,
    пример: «no_build».
объект

Возвращает
Метод возвращает неопределенное значение.

Пример

window.Asc.plugin.executeMethod("OnEncryption", [{"type": "getPasswordByFile", "hash": "sha256", "docinfo": "{docinfo}"}]);