  checkSessionState – проверить состояние регистрации сессии Агента веб-доступа
Синтаксис:
checkSessionState()
Возвращаемое значение:
True – сессия Агента веб-доступа зарегистрирована, иначе False.
|
disable – включить запрет на использование и запуск Агента веб-доступа
Синтаксис:
disable()
Возвращаемое значение:
Объект типа agent.
|
enable – отключить запрет на использование и запуск Агента веб-доступа
Синтаксис:
enable()
Возвращаемое значение:
Объект типа agent.
|
getInstallationStep – получает номер шага установки Агента веб-доступа
Синтаксис:
getInstallationStep()
Возвращаемое значение:
Номер шага.
|
isAvailable – проверить, доступен ли Агент веб-доступа
Синтаксис:
isAvailable()
Возвращаемое значение:
True – Агент веб-доступа доступен для работы, иначе False.
Пример:
if (WebAccess.agent.isAvailable()) {
alert('На текущем компьютере Агент веб-доступа установлен и доступен для работы.');
};
|
isDisabled – проверить, включен ли запрет на использование и запуск Агента веб-доступа
Синтаксис:
isDisabled()
Возвращаемое значение:
True – запрет на использование и запуск Агент веб-доступа включен, иначе False.
|
isInstallationDisabledForever – признак того, что сообщение с предложением об установке Агента веб-доступа не будет отображаться
Синтаксис:
isInstallationDisabledForever()
Возвращаемое значение:
True – сообщение с предложением об установке Агента веб-доступа не будет отображаться, иначе False.
|
isInstalled – проверить, установлен ли Агент веб-доступа для текущего браузера
Синтаксис:
isInstalled()
Возвращаемое значение:
True – Агент веб-доступа установлен для текущего браузера, иначе False.
|
isPluginAvailable – проверить, доступен ли плагин Агента веб-доступа
Синтаксис:
isPluginAvailable(pluginName)
Параметры:
Имя
|
Тип
|
Описание
|
pluginName
|
string
|
Имя плагина
|
Возвращаемое значение:
True – плагин Агента веб-доступа доступен для работы, иначе False.
Пример:
if (WebAccess.agent.isPluginAvaialable('edmsplugin') {
alert('Плагин Агента веб-доступа доступен для работы с EDMS-объектами системы DIRECTUM');
}
|
isSessionInitialized – проверить, что сессия Агента веб-доступа инициализирована
Синтаксис:
isSessionInitialized()
Возвращаемое значение:
True – сессия Агента веб-доступа инициализирована, иначе False.
|
isStarted – проверить, выполнен ли запуск Агента веб-доступа
Синтаксис:
isStarted()
Возвращаемое значение:
True – Агент веб-доступа запущен, иначе False.
|
keepAlive – поддерживать жизнь сессии Агента веб-доступа
Синтаксис:
keepAlive()
Возвращаемое значение:
Объект типа agent.
|
restart – перезапуск Агента веб-доступа
Синтаксис:
restart()
Возвращаемое значение:
Объект типа agent.
|
setAvailable – установить признак доступности Агента веб-доступа
Синтаксис:
setAvailable(value)
Параметры:
Имя
|
Тип
|
Описание
|
value
|
boolean
|
Устанавливаемое значение
|
Возвращаемое значение:
Объект типа agent.
|
setInstallationDisabledForever – установить признак, что сообщение об установке Агента веб-доступа не будет отображаться
Синтаксис:
setInstallationDisabledForever(value)
Параметры:
Имя
|
Тип
|
Описание
|
value
|
boolean
|
Устанавливаемое значение
|
Возвращаемое значение:
Объект типа agent.
|
setInstallationStep – задать номер шага установки Агента веб-доступа
Синтаксис:
setInstallationStep()
Возвращаемое значение:
Объект типа agent.
|
setInstalled – установить признак, что Агент веб-доступа установлен
Синтаксис:
setInstalled(value)
Параметры:
Имя
|
Тип
|
Описание
|
value
|
boolean
|
Устанавливаемое значение
|
Возвращаемое значение:
Объект типа agent.
|
setLanguage – установить языковые настройки текущей сессии Агента веб-доступа
Синтаксис:
setLanguage(language)
Параметры:
Имя
|
Тип
|
Описание
|
language
|
string
|
Текущий язык. Возможные значения: ru, en
|
Возвращаемое значение:
Объект типа agent.
|
setSessionInitialized – установить признак инициализации сессии Агента веб-доступа
Синтаксис:
setSessionInitialized(value)
Параметры:
Имя
|
Тип
|
Описание
|
value
|
boolean
|
Устанавливаемое значение
|
Возвращаемое значение:
Объект типа agent.
|
setStarted – установить признак, что Агент веб-доступа запущен
Синтаксис:
setStarted(value)
Параметры:
Имя
|
Тип
|
Описание
|
value
|
boolean
|
Устанавливаемое значение
|
Возвращаемое значение:
Объект типа agent.
|
start – запуск Агента веб-доступа
Синтаксис:
start(opt_force)
Параметры:
Имя
|
Тип
|
Обязательность
|
Описание
|
opt_force
|
boolean
|
Нет
|
Принудительный запуск Агента веб-доступа. Запуск выполняется при любых условиях
|
Возвращаемое значение:
Специальный deferred-объект.
|
stop – остановить работу Агента веб-доступа
Синтаксис:
stop()
Возвращаемое значение:
Объект типа agent.
Описание:
Используется для повторного соединения веб-страницы с Агентом веб-доступа.
|
transmitRequest – отправить запрос Агенту веб-доступа, используя доступный транспорт
Синтаксис:
transmitRequest(requestName, pluginName, params)
Параметры:
Имя
|
Тип
|
Описание
|
requestName
|
string
|
Имя запроса
|
pluginName
|
string
|
Имя плагина Агента, к которому идет обращение. Для базовых вызовов к ядру Агента веб-доступа передается пустая строка
|
params
|
object
|
Параметры запроса
|
Возвращаемое значение:
Результат запроса.
Описание:
Транспорт – это один из механизмов для взаимодействия с Агентом веб-доступа. Например, NPAPI-транспорт или HTTP-транспорт.
Пример:
var response = WebAccess.agent.transmitRequest('PING','',{});
* console.log(response) // Object {message="PONG", success=true}.
|
|
