DiadocAPI¶
Объект для создания контекста работы в Диадок
Свойства
ApiClientId: | Строка, чтение/запись - ключ разработчика |
---|---|
ServerUrl: | Строка, чтение/запись - URL сервера Диадок |
ProxyMode: | Строка, чтение/запись - режим использования прокси-сервера. Возможные значения |
ProxySettings: | ProxySettings , чтение - настройки прокси-сервера |
AutoLogonPolicy: | Строка, чтение/запись - настройка политики передачи авторизационных данных в запросах . Возможные значения Добавлено в версии 5.32.0. |
VerifySslCertificate: | Булево, чтение/запись - флага проверки SSL сертиифкатов при выполнении запросов Добавлено в версии 5.32.0. |
Методы
-
DiadocAPI.
CreateConnectionByCertificate
(Thumbprint[, Pin])¶ Thumbprint: Строка
Отпечаток сертификатаPin: Строка
Пин-код или пароль от контейнера сертификатаВозвращает объект логического соединения, созданного по сертификату с указанным отпечатком. Поиск сертификата происходит в хранилище Личное пользователя и, если там сертиифкат не найден - в хранилище Личное машины. Если Pin не задан, то будет использоваться пин-код/пароль, запомненный в крипто-провайдере или пустая строка
-
DiadocAPI.
CreateConnectionByLogin
(Login, Password)¶ Login: Строка
Логин пользователяPassword: Строка
Пароль пользователяВозвращает объект логического соединения, созданного по логину и паролю
-
DiadocAPI.
GetPersonalCertificates
(UserStore=true)¶ UserStore: Булево
Флаг определяющий хранилище сертификатов <https://docs.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores>_, где будет осуществлен поиск. true - хранилище пользователя(по-умолчанию), false - хранилище компьютера.Возвращает коллекцию сертификатов, установленных в подхранилище «Личное», хранилища определяемого флагом UserStore.
-
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: Строка
Отпечаток сертификатаВозвращает булевый признак, означающий есть ли у пользователя с указанным сертификатом доступ к какой-либо организации в Диадок
-
DiadocAPI.
UpdateProxySettings
(Connection)¶ Connection: Connection обновляемое подключение Метод обновляет настройки прокси у переданного объекта подключения и у всех объектов, полученных с помощью него
Добавлено в версии 5.30.2.