User (CKey SDK for Android | API Reference for version 1.x)

java.lang.Object
- __net_ApiResult
- - ru.stcrypt.ckey.sdk.v1.User

All Implemented Interfaces:

java.io.Serializable
```
public final class User
extends __net_ApiResult
implements java.io.Serializable
```
Объект, содержащий информацию о пользователе

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlias()` Получение удобочитаемого идентификатора устройства, используемого для подтверждения владения МУ пользователем.
`int`	`getAuthKeyFlags()` Получение флагов из authKeyBlob
`AuthKeyType`	`getAuthKeyType()` Тип ключа
`java.lang.String`	`getCKeyID()` Получение идентификатора набора ключей my (kid)
`int`	`getCodeExpirationInterval()` Получение интервала времени, в течение которого вычисленные значение кодов подтверждения будут валидными при проверке на сервере
`int`	`getConfirmKeyFlags()` Получение флагов из confirmKeyBlob
`java.lang.String`	`getExternalId()` Получение идентификатор сущности вызывающего приложения, к которому "привязывается" объект
`java.lang.String`	`getName()` Получение дружественного имени ключа для использования в рамках приложения
`long`	`getNotAfter()` Получение времени окончания срока действия ключей
`long`	`getNotBefore()` Получение времени начала срока действия ключей
`java.lang.String`	`getProfile()` Получение профиля пользователя (строка, содержащая JSON-объект)
`java.lang.String`	`getRegisteredPushToken()` Получение последнего push-токена, который был зарегистрирован на сервере для данного объекта User
`java.lang.String`	`getServiceUrl()` Получение URL для взаимодействия с my
`Device.DeviceStatus`	`getStatus()` Получение последнего сохранённого статуса текущего устройства
`java.lang.String`	`getUserId()` Получение идентификатора пользователя (uid)
`java.lang.String`	`getUserName()` Получение названия учётной записи пользователя (логина)
`boolean`	`isActivated()` Признак того, требуется ли активация
`boolean`	`isDenyStoreWithOSProtection()` Получение флага запрета сохранения ключа, используя системный способ защиты доступа к нему (такой как отпечаток пальца).
`boolean`	`isReadyToSign()` Проверка того, что на данный момент пользователь может подтверждать операции, подписывать документы и выполнять другие операции, требующие вычисления кода подтверждения на ключе KConf. Данный метод всегда возвращает true, если при регистрации был использован пароль по умолчанию.
`boolean`	`isWeakness()` Получение флага УКЭП/УНЭП
`boolean`	`isWithFingerPrint()` Получение флага необходимости использования отпечатка устройства (набора уникальных признаков аппарата)
`boolean`	`qRVerificationRequired()` Получение признака того, что необходимо подтвердить изменения в аккаунте при помощи QR-кода (статус учетной записи - `Device.DeviceStatus.NotVerified`)
`int`	`reset()` Сброс состояния экземпляра (активных паролей, сессий, свойств и пр.)
`java.lang.String`	`toString()`
`boolean`	`verificationRequired()` Получение признака того, что необходимо подтвердить изменения в аккаунте (статус учетной записи - `Device.DeviceStatus.NotVerified`)

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getAlias
```
public java.lang.String getAlias()
```
    Получение удобочитаемого идентификатора устройства, используемого для подтверждения владения МУ пользователем.
    
    Returns:
    
    Идентификатор устройства или null, если он не задан
  - getAuthKeyFlags
```
public int getAuthKeyFlags()
```
    Получение флагов из authKeyBlob
    
    Returns:
    
    Значение флагов
  - getCodeExpirationInterval
```
public int getCodeExpirationInterval()
```
    Получение интервала времени, в течение которого вычисленные значение кодов подтверждения будут валидными при проверке на сервере
    
    Returns:
    
    Значение времени
  - getConfirmKeyFlags
```
public int getConfirmKeyFlags()
```
    Получение флагов из confirmKeyBlob
    
    Returns:
    
    Значение флагов
  - getUserId
```
public java.lang.String getUserId()
```
    Получение идентификатора пользователя (uid)
    
    Returns:
    
    Всегда непустое значение идентификатора
  - getExternalId
```
public java.lang.String getExternalId()
```
    Получение идентификатор сущности вызывающего приложения, к которому "привязывается" объект
    
    Returns:
    
    Идентификатор или значение null, если он не задан
  - getCKeyID
```
public java.lang.String getCKeyID()
```
    Получение идентификатора набора ключей my (kid)
    
    Returns:
    
    Всегда непустое значение идентификатора ключей
  - getName
```
public java.lang.String getName()
```
    Получение дружественного имени ключа для использования в рамках приложения
    
    Returns:
    
    Всегда непустое имя, заданное при регистрации
  - getNotAfter
```
public long getNotAfter()
```
    Получение времени окончания срока действия ключей
    
    Returns:
    
    Unix Timestamp
  - getNotBefore
```
public long getNotBefore()
```
    Получение времени начала срока действия ключей
    
    Returns:
    
    Unix Timestamp
  - getProfile
```
public java.lang.String getProfile()
```
    Получение профиля пользователя (строка, содержащая JSON-объект)
    
    Returns:
    
    Данные профиля или null, если учётная запись ещё не привязана к профилю
  - getRegisteredPushToken
```
public java.lang.String getRegisteredPushToken()
```
    Получение последнего push-токена, который был зарегистрирован на сервере для данного объекта User
    
    Returns:
    
    Последний зарегистрированный токен или null, если токен не был зарегистрирован и уведомления для данного User недоступны
  - getServiceUrl
```
public java.lang.String getServiceUrl()
```
    Получение URL для взаимодействия с my
    
    Returns:
    
    Всегда непустой URL
  - getStatus
```
public Device.DeviceStatus getStatus()
```
    Получение последнего сохранённого статуса текущего устройства
    
    Returns:
    
    Один из возможных статусов Device.DeviceStatus.
  - getUserName
```
public java.lang.String getUserName()
```
    Получение названия учётной записи пользователя (логина)
    
    Returns:
    
    Название учётной записи. Носит временный характер до подтверждения регистрации, после чего меняется на имя учётной записи, к которой привязывается устройство. Может быть не задано (null).
  - qRVerificationRequired
```
public boolean qRVerificationRequired()
```
    Получение признака того, что необходимо подтвердить изменения в аккаунте при помощи QR-кода (статус учетной записи - Device.DeviceStatus.NotVerified)
    
    Returns:
    
    true, если требуется подтверждение изменений
  - verificationRequired
```
public boolean verificationRequired()
```
    Получение признака того, что необходимо подтвердить изменения в аккаунте (статус учетной записи - Device.DeviceStatus.NotVerified)
    
    Returns:
    
    true, если требуется подтверждение изменений
  - isReadyToSign
```
public boolean isReadyToSign()
```
    Проверка того, что на данный момент пользователь может подтверждать операции, подписывать документы и выполнять другие операции, требующие вычисления кода подтверждения на ключе KConf.
    Данный метод всегда возвращает true, если при регистрации был использован пароль по умолчанию. Если же при регистрации использовалось ручное задание пароля, то метод вернёт значение true только после предъявления пароля или отпечатка пальца. Если после предъявления пароля или отпечатка пользователь сворачивал приложение на некоторое продолжительное время (определяется настройками SDK, по умолчанию 15 секунд), то состояние сбрасывается и пароль требуется ввести заново, а метод возвращает значение false.
    
    Returns:
    
    true, if keys are ready to sign
  - isWithFingerPrint
```
public boolean isWithFingerPrint()
```
    Получение флага необходимости использования отпечатка устройства (набора уникальных признаков аппарата)
    
    Returns:
    
    Флаг необходимости использования отпечатка устройства
  - isWeakness
```
public boolean isWeakness()
```
    Получение флага УКЭП/УНЭП
    
    Returns:
    
    Флаг УКЭП/УНЭП
  - isDenyStoreWithOSProtection
```
public boolean isDenyStoreWithOSProtection()
```
    Получение флага запрета сохранения ключа, используя системный способ защиты доступа к нему (такой как отпечаток пальца). Если флаг установлен, приложение НЕ ДОЛЖНО позволят использовать TouchID/FaceID/Google Fingerprint для сохранения пароля к ключу.
    
    Returns:
    
    Флаг запрета сохранения ключевой информации, используя системный способ защиты доступа к нему
  - isActivated
```
public boolean isActivated()
```
    Признак того, требуется ли активация
    
    Returns:
    
    true, если активация не требуется
  - getAuthKeyType
```
public AuthKeyType getAuthKeyType()
```
    Тип ключа
    
    Returns:
    
    возвращает AuthKeyType
  - reset
```
public int reset()
```
    Сброс состояния экземпляра (активных паролей, сессий, свойств и пр.)
    
    Returns:
    
    Код ошибки. На данный момент всегда возвращается 0 - успех
  - toString
```
public java.lang.String toString()
```

Class User

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAlias

getAuthKeyFlags

getCodeExpirationInterval

getConfirmKeyFlags

getUserId

getExternalId

getCKeyID

getName

getNotAfter

getNotBefore

getProfile

getRegisteredPushToken

getServiceUrl

getStatus

getUserName

qRVerificationRequired

verificationRequired

isReadyToSign

isWithFingerPrint

isWeakness

isDenyStoreWithOSProtection

isActivated

getAuthKeyType

reset

toString