DiadocAPI

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

Свойства

ApiClientId:Строка, чтение/запись - ключ разработчика
ServerUrl:Строка, чтение/запись - URL сервера Диадок
ProxyMode:Строка, чтение/запись - режим использования прокси-сервера
ProxySettings:ProxySettings , чтение - настройки прокси-сервера

Методы

CreateConnectionByCertificate() GetVersion() GetFullVersion()
CreateConnectionByLogin() TestConnection() VerifyThatUserHasAccessToAnyBox()
GetPersonalCertificates() TestConnection2()  
DiadocAPI.CreateConnectionByCertificate(Thumbprint[, Pin])
Thumbprint:Строка Отпечаток сертификата
Pin:Строка Пин-код или пароль от контейнера сертификата

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

DiadocAPI.CreateConnectionByLogin(Login, Password)
Login:Строка Логин пользователя
Password:Строка Пароль пользователя

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

DiadocAPI.GetPersonalCertificates(UserStore=true)
UsePersonalStore:Булево Поиск производится в хранилище пользователя

Возвращает коллекцию сертификатов, установленных в хранилище Личное. Поиск может производиться в хранилище пользователя или машины

DiadocAPI.GetVersion()

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

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

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

DiadocAPI.TestConnection()

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

Не рекомендуется, начиная с версии 5.26.3: Используйте TestConnection2()

DiadocAPI.TestConnection2()

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

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

DiadocAPI.VerifyThatUserHasAccessToAnyBox(Thumbprint)
Thumbprint:Строка Отпечаток сертификата

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

Дополнительная информация

Значение ProxyMode Описание
NoProxy не использовать прокси-сервер при подключении
UseProxy использовать настройки прокси-сервера, указанные в ProxySettings
UseDefaultProxy использовать прокси-сервер по умолчанию