Справочник функций

Класс YandexAuthSdkКласс YandexAuthSdk

Класс авторизации.

Свойства и функцииСвойства и функции

• Контракт для запуска активити LoginSDK.

  Предназначен для использования с функцией registerForActivityResult() согласно документации. В качестве входных параметров используется YandexAuthLoginOptions. В качестве результата возвращается Result<YandexAuthToken?>.

  val contract: YandexAuthSdkContract
  

• Получение JSON Web Token.

  fun getJwt(token: YandexAuthToken): String
  

Класс YandexAuthSdkContractКласс YandexAuthSdkContract

Класс настройки LoginSDK.

Свойства и функцииСвойства и функции

• Создание конфигурации LoginSDK. Идентификатор клиентского приложения берется из build.gradle.

  YandexAuthOptions(context: Context, loggingEnabled: Boolean = false)
  

  где loggingEnabled — признак разрешенного логирования сообщений от LoginSDK.

• Получение идентификатора приложения.

  val clientId: String
  

• Получение признака разрешенного логирования сообщений от LoginSDK.

  val isLoggingEnabled: Boolean
  

Класс YandexAuthLoginOptionsКласс YandexAuthLoginOptions

Класс параметров авторизации. Необходимо передавать экземпляр этого класса в метод launch() при запуске процесса авторизации.

Свойства и функцииСвойства и функции

• Создание экземпляра класса YandexAuthLoginOptions.

  YandexAuthLoginOptions(val loginType: LoginType = LoginType.NATIVE)
  

  где LoginType определяет режим авторизации пользователя.

  Возможные режимы:

  • NATIVE — авторизация будет происходить через приложение Яндекса, которое поддерживает авторизацию. Авторизация возможна через приложения:

    • Яндекс Браузер
    • Яндекс Старт
    • Яндекс — с Алисой
    • Яндекс GO
    • Яндекс Почта
    • Яндекс Диск
    • Яндекс Пэй
    • Яндекс Ключ

    Если ни одно приложение из списка не установлено, при авторизации откроется Chrome Tab браузера, который установлен в системе на устройстве. Если браузер по умолчанию не поддерживает Chrome Tab, откроется WebView.

  • CHROME_TAB — авторизация будет происходить через Chrome tab браузера, который установлен по умолчанию на устройстве. Если бразуер по умолчанию не поддерживает Chrome Tab, откроется WebView.

  • WEBVIEW — авторизация будет происходить через WebView.

• Получение режима авторизации пользователя, переданного в конструкторе.

  val loginType: LoginType
  

Интерфейс YandexAuthResultИнтерфейс YandexAuthResult

Результат, возвращающийся от LoginSDK после авторизации. Представляет собой sealed interface, который имеет три возможных наследника.

НаследникиНаследники

• Успешная авторизация.

  data class Success(val token: YandexAuthToken) : YandexAuthResult
  

  где token — токен, выданный в результате успешной авторизация.

• Неуспешная авторизация.

  data class Failure(val exception: YandexAuthException) : YandexAuthResult
  

  где exception — ошибка, возникшая в результате авторизации.

• Отмена авторизации пользователем.

  object Cancelled : YandexAuthResult
  

Класс YandexAuthTokenКласс YandexAuthToken

Класс, возвращающийся от LoginSDK после успешной авторизации.

Свойства и функцииСвойства и функции

• Создание токена и получение информации о нем: значение, тип и время активности токена.

  class YandexAuthToken(val value: String, val expiresIn: Long)
  

• Получение значения токена.

  val value: String
  

• Получение времени жизни токена.

  val expiresIn: Long