Справочник методов
Класс YandexAuthSdk
Класс авторизации.
Методы
-
Создание
Intent
для запуска процесса авторизации.@NonNull public Intent createLoginIntent( @NonNull final YandexAuthLoginOptions loginOptions )
loginOptions
— параметры для запуска авторизации.
-
Обработка результата авторизации.
public YandexAuthToken extractToken(final int resultCode, @Nullable final Intent data) throws YandexAuthException
Описание:
-
Получение JSON Web Token.
public String getJwt(@NonNull final YandexAuthToken token) throws YandexAuthException
Класс YandexAuthOptions
Класс настройки LoginSDK.
Методы
-
Создание конфигурации LoginSDK. Идентификатор клиентского приложения берется из
build.gradle
.public YandexAuthOptions(@NonNull final Context context, final boolean loggingEnabled)
loggingEnabled
— признак разрешенного логирования сообщений от LoginSDK.
-
Получение идентификатора приложения.
public String clientId()
-
Получение признака разрешенного логирования сообщений от LoginSDK.
public boolean isLoggingEnabled()
Класс YandexAuthLoginOptions
Класс параметров авторизации. Непосредственно использовать экземпляры класса не нужно: необходимо создавать их с помощью YandexAuthLoginOptions.Builder.build()
и без изменений передавать в метод createLoginIntent.
Класс YandexAuthLoginOptions.Builder
Класс для создания наборов параметров авторизации. Создав экземпляр этого класса, следует задать параметры авторизации и сконструировать экземпляр YandexAuthLoginOptions
.
Методы
-
Создание экземпляра класса
YandexAuthLoginOptions
. Перед
вызовомbuild()
следует установить нужные параметры авторизации с
помощью методов, перечисленных выше.public YandexAuthLoginOptions build()
-
Определение прав доступа, которые необходимо получить.
public setScopes(List<String> scopes)
-
Выбор режима авторизации пользователя.
public setLoginType(LoginType.<режим авторизации>).build()
-
NATIVE
— авторизация будет происходить через приложение Яндекса, которое поддерживает авторизацию. На устройствах с Android версии 11 и выше авторизация возможна через приложения:- Яндекс Браузер
- Яндекс Старт
- Яндекс — с Алисой
- Яндекс GO
- Яндекс Музыка
- Яндекс Карты
- Яндекс Еда
- Яндекс Почта
- Яндекс Диск
Если ни одно приложение из списка не установлено, при авторизации откроется браузер Chrome. Если Chrome не установлен на устройстве, откроется WebView.
-
BROWSER
— авторизация будет происходить через браузер Chrome. Если Chrome не установлен на устройстве, откроется WebView. -
WEBVIEW
— авторизация будет происходить через WebView.
-
Класс YandexAuthToken
Класс, возвращающийся от LoginSDK после успешной авторизации.
Методы
-
Создание токена и получение информации о нем: значение, тип и время активности токена.
public YandexAuthToken(@NonNull final String value, final long expiresIn)
-
Получение значения токена.
public String getValue()
-
Получение времени жизни токена.
public long expiresIn()