API v4.5.6.0

Содержание

CryptoPlugin
Главный класс плагина. Реализует всю функциональность плагина. Для работы с плагином рекомендуется использовать модуль-обертку: https://github.com/AktivCo/rutoken-plugin-js

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

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

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

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

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

Асинхронный интерфейс

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

Cинхронный интерфейс

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

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