Class AuthorizationException

AutorizaçãoException

Um erro que pode ser retornado para acionar um card de autorização a ser mostrado 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 a partir do comando de autorização.
setCustomUiCallback(callback)AuthorizationExceptionO nome de uma função a ser chamada para gerar uma solicitação de autorização personalizada.
setResourceDisplayName(name)AuthorizationExceptionDefine o nome que aparece para o usuário ao solicitar autorização.
throwException()voidAciona essa exceção.

Documentação detalhada

printJson()

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

Retornar

String


setAuthorizationUrl(authUrl)

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

Parâmetros

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

Retornar

AuthorizationException: este objeto, para encadeamento.


setCustomUiCallback(callback)

O nome de uma função a ser chamada para gerar uma solicitação de autorização personalizada. Opcional.

Parâmetros

NomeTipoDescrição
callbackStringO nome da função que gera uma solicitação de autorização personalizada.

Retornar

AuthorizationException: este objeto, para encadeamento.


setResourceDisplayName(name)

Define o nome que aparece para o usuário ao solicitar autorização. Obrigatório.

Parâmetros

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

Retornar

AuthorizationException: este objeto, para encadeamento.


throwException()

Aciona essa exceção.