Класс CryptoProDSS
Класс основных настроек SDK.
Метод init
Инициализирует КриптоПро Ключ SDK.
public void init(
@NotNull Context context,
@NotNull final SdkCryptoProDssInitCallback sdkInitCallback
Параметры:
Поле | Тип | Описание |
---|---|---|
sdkInitCallback | SdkCryptoProDssInitCallback | Интерфейс обратного вызова |
Возвращаемые значения:
- initOk — инициализация прошла успешно.
- initCertNotInstalled — не удалось установить сертификаты в процессе инициализации.
- initLockScreenNotInstalled — экран блокировки не установлен.
- initDeviceRooted — устройство работает с правами суперпользователя.
- initDeviceHasSpyPrograms - на устройстве установлены подозрительные приложения.
- initCspNotInitialized - ошибка инициализации криптопровайдера.
Примечание
Метод инициализирует SDK и выполняет проверку условий использования SDK. Если метод определит, что SDK использовать небезопасно на данном устройстве, то будет отображен экран с соответствующим предупреждением. На данном экране пользователь может разрешить или запретить использование SDK.
Примечание
Следующие методы инициализации SDK являются устаревшими и не должны использоваться:
init(@NonNull Context activity, @Nullable HashMap<String, String[]> trustedApps, @NonNull final SdkInitCallback sdkInitCallback)
,init(@NonNull Context context, @NonNull final SdkCryptoProDssInitCallback sdkInitCallback)
.
Метод initBioRng
Инициализирует биоДСЧ.
public void initBioRng(@NotNull Context context, SdkResultCallback<Boolean> simpleLambda)
Параметры:
Параметр | Тип | Описание |
---|---|---|
simpleLambda | SdkResultCallback<Boolean> | Интерфейс обратного вызова |
Метод isInitialized
Проверяет статус инициализации КриптоПро Ключ SDK.
public boolean isInitialized()
Возвращаемые значения:
- true - SDK инициализирован;
- false - SDK не инициализирован.
Метод sdkVersion
Возвращает текущую версию КриптоПро Ключ SDK в виде строки.
public String sdkVersion()
Метод setErrorIfNotInitialized
Проверяет инициализацию КриптоПро Ключ SDK и биоДСЧ.
public void setErrorIfNotInitialized(BaseErrorCallback errorCallback, SimpleLambda ifInitialized)
Параметры:
Параметр | Тип | Описание |
---|---|---|
ifInitialized | SimpleLambda | Интерфейс передачи лямбда-выражения |
errorCallback | BaseErrorCallback | Интерфейс обратного вызова |
Метод setCustomLocale
Установка языка SDK (поддерживается русский и английский).
public Boolean setCustomLocale(CustomLocale customLocale, Context context)
Параметры:
Параметр | Тип | Описание |
---|---|---|
customLocale | CustomLocale | Язык приложения. Возможные значения: ru или en |
Метод setForgotPasswordButtonVisibility
Настройка видимости кнопки "Забыли пароль" на экране ввода пароля.
public void setForgotPasswordButtonVisibility(@NotNull Context context, boolean isVisible)
Параметры:
Параметр | Тип | Описание |
---|---|---|
isVisible | boolean | Флаг, указывающий на видимость кнопки "Забыли пароль" |
Метод setKeyCarrierTypeNotification
Разрешение добавления в запрос сертификат типа ключевого носителя (метод используется для обратной совместимости).
public void setKeyCarrierTypeNotification(@NotNull Context context, boolean isEnable)
Параметры:
Параметр | Тип | Описание |
---|---|---|
isEnable | boolean | Флаг, указывающий на добавление в запрос сертификат типа ключевого носителя |
Метод setDssKidMainTheme
Выбор темы SDK. При переданном значении null будет использована тема по умолчанию.
public void setDssKidMainTheme(@Nullable DssKidMainTheme dssKidMainTheme)
Параметры:
Параметр | Тип | Описание |
---|---|---|
dssKidMainTheme | DssKidMainTheme | Основная тема SDK |
Метод setHttpAllTimeOut
Установка таймаута взаимодействия с сервером. Значение по умолчанию - 100 секунд.
public void setHttpAllTimeOut(HttpTimeOutModel timeOutPerSeconds)
Параметры:
Параметр | Тип | Описание |
---|---|---|
timeOutPerSeconds | HttpTimeOutModel | Структура с данными о таймаутах взаимодействия с сервером |
Метод getHttpTimeOutPerSeconds
Получение информации о таймауте взаимодействия с сервером.
public HttpTimeOutModel getHttpTimeOutPerSeconds()
Возвращаемые параметры:
Параметр | Тип | Описание |
---|---|---|
httpTimeOutPerSeconds | HttpTimeOutModel | Структура с данными о таймаутах взаимодействия с сервером |
Метод setExternalLogger
Метод задания объекта для логирования.
public void setExternalLogger(BaseSdkLog externalLog)
Метод checkIntegrity
Метод проверки целостности.
public void checkIntegrity(SdkCryptoProDssCheckIntegrityCallback callback))
Возвращаемые значения:
- 0 - успех,
- 1 - ошибка.
Метод setTicketSavePath
Метод позволяет указать путь к директории сохранения тикетов (используется при подписи на распределенных ключах).
public void setTicketSavePath(@Nullable String ticketSavePath)
Параметры:
Параметр | Тип | Описание |
---|---|---|
ticketSavePath | String | Путь к директории сохранения тикетов |
Метод getTicketSavePath
Метод позволяет получить текущий путь к директории сохранения тикетов (используется при подписи на распределенных ключах).
public String getTicketSavePath()
Возвращаемые параметры:
Параметр | Тип | Описание |
---|---|---|
ticketSavePath | String | Путь к директории сохранения тикетов |