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

initialize

initialize(PlainObject licensing)

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

Аргументы:
licensing (Необязательный) (По-умолчанию: /JC-License/getActivationRequest)
Тип: 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:
  1. Отключение запросов к серверу лицензий.

    JCWebClient2.initialize({licensing:
                           {
                               activationRequestUrl: null
                           }});
    
  2. Передача URL, относительного к текущей странице.

    JCWebClient2.initialize({licensing:
                           {
                                  activationRequestUrl: "/getActivationRequest"
                           }});
    
  3. Передача URL, относительного к домену.

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

addEventListener

addEventListener(String name, Function callback)

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

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

Аргументы:
  • name

    наименование события. Принимаемые значения:

    • slotAdded – событие подключения слота (см. описание callback: slotAddedEvent);
    • slotRemoved – событие отключения слота (см. описание callback: slotRemovedEvent);
    • loginStateChanged – событие изменения состояния аутентификации на токене (см. описание callback: loginStateChangedEvent).
  • callback – сallback-функция, которая будет выполнена при получении соответствующего события.

removeEventListener

removeEventListener(String name, Function callback)

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

Аргументы:
  • name

    наименование события. Принимаемые значения:

    • slotAdded – событие подключения слота (см. описание callback: slotAddedEvent);
    • slotRemoved – событие отключения слота (см. описание callback: slotRemovedEvent);
    • loginStateChanged – событие изменения состояния аутентификации на токене (см. описание callback: loginStateChangedEvent).
  • callback – сallback-функция, которая была зарегистрирована ранее методом addEventListener().

isAsyncOperationInProgress

isAsyncOperationInProgress()

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

Результат:Booleantrue в случае если асинхронная операция выполняется, false в противном случае.

derToPem

derToPem(Array data)

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

Аргументы:
  • data – преобразуемые данные в формате DER.
Результат:

String – преобразованные данные в формате PEM.

defaults

defaults(PlainObject params)

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

Все параметры по-умолчанию хранятся в объекте, имеющем следующую структуру:
async (По-умолчанию: false)
Тип: Boolean
Признак синхронности (false) / асинхронности (true) выполнения команды (см. Установка режима выполнения команд).

Используется во всех командах.

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

Используется во всех командах.

antifraud
Тип: PlainObject
Набор параметров для работы с Антифрод-терминалом.
Параметры:
langID (По-умолчанию: JCWebClient2.Vars.AftLang.default)
Тип: Integer
Допустимые значения: JCWebClient2.Vars.AftLang
Идентификатор языка, используемого для отображения сообщений на экране Антифрод-терминала.

Используется в следующих командах: bindToken, changePIN, initUserPIN, unblockUserPIN, signData, signBase64EncodedData, aftSwyxDisplay.

timeout (По-умолчанию: 0)
Тип: Integer
Тайм-аут ожидания ввода от пользователя до отмены операции на Антифрод-терминале, в секундах.

Используется в следующих командах: bindToken, changePIN, initUserPIN, unblockUserPIN, signData, signBase64EncodedData.

Функция работает в двух режимах:
  1. Установка параметров. Если передан аргумент params.

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

    // Получить все параметры по-умолчанию.
    var allDefaults = JCWebClient2.defaults();
    
    // Получить определенный параметр
    var async = JCWebClient2.defaults().async;
    
Аргументы:
  • params

    устанавливаемые параметры.

    Параметры:
    async (Необязательный)
    Тип: Boolean
    Признак синхронности (false) / асинхронности (true) выполнения команды (см. Установка режима выполнения команд).
    errorToString (Необязательный)
    Тип: Boolean
    Признак конвертации полученной ошибки в строку.
    antifraud (Необязательный)
    Тип: PlainObject
    Набор параметров для работы с Антифрод-терминалом.
    Параметры:
    langID (Необязательный)
    Тип: Integer
    Допустимые значения: JCWebClient2.Vars.AftLang
    Идентификатор языка, используемого для отображения сообщений на экране Антифрод-терминала.
    timeout (Необязательный)
    Тип: Integer
    Тайм-аут ожидания ввода от пользователя до отмены операции на Антифрод-терминале, в секундах.
Результат:

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

exec

exec(PlainObject command)

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

Аргументы:
  • command

    выполняемая команда.

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

    Доступные значения см. в Справочнике команд.

    args (Необязательный)
    Тип: PlainObject
    Аргументы команды. Если аргументов у команды нет, то параметр можно не устанавливать.

    Доступные значения см. в Справочнике команд.

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

    Примечание

    Если при async равном false и отсутствии onResult не устанавливать параметр, то результат будет возвращен напрямую (см. пример Использование без callback-функций onSuccess / onError / onResult)

    Важно

    Параметр обязателен при async равном true и отсутствии onResult.

    onError (Необязательный)
    Тип: Function ( JCWebClientError | JCWebClientRequestError | Error | String | undefined error )
    Callback – функция, срабатывающая если при выполнении команды произошла ошибка.
    Данные об ошибке передаются в аргумент error.

    Примечание

    Если при async равном false и отсутствии onResult не устанавливать параметр, то ошибка вернется через сгенерированое исключение (см. пример Использование без callback-функций onSuccess / onError / onResult)

    Важно

    Параметр обязателен при async равном true и отсутствии onResult.

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

    Примечание

    Если при async равном false и отсутствии onSuccess, onError не устанавливать параметр, то результат будет возвращен напрямую, а ошибка через сгенерированое исключение (см. пример Использование без callback-функций onSuccess / onError / onResult).

    Важно

    Параметр приоритетнее onSuccess и onError.

Результат:

Integer | Boolean | String | Array | PlainObject | undefined - результат выполнения команды, если async равен false и не установлены onSuccess или onResult (см. пример Использование без callback-функций onSuccess / onError / onResult).