Class AuthorizationException

AuthorizationException

Ошибка, которая может быть возвращена для инициирования показа авторизационной карты пользователю.

CardService.newAuthorizationException()
    .setAuthorizationUrl('http://auth.com/')
    .setResourceDisplayName('Example Resource')
    .throwException();

Методы

Метод Тип возвращаемого значения Краткое описание
print Json() String Выводит JSON-представление этого объекта.
set Authorization Url(authUrl) Authorization Exception Задает URL-адрес авторизации, на который пользователь будет перенаправлен из окна запроса авторизации.
set Custom Ui Callback(callback) Authorization Exception Название функции, которая будет вызвана для генерации пользовательского запроса на авторизацию.
set Resource Display Name(name) Authorization Exception Задает имя, которое отображается пользователю при запросе авторизации.
throw Exception() void Приводит к возникновению этого исключения.

Подробная документация

printJson()

Выводит JSON-представление этого объекта. Это предназначено только для отладки.

Возвращаться

String

setAuthorizationUrl(authUrl)

Задает URL-адрес авторизации, на который пользователь будет перенаправлен из окна запроса авторизации. Обязательный параметр.

Параметры

Имя Тип Описание
auth Url String URL-адрес авторизации для установки.

Возвращаться

AuthorizationException — Этот объект используется для создания цепочек исключений.

setCustomUiCallback(callback)

Название функции, которая будет вызвана для генерации пользовательского запроса на авторизацию. Необязательно.

Параметры

Имя Тип Описание
callback String Название функции, которая генерирует пользовательский запрос на авторизацию.

Возвращаться

AuthorizationException — Этот объект используется для создания цепочек исключений.

setResourceDisplayName(name)

Задает имя, которое отображается пользователю при запросе авторизации. Обязательный параметр.

Параметры

Имя Тип Описание
name String Отображаемое имя.

Возвращаться

AuthorizationException — Этот объект используется для создания цепочек исключений.

throwException()

Приводит к возникновению этого исключения.