Класс Policy
Получение информации о сервере
Метод getParamDSS
Запрос параметров (настроек) сервиса.
fun getParamsDSS(serviceUrl: String, sdkResultCallback: SdkResultCallback<ParamsDss>)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| serviceUrl | String | Адрес сервиса взаимодействия с мобильным приложением (пример: https:/hostname:4430/mdagname) |
| callback | SdkResultCallback<ParamsDss> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| ParamsDss | настройки взаимодействия с сервером |
Метод getParamDSS (suspend)
Запрос параметров (настроек) сервиса.
suspend fun getParamsDSS(serviceUrl: String): ParamsDss
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| serviceUrl | String | Адрес сервиса взаимодействия с мобильным приложением (пример: https:/hostname:4430/mdagname) |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| ParamsDss | настройки взаимодействия с сервером |
Метод getCaParams
Запрос с сервера параметров подписи: список профилей подписи, параметры обработчиков запросов на сертификат и т.п.
fun getCaParams(
context: Context,
kid: String,
sdkResultCallback: SdkResultCallback<CaParams>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<CaParams> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| CaParams | Настройки Сервиса Подписи |
Метод getCaParams (suspend)
Запрос с сервера параметров подписи: список профилей подписи, параметры обработчиков запросов на сертификат и т.п.
suspend fun getCaParams(
context: Context,
kid: String
): CaParams
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| CaParams | Настройки Сервиса Подписи |
Работа с операциями и историей операций
Метод getHistoryOperations
Получение записей аудита для определенного пользователя и устройства.
fun getHistoryOperations(
context: Context,
kid: String,
count: Int?,
bookmark: Int?,
notBefore: Long?,
notAfter: Long?,
operationCodeList: List<Int>?,
sdkResultCallback: SdkResultCallback<OperationHistory>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| count | Int? | Выводимое количество записей |
| bookmark | Int? | Идентификатор записи, относительно которой осуществляется поиск. Будут отображены события, начиная с указанной записи |
| notBefore | Long? | Нижняя граница поиска (UNIX TIME). Если не указан, то в ответе будет получена информация за 30 дней |
| notAfter | Long? | Верхняя граница поиска (UNIX TIME) |
| operationCodeList | ArrayList<Integer> | Разделенный запятой список кодов событий, которые должны быть включены в выборку |
| callback | SdkResultCallback<OperationHistory> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| OperationHistory | Cписок записей аудита для определенного пользователя |
Метод getHistoryOperations (suspend)
Получение записей аудита для определенного пользователя и устройства.
suspend fun getHistoryOperations(
context: Context,
kid: String,
count: Int?,
bookmark: Int?,
notBefore: Long?,
notAfter: Long?,
operationCodeList: List<Int>?
): OperationHistory
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| count | Int? | Выводимое количество записей |
| bookmark | Int? | Идентификатор записи, относительно которой осуществляется поиск. Будут отображены события, начиная с указанной записи |
| notBefore | Long? | Нижняя граница поиска (UNIX TIME). Если не указан, то в ответе будет получена информация за 30 дней |
| notAfter | Long? | Верхняя граница поиска (UNIX TIME) |
| operationCodeList | ArrayList<Integer> | Разделенный запятой список кодов событий, которые должны быть включены в выборку |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| OperationHistory | Cписок записей аудита для определенного пользователя |
Метод getOperationInfo
Получение списка операций.
fun getOperationInfo(
context: Context,
kid: String,
interval: Int?,
opId: String?,
sdkResultCallback: SdkResultCallback<OperationsState>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| interval | Int? | (опционально) Интервал времени в секундах, за который нужно получить список операций |
| opId | String? | (опционально) Идентификатор операции |
| callback | SdkResultCallback<OperationsState> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр Описание |
|---|
| OperationsState |
Метод getOperationInfo (suspend)
Получение списка операций.
suspend fun getOperationInfo(
context: Context,
kid: String,
interval: Int?,
opId: String?
): OperationsState
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| interval | Int? | (опционально) Интервал времени в секундах, за который нужно получить список операций |
| opId | String? | (опционально) Идентификатор операции |
Возвращаемые параметры:
| Параметр Описание |
|---|
| OperationsState |
Метод getOperations
Получение списка операций, требующих подтверждения.
fun getOperations(
context: Context,
kid: String,
type: String?,
opId: String?,
clientId: String?,
sdkResultCallback: SdkResultCallback<OperationsInfo>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| type | String? | (опционально) Тип операции |
| opId | String? | (опционально) Идентификатор операции |
| clientId | String? | (опционально) Идентификатор прикладной системы на сервере (OAuth-клиента) |
| callback | SdkResultCallback<OperationsInfo> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр Описание |
|---|
| OperationsInfo |
Метод getOperations (suspend)
Получение списка операций, требующих подтверждения.
suspend fun getOperations(
context: Context,
kid: String,
type: String?,
opId: String?,
clientId: String?
): OperationsInfo
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| type | String? | (опционально) Тип операции |
| opId | String? | (опционально) Идентификатор операции |
| clientId | String? | (опционально) Идентификатор прикладной системы на сервере (OAuth-клиента) |
Возвращаемые параметры:
| Параметр Описание |
|---|
| OperationsInfo |
Работа с устройствами пользователей
Метод getUserDevices
Получение сведений об устройствах пользователя.
fun getUserDevices(
context: Context,
kid: String,
sdkResultCallback: SdkResultCallback<List<DeviceInfo>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| callback | SdkResultCallback<List<DeviceInfo>> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| ListDeviceInfo | Сведения об устройствах пользователя |
Метод getUserDevices (suspend)
Получение сведений об устройствах пользователя.
suspend fun getUserDevices(context: Context, kid: String): List<DeviceInfo>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
Возвращаемые параметры:
| Тип | Описание |
|---|---|
| ListDeviceInfo | Сведения об устройствах пользователя |
Метод updateDeviceInfo
Обновление сведений о мобильном устройстве пользователя.
fun updateDeviceInfo(
context: Context,
kid: String,
updateInfo: RegisterInfo,
sdkResultCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| updateInfo | RegisterInfo | новые сведения об устройстве |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод updateDeviceInfo (suspend)
Обновление сведений о мобильном устройстве пользователя.
suspend fun updateDeviceInfo(
context: Context,
kid: String,
updateInfo: RegisterInfo
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| updateInfo | RegisterInfo | новые сведения об устройстве |