DiadocAPI

Объект для создания контекста работы в Диадок

Свойства

ApiClientId:

Строка, чтение/запись - ключ разработчика

ServerUrl:

Строка, чтение/запись - URL сервера Диадок

ProxyMode:

Строка, чтение/запись - режим использования прокси-сервера. Возможные значения

ProxySettings:

ProxySettings , чтение - настройки прокси-сервера

AutoLogonPolicy:

Строка, чтение/запись - настройка политики передачи авторизационных данных в запросах . Возможные значения

Добавлено в версии 5.32.0.

VerifySslCertificate:

Булево, чтение/запись - флага проверки SSL сертиифкатов при выполнении запросов

Добавлено в версии 5.32.0.

Методы

GetFullVersion()	VerifyThatUserHasAccessToAnyBox()	CreateConnectionByCertificate()
TestConnection2()	GetPersonalCertificates()	CreateConnectionByLogin()
UpdateProxySettings()

DiadocAPI.GetFullVersion()

Возвращает строку с версией используемой компоненты в формате [AddIn|COM] [x86|x64] <номер сборки>

Добавлено в версии 5.29.4.

DiadocAPI.TestConnection2()

Возвращает объект с результатами проверки соединения с сервером Диадока, используя установленные параметры

Добавлено в версии 5.26.3.

DiadocAPI.UpdateProxySettings(Connection)

Connection:Connection обновляемое подключение

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

Добавлено в версии 5.30.2.

DiadocAPI.VerifyThatUserHasAccessToAnyBox(Thumbprint)

Thumbprint:Строка Отпечаток сертификата

Возвращает булевый признак, означающий есть ли у пользователя с указанным сертификатом доступ к какой-либо организации в Диадок

DiadocAPI.GetPersonalCertificates(UserStore=true)

UserStore:Булево Флаг определяющий хранилище сертификатов, где будет осуществлен поиск. true - хранилище пользователя(по-умолчанию), false - хранилище компьютера.

Возвращает коллекцию сертификатов, установленных в подхранилище «Личное», хранилища определяемого флагом UserStore.

DiadocAPI.CreateConnectionByCertificate(Thumbprint[, Pin])

Thumbprint:Строка Отпечаток сертификата Pin:Строка Пин-код или пароль от контейнера сертификата

Возвращает объект логического соединения, созданного по сертификату с указанным отпечатком. Поиск сертификата происходит в хранилище Личное пользователя и, если там сертиифкат не найден - в хранилище Личное машины. Если Pin не задан, то будет использоваться пин-код/пароль, запомненный в крипто-провайдере или пустая строка

DiadocAPI.CreateConnectionByLogin(Login, Password)

Login:Строка Логин пользователя Password:Строка Пароль пользователя

Возвращает объект логического соединения, созданного по логину и паролю

Устаревшие методы

Метод	Когда устарел	Когда удалён	Рекомендуемая альтернатива
DiadocAPI.TestConnection()	5.26.3		DiadocAPI.TestConnection2()
DiadocAPI.GetVersion()	5.29.4		DiadocAPI.GetFullVersion()

DiadocAPI.GetVersion()

Возвращает строку с версией используемой компоненты

DiadocAPI.TestConnection()

Возвращает булевое значение успешности отправки запроса в Диадок, используя установленные параметры