Class AuthorizationException

AuthorizationException

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

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

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringImprime a representação JSON desse objeto.
setAuthorizationUrl(authUrl)AuthorizationExceptionDefine o URL de autorização para o qual o usuário é direcionado no 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 mostrado ao usuário ao pedir autorização.
throwException()voidAciona a geração dessa exceção.

Documentação detalhada

printJson()

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

Retornar

String


setAuthorizationUrl(authUrl)

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

Parâmetros

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

Retornar

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
callbackStringO nome da função que gera um prompt de autorização personalizado.

Retornar

AuthorizationException: esse objeto, para encadeamento.


setResourceDisplayName(name)

Define o nome mostrado ao usuário ao pedir autorização. Obrigatório.

Parâmetros

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

Retornar

AuthorizationException: esse objeto, para encadeamento.


throwException()

Aciona a geração dessa exceção.