Class AuthorizationException

AuthorizationException

Um erro que pode ser retornado para acionar um cartão de autorização a ser exibido ao usuário.

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

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.
setAuthorizationUrl(authUrl)AuthorizationExceptionDefine o URL de autorização para onde o usuário é direcionado do prompt de autorização.
setCustomUiCallback(callback)AuthorizationExceptionO nome de uma função a ser chamada para gerar um prompt de autorização personalizado.
setResourceDisplayName(name)AuthorizationExceptionDefine o nome que será exibido ao usuário quando ele solicitar autorização.
throwException()voidAciona o lançamento dessa exceção.

Documentação detalhada

printJson()

Mostra a representação JSON desse objeto. Isso é apenas para depuração.

Retorno

String


setAuthorizationUrl(authUrl)

Define o URL de autorização para onde o usuário é direcionado do prompt de autorização. Obrigatório.

Parâmetros

NomeTipoDescrição
authUrlStringO URL de autorização a ser definido.

Retorno

AuthorizationException: esse objeto para encadeamento.


setCustomUiCallback(callback)

O nome de uma função a ser chamada para gerar um prompt de autorização personalizado. Opcional.

Parâmetros

NomeTipoDescrição
callbackStringNome da função que gera um prompt de autorização personalizado.

Retorno

AuthorizationException: esse objeto para encadeamento.


setResourceDisplayName(name)

Define o nome que será exibido ao usuário quando ele solicitar autorização. Obrigatório.

Parâmetros

NomeTipoDescrição
nameStringO nome de exibição.

Retorno

AuthorizationException: esse objeto para encadeamento.


throwException()

Aciona o lançamento dessa exceção.