Komunikat o błędzie, który może zostać zwrócony w celu wyświetlenia użytkownikowi karty autoryzacji.
CardService.newAuthorizationException() .setAuthorizationUrl("http://auth.com/") .setResourceDisplayName("Example Resource") .throwException();
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
printJson() | String | Wyświetla reprezentację tego obiektu w formacie JSON. |
setAuthorizationUrl(authUrl) | AuthorizationException | Ustawia adres URL autoryzacji, do którego prowadzi użytkownik po wyświetleniu komunikatu autoryzacji. |
setCustomUiCallback(callback) | AuthorizationException | Nazwa funkcji, która powoduje wyświetlenie niestandardowej prośby o autoryzację. |
setResourceDisplayName(name) | AuthorizationException | Określa nazwę wyświetlaną użytkownikowi, gdy poprosi o autoryzację. |
throwException() | void | Wywołuje ten wyjątek. |
Szczegółowa dokumentacja
printJson()
Wyświetla reprezentację tego obiektu w formacie JSON. Służy tylko do debugowania.
Zwróć
String
setAuthorizationUrl(authUrl)
Ustawia adres URL autoryzacji, do którego prowadzi użytkownik po wyświetleniu komunikatu autoryzacji. Wymagany.
Parametry
Nazwa | Typ | Opis |
---|---|---|
authUrl | String | Adres URL autoryzacji, który ma zostać ustawiony. |
Zwróć
AuthorizationException
– ten obiekt do łańcucha.
setCustomUiCallback(callback)
Nazwa funkcji, która powoduje wyświetlenie niestandardowej prośby o autoryzację. Opcjonalne.
Parametry
Nazwa | Typ | Opis |
---|---|---|
callback | String | Nazwa funkcji generującej niestandardowy komunikat autoryzacji. |
Zwróć
AuthorizationException
– ten obiekt do łańcucha.
setResourceDisplayName(name)
Określa nazwę wyświetlaną użytkownikowi, gdy poprosi o autoryzację. Wymagany.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Wyświetlana nazwa. |
Zwróć
AuthorizationException
– ten obiekt do łańcucha.
throwException()
Wywołuje ten wyjątek.