Class AuthorizationException

AuthorizationException

Ein Fehler, der zurückgegeben werden kann, um dem Nutzer eine Autorisierungskarte anzuzeigen.

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

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAuthorizationUrl(authUrl)AuthorizationExceptionLegt die Autorisierungs-URL fest, zu der der Nutzer vom Autorisierungs-Prompt aus weitergeleitet wird.
setCustomUiCallback(callback)AuthorizationExceptionDer Name einer Funktion, die aufgerufen werden soll, um einen benutzerdefinierten Autorisierungsprompt zu generieren.
setResourceDisplayName(name)AuthorizationExceptionLegt den Namen fest, der dem Nutzer angezeigt wird, wenn er um Autorisierung gebeten wird.
throwException()voidLöst das Auslösen dieser Ausnahme aus.

Detaillierte Dokumentation

printJson()

Gibt die JSON-Darstellung dieses Objekts aus. Dies dient nur zur Fehlerbehebung.

Rückflug

String


setAuthorizationUrl(authUrl)

Legt die Autorisierungs-URL fest, zu der der Nutzer vom Autorisierungs-Prompt aus weitergeleitet wird. Erforderlich.

Parameter

NameTypBeschreibung
authUrlStringDie festzulegende Autorisierungs-URL.

Rückflug

AuthorizationException – Dieses Objekt zur Verkettung.


setCustomUiCallback(callback)

Der Name einer Funktion, die aufgerufen werden soll, um einen benutzerdefinierten Autorisierungsprompt zu generieren. Optional.

Parameter

NameTypBeschreibung
callbackStringDer Name der Funktion, die eine benutzerdefinierte Autorisierungsaufforderung generiert.

Rückflug

AuthorizationException – Dieses Objekt zur Verkettung.


setResourceDisplayName(name)

Legt den Namen fest, der dem Nutzer angezeigt wird, wenn er um Autorisierung gebeten wird. Erforderlich.

Parameter

NameTypBeschreibung
nameStringDer Anzeigename.

Rückflug

AuthorizationException – Dieses Objekt zur Verkettung.


throwException()

Löst das Auslösen dieser Ausnahme aus.