API v4.10.0.0

Содержание

CryptoPlugin
Главный класс, реализующий всю функциональность Рутокен Плагин.

Для работы с плагином рекомендуется использовать модуль-обертку.

Интерфейсные функции класса CryptoPlugin могут быть вызваны тремя различными способами:

  • с использованием promise (новый асинхронный интерфейс);
  • асинхронно с использованием функций обратного вызова (устаревший асинхронный интерфейс);
  • синхронно (устаревший синхронный интерфейс).

В результате выполнения функций Рутокен Плагин возвращается либо результат выполнения в соответствии с документацией на функцию, либо объект ошибки. Объект ошибки содержит поле message:string, позволяющее определить причину ошибки. В случае, если ошибка возвращается с функционального уровня Рутокен Плагин, message содержит строковое представление кода ошибки.

Новый асинхронный интерфейс

Все интерфейсные функции плагина работают асинхронно и возвращают promise. Сразу после вызова все функции возвращают управление. В случае успеха возвращенный promise переходит в состояние "fulfilled", и в обработчик передается результат выполнения функции. В случае ошибки promise переходит в состояние "rejected", и в обработчик передается объект ошибки.

Устаревший интерфейс

В целях сохранения совместимости плагин поддерживает старый интерфейс, основанный на функциях обратного вызова. Мы рекомендуем использовать новый интерфейс с promise.

Интерфейсные функции плагина могут вызываться двумя способами: асинхронно и синхронно. При использовании синхронных вызовов происходит блокирование интерфейса браузера на время выполнения функции.

Устаревший асинхронный интерфейс

Все функции принимают resultCallback и errorCallback двумя последними параметрами и работают асинхронно. Сразу после вызова все функции возвращают управление. Функция вызывает resultCallback в случае успешного выполнения и errorCallback в случае ошибки. resultCallback принимает один параметр - результат выполнения операции. errorCallback - принимает объект ошибки Рутокен Плагин первым параметром.

Устаревший синхронный интерфейс

Для вызова методов плагина синхронно достаточно не передавать в качестве последних двух параметров функции обратного вызова. На время выполнения метода происходит передача управления плагину, и блокируется пользовательский интерфейс браузера. При успешном завершении функции результат будет возвращен из вызванного метода, в случае ошибки будет создано исключение.
errorCodes
Объект, содержащий коды ошибок Рутокен Плагин.

Внимание!

Рутокен Плагин может возвращать ошибки из подсистем, которые не входят в документацию.

Пример функции задания описаний кодов возврата.