FMPUser

Описание

Интерфейс FMPUser предназначен для описания пользователя.

interface FMPUser: FMPObject

Свойства

Свойство Описание

login

 Логин пользователя. 
val login: String

password

 Пароль пользователя. 
val password: String

Методы

Метод Описание
auth Аутентификация пользователя. После выполнения метода будет получен токен пользователя. Токен используется в каждом запросе к серверу. 
fun auth(): Boolean
auth Аутентификация пользователя со сменой пароля. После выполнения метода будет получен новый токен пользователя. Токен используется в каждом запросе к серверу. 
fun auth(newPassword: String): Boolean

Параметры:

  • newPassword. Новый пароль пользователя.
revoke() Отмена аутентификации пользователя. 
fun revoke(): Boolean

Методы, унаследованные от интерфейса FMPObject

Метод Описание
toJSON Сериализация объекта в JSON. 
fun toJSON(): String
copy Получение экземпляра конструктора для копирования интерфейса. Возвращает экземпляр в виде: <название интерфейса>.Builder. 
fun copy(): Builder
equals Сравнивает объекты между собой по ключевым параметрам. Например, два FMPUser одинаковы, если имеют одинаковый логин. 
fun equals(other: Any?): Boolean

Параметры:

  • other. Любой другой объект.
hashCode Выдает хэш-код на основе ключевых параметров. 
fun hashCode(): Int
toString Выводит основную информацию об объекте в не сериализованном виде. Для сериализации используйте метод toJSON(). 
fun toString(): String

Пример

val user = fmp.user
  .login("username")
  .password("secret123")
  .build() 
val isAuthenticated = user.auth().status

См. также:

Фреймворк FMP | Интерфейсы