Класс Sign
Метод signMT
Подтверждение операции, созданной на сервере.
fun signMT(
context: Context,
kid: String,
operation: Operation?,
enableMultiSelection: Boolean,
immediateSendConfirm: Boolean,
silent: Boolean,
sdkResultCallback: SdkResultCallback<SdkResultMtOperationType>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| operation | Operation | Сведения об операции |
| enableMultiSelection | Boolean | Флаг, указывающий, разрешено ли частичное подписание (возможность выбора документов, подпись которых будет подтверждена) |
| immediateSendConfirm | Boolean | Режим отправки подтверждения (по умолчанию «немедленно» (online) - сформированный запрос с подтверждением SDK сразу отправляет на сервер или приложение сохраняет данный запрос для возможности отправить его позднее) |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи |
| callback | SdkResultCallback<SdkResultMtOperationType> | Интерфейс обратного вызова |
Возвращаемые параметры:
1. При полном подтверждении (всех документов) операции: MtOperationSuccess
| Параметр | Тип | Описание |
|---|---|---|
| confirmState | ConfirmStateEnum | Результат подтверждения операции в случае немедленной отправки запроса на сервер (immediateSendConfirm:true) |
2. При частичном подтверждении (некоторых документов) операции: MtOperationPartialSuccess
| Параметр | Тип | Описание |
|---|---|---|
| confirmState | ConfirmStateEnum | Результат подтверждения операции в случае немедленной отправки запроса на сервер (immediateSendConfirm:true) |
| documentWithErrorList | List<Document> | Список неподтвержденных документов |
3. При отложенном подписании: MtOperationSuspendedConfirm
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMT | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере. Используется для отложенного подписания |
Примечание
Метод отображает UI c данными операции, экран ввода пароля для доступа к ключам аутентификации, экран NFC/USB.
Метод signMT (suspend)
Подтверждение операции, созданной на сервере.
suspend fun signMT(
context: Context,
kid: String,
operation: Operation?,
enableMultiSelection: Boolean,
immediateSendConfirm: Boolean,
silent: Boolean
): SdkResultMtOperationType
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| operation | Operation | Сведения об операции |
| enableMultiSelection | Boolean | Флаг, указывающий, разрешено ли частичное подписание (возможность выбора документов, подпись которых будет подтверждена) |
| immediateSendConfirm | Boolean | Режим отправки подтверждения (по умолчанию «немедленно» (online) - сформированный запрос с подтверждением SDK сразу отправляет на сервер или приложение сохраняет данный запрос для возможности отправить его позднее) |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи |
Возвращаемые параметры:
1. При полном подтверждении (всех документов) операции: MtOperationSuccess
| Параметр | Тип | Описание |
|---|---|---|
| confirmState | ConfirmStateEnum | Результат подтверждения операции в случае немедленной отправки запроса на сервер (immediateSendConfirm:true) |
2. При частичном подтверждении (некоторых документов) операции: MtOperationPartialSuccess
| Параметр | Тип | Описание |
|---|---|---|
| confirmState | ConfirmStateEnum | Результат подтверждения операции в случае немедленной отправки запроса на сервер (immediateSendConfirm:true) |
| documentWithErrorList | List<Document> | Список неподтвержденных документов |
3. При отложенном подписании: MtOperationSuspendedConfirm
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMT | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере. Используется для отложенного подписания |
Примечание
Метод отображает UI c данными операции, экран ввода пароля для доступа к ключам аутентификации, экран NFC/USB.
Метод signMO
Подтверждение операции, созданной на клиенте (в мобильном приложении).
public void signMO(
@NotNull Context context,
@NotNull String kid,
@NotNull Map<String, String> parameters,
boolean enableMultiSelection,
boolean immediateSendConfirm,
List<UploadDocInfo> uploadDocInfo,
boolean silent,
SdkResultCallback<SdkResultMoOperationType> callback)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| parameters | [String: String] | Параметры операции |
| enableMultiSelection | Bool | Флаг, указывающий, разрешено ли частичное подписание (возможность выбора документов, подпись которых будет подтверждена) |
| inmediateSendConfirm | Bool | Режим отправки подтверждения: True - «немедленно» (online), сформированный запрос с подтверждением SDK сразу отправляет на сервер False - отложенный (offline), приложение сохраняет данный запрос для возможности отправить его позднее |
| uploadDocInfos | UploadDocInfo] | Массив информации (идентификаторов) загруженных на сервер для подписи документов |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи |
| callback | SdkResultCallback<SdkResultMoOperationType> | Интерфейс обратного вызова |
Возвращаемые параметры:
1. При успешном выполнении операции: MoOperationSuccessful
| Параметр | Тип | Описание |
|---|---|---|
| signatureResult | SignatureResult | Результат выполнения операции |
2. При отложенном подписании: OperationSuspendedConfirmMo
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMO | ApproveRequestMO | Запрос на подтверждение/отклонение операции, созданной на клиенте. Используется для отложенного подписания и может быть изменен |
3. При отложенном подписании: OperationSuspendedConfirmMT
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMT | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере. Используется для отложенного подписания |
Примечание
Метод отображает UI c данными операции, экран ввода пароля для доступа к ключам аутентификации, экран NFC/USB.
Метод signMO (suspend)
Подтверждение операции, созданной на клиенте (в мобильном приложении).
suspend fun signMO(
context: Context,
kid: String,
parameters: Map<String, String>,
enableMultiSelection: Boolean,
immediateSendConfirm: Boolean,
uploadDocInfo: List<UploadDocInfo>,
silent: Boolean
): SdkResultMoOperationType
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| parameters | Map<String, String> | Параметры операции |
| enableMultiSelection | Boolean | Флаг, указывающий, разрешено ли частичное подписание (возможность выбора документов, подпись которых будет подтверждена) |
| inmediateSendConfirm | Boolean | Режим отправки подтверждения: True - «немедленно» (online), сформированный запрос с подтверждением SDK сразу отправляет на сервер False - отложенный (offline), приложение сохраняет данный запрос для возможности отправить его позднее |
| uploadDocInfos | List<UploadDocInfo> | Массив информации (идентификаторов) загруженных на сервер для подписи документов |
| silent | Boolean | Флаг для скрытия/отображения диалоговых окон SDK. Используется только для создания усиленной неквалифицированной электронной подписи |
| callback | SdkResultCallback<SdkResultMoOperationType> | Интерфейс обратного вызова |
Возвращаемые параметры:
1. При успешном выполнении операции: MoOperationSuccessful
| Параметр | Тип | Описание |
|---|---|---|
| signatureResult? | SignatureResult | Результат выполнения операции |
2. При отложенном подписании: OperationSuspendedConfirmMo
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMO | ApproveRequestMO | Запрос на подтверждение/отклонение операции, созданной на клиенте. Используется для отложенного подписания и может быть изменен |
3. При отложенном подписании: OperationSuspendedConfirmMT
| Параметр | Тип | Описание |
|---|---|---|
| approveRequestMT | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере. Используется для отложенного подписания |
Примечание
Метод отображает UI c данными операции, экран ввода пароля для доступа к ключам аутентификации, экран NFC/USB.
Офлайн-подпись (УНЭП)
Офлайн-подпись (УНЭП)
Офлайн-подпись документов без обращения к серверу. Поддерживаются только мобильные ключи и ключи, находящиеся на внешних носителях.
fun offlineSignMO(
context: Context,
offlineSignatureConfig: OfflineSignatureConfig,
uploadDocInfo: List<UploadOfflineFile>,
sdkResultCallback: SdkResultCallback<List<UploadOfflineFile>>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| offlineSignatureConfig | OfflineSignatureConfig | Параметры офлайн-подписи |
| uploadDocInfo | List<UploadOfflineFile> | Документы для офлайн-подписи |
| callback | SdkResultCallback<List<UploadOfflineFile>> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр | Описание |
|---|---|
| List<UploadOfflineFile> | Документы для офлайн-подписи |
Офлайн-подпись (УНЭП) (suspend)
Офлайн-подпись документов без обращения к серверу. Поддерживаются только мобильные ключи и ключи, находящиеся на внешних носителях.
suspend fun offlineSignMO(
context: Context,
offlineSignatureConfig: OfflineSignatureConfig,
uploadDocInfo: List<UploadOfflineFile>
): List<UploadOfflineFile>
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| offlineSignatureConfig | OfflineSignatureConfig | Параметры офлайн-подписи |
| uploadDocInfo | List<UploadOfflineFile> | Документы для офлайн-подписи |
Возвращаемые параметры:
| Параметр | Описание |
|---|---|
| List<UploadOfflineFile> | Документы для офлайн-подписи |
Отложенное подтверждение
Метод deferredRequest (MT)
Отложенное подтверждение операции, созданной на сервере.
fun deferredRequest(
context: Context,
kid: String,
approveRequest: ApproveRequestMT,
sdkResultCallback: SdkResultCallback<Unit>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| approveRequest | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере |
| callback | SdkResultCallback<Unit> | Интерфейс обратного вызова |
Метод deferredRequest (MT) (suspend)
Отложенное подтверждение операции, созданной на сервере.
suspend fun deferredRequest(
context: Context,
kid: String,
approveRequest: ApproveRequestMT
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| approveRequest | ApproveRequestMT | Запрос на подтверждение/отклонение операции, созданной на сервере |
Метод deferredRequest (MO)
Отложенное подтверждение операции, созданной на клиенте (в мобильном приложении).
fun deferredRequest(
context: Context,
kid: String,
approveRequest: ApproveRequestMO,
sdkResultCallback: SdkResultCallback<SignatureResult>
)
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| approveRequest | ApproveRequestMO | Запрос на подтверждение/отклонение операции, созданной на клиенте |
| callback | SdkResultCallback<SignatureResult> | Интерфейс обратного вызова |
Возвращаемые параметры:
| Параметр Описание |
|---|
| signatureResult |
Метод deferredRequest (MO) (suspend)
Отложенное подтверждение операции, созданной на клиенте (в мобильном приложении).
suspend fun deferredRequest(
context: Context,
kid: String,
approveRequest: ApproveRequestMO
): SignatureResult
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
| kid | String | Идентификатор набора ключей пользователя |
| approveRequest | ApproveRequestMO | Запрос на подтверждение/отклонение операции, созданной на клиенте |
Возвращаемые параметры:
| Параметр Описание |
|---|
| signatureResult |