Class AuthorizationException

Autorisierungsausnahme

Ein Fehler, der zurückgegeben werden kann, um eine Autorisierungskarte auszulösen, die dem Nutzer angezeigt wird.

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

Methoden

MethodeRückgabetypKurzbeschreibung
printJson()StringDie JSON-Darstellung dieses Objekts wird ausgegeben.
setAuthorizationUrl(authUrl)AuthorizationExceptionHiermit wird die Autorisierungs-URL festgelegt, zu der der Nutzer über den Autorisierungsaufforderung weitergeleitet wird.
setCustomUiCallback(callback)AuthorizationExceptionDer Name einer Funktion, die aufgerufen wird, um einen benutzerdefinierten Autorisierungsprompt zu generieren.
setResourceDisplayName(name)AuthorizationExceptionHiermit wird der Name festgelegt, der dem Nutzer bei der Autorisierungsanfrage angezeigt wird.
throwException()voidAuslöser für diese Ausnahme.

Detaillierte Dokumentation

printJson()

Die JSON-Darstellung dieses Objekts wird ausgegeben. Diese Option ist nur für die Fehlerbehebung gedacht.

Rückflug

String


setAuthorizationUrl(authUrl)

Hiermit wird die Autorisierungs-URL festgelegt, zu der der Nutzer über den Autorisierungsaufforderung weitergeleitet wird. Erforderlich.

Parameter

NameTypBeschreibung
authUrlStringDie Autorisierungs-URL, die festgelegt werden soll.

Rückflug

AuthorizationException – dieses Objekt, zur Verkettung


setCustomUiCallback(callback)

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

Parameter

NameTypBeschreibung
callbackStringDer Name der Funktion, die einen benutzerdefinierten Autorisierungsaufforderung generiert.

Rückflug

AuthorizationException – dieses Objekt, zur Verkettung


setResourceDisplayName(name)

Hiermit wird der Name festgelegt, der dem Nutzer bei der Autorisierungsanfrage angezeigt wird. Erforderlich.

Parameter

NameTypBeschreibung
nameStringDer Anzeigename.

Rückflug

AuthorizationException – dieses Objekt, zur Verkettung


throwException()

Auslöser für diese Ausnahme.