Служебные функции JC-WebClient

USB-токены и смарт-карты JaCartaAPI и SDKUSB-токены и смарт-карты JaCarta

addEventListener

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

Примеры в разделе Работа с событиями.

Аргументы:

name

Тип: String
Описание: Наименование события. Принимаемые значения:
- slotAdded – событие подключения слота (см. описание callback: slotAddedEvent);
- slotRemoved – событие отключения слота (см. описание callback: slotRemovedEvent);
- loginStateChanged – событие изменения состояния аутентификации на токене (см. описание callback: loginStateChangedEvent).

callback

Тип: Function
Описание: Callback-функция, которая будет выполнена при получении соответствующего события.

defaults

Установка параметров по умолчанию (см. Использование defaults).

Все параметры по умолчанию хранятся в объекте, имеющем следующую структуру:

async (Необязательный)

Тип: Boolean
По умолчанию: false
Описание: Признак синхронности (false) / асинхронности (true) выполнения команды (см. Установка режима выполнения команд). Используется во всех командах.

errorToString (Необязательный)

Тип: Boolean
По умолчанию: false
Описание: Признак конвертации полученной ошибки в строку. Влияет на тип параметра error в callback-функциях onError и onResult функции exec. Используется во всех командах.

antifraud (Необязательный) устаревшее

Тип: PlainObject
Описание: Набор параметров для работы с Антифрод-терминалом.

Параметры:

langID (Необязательный)

Тип: Integer
По умолчанию: JCWebClient2.Vars.AftLang.default
Допустимые значения: JCWebClient2.Vars.AftLang
Описание: Идентификатор языка, используемого для отображения сообщений на экране Антифрод-терминала. Используется в следующих командах: bindToken, changePIN, initUserPIN, unblockUserPIN, signData, signBase64EncodedData, aftSwyxDisplay.

timeout (Необязательный)

Тип: Integer
По умолчанию: 0
Описание: Тайм-аут ожидания ввода от пользователя до отмены операции на Антифрод-терминале, в секундах. Используется в следующих командах: bindToken, changePIN, initUserPIN, unblockUserPIN, signData, signBase64EncodedData.

Функция работает в двух режимах:

Установка параметров. Если передан аргумент params.
```
JCWebClient2.defaults({ async: true });
```

Получение параметров. Если не передан аргумент params.

// Получить все параметры по умолчанию.
var allDefaults = JCWebClient2.defaults();

// Получить определенный параметр
var async = JCWebClient2.defaults().async;

Результат: PlainObject – параметры по умолчанию, если метод вызывается в режиме Получения параметров.

derToPem

Конвертация данных из формата DER в формат PEM.

Аргументы:

data

Тип: Array
Описание: Преобразуемые данные в формате DER.

Результат: String – преобразованные данные в формате PEM.

exec

Выполнение команды.

Примеры использования представлены в разделе Выполнение команд.

Аргументы:

command

Тип: PlainObject
Описание: Выполняемая команда.

Параметры:

async

Тип: Boolean
По умолчанию: JCWebClient2.defaults().antifraud.async
Описание: Признак синхронности (false) / асинхронности (true) выполнения команды (см. Установка режима выполнения команд).

cmd

Тип: PlainObject
Описание: Тип выполняемой команды. Доступные типы команд находятся в объекте JCWebClient2.Cmds. Доступные значения см. в Справочнике команд.

args (Необязательный)

Тип: PlainObject
Описание: Аргументы команды. Если аргументов у команды нет, то параметр можно не устанавливать. Доступные значения см. в Справочнике команд.

onSuccess (Необязательный)

Тип: Function (Integer | Boolean | String | Array | PlainObject | undefined result)
Описание: Callback-функция, срабатывающая при успешном выполнении команды. Результат выполнения команды передается в аргумент result (undefined – если команда ничего не возвращает).

initialize

Функция служит для инициализации работы с JC-WebClient. Необходимо вызывать её первой.

Аргументы:

licensing (Необязательный)

Тип: PlainObject
Описание: Объект, задающий параметры работы лицензируемых функций. К лицензируемым функциям относятся Функции получения данных клиентского ПК.

Параметры:

activationRequestUrl (Необязательный)

Тип: String
Описание: Относительный путь для обращений к серверу лицензий.

При формировании параметра необходимо учитывать несколько особенностей. Параметр может быть передан как:

null-значение. Если передать значение null, то запросы к серверу выполнятся не будут.
Строка, содержащая URL относительный к домену. Например, “getActivationRequest”. В этом случае при вызове со страницы с адресом http://somebank.ru/PortalOpen/somepage1, запросы будут всегда идти на http://somebank.ru/getActivationRequest независимо от пути текущей страницы.
Строка, начинающаяся со слеша, содержащая URL относительный к URL текущей странице. Например, “/getActivationRequest”. В этом случае, при вызове со страницы с адресом http://somebank.ru/PortalOpen/somepage1, запросы будут идти на адрес http://somebank.ru/PortalOpen/getActivationRequest.

Примеры работы с параметром activationRequestUrl:

Отключение запросов к серверу лицензий.

JCWebClient2.initialize({ licensing: { activationRequestUrl: null } });

Передача URL, относительного к текущей странице.

JCWebClient2.initialize({ licensing: { activationRequestUrl: "/getActivationRequest" } });

Передача URL, относительного к домену.

JCWebClient2.initialize({ licensing: { activationRequestUrl: "getActivationRequest" } });

license_data (Необязательный)

Тип: String
Описание: Лицензия-подписка в виде строки.

removeEventListener

Удалить подписку на уведомление о событиях изменения состояния слотов и изменении состояния аутентификации на токене.

Аргументы:

name

Тип: String
Описание: Наименование события. Принимаемые значения:
- slotAdded – событие подключения слота (см. описание callback: slotAddedEvent);
- slotRemoved – событие отключения слота (см. описание callback: slotRemovedEvent);
- loginStateChanged – событие изменения состояния аутентификации на токене (см. описание callback: loginStateChangedEvent).

callback

Тип: Function
Описание: Callback-функция, которая была зарегистрирована ранее методом addEventListener().