ICustomAuthPublicClientApplication interface
- Extends
-
IPublicClientApplication
Métodos
| get |
Obtém a conta atual do cache. |
| reset |
Inicia o fluxo de redefinição de senha. |
| sign |
Inicia o fluxo de entrada. |
| sign |
Inicia o fluxo de inscrição. |
Métodos herdados
Detalhes do método
getCurrentAccount(CustomAuthActionInputs)
Obtém a conta atual do cache.
function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult
Parâmetros
- accountRetrievalInputs
-
CustomAuthActionInputs
Entradas para obter a conta atual armazenada em cache
Retornos
O resultado da operação
resetPassword(ResetPasswordInputs)
Inicia o fluxo de redefinição de senha.
function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>
Parâmetros
- resetPasswordInputs
- ResetPasswordInputs
Entradas para o fluxo de redefinição de senha
Retornos
Promise<ResetPasswordStartResult>
Uma promessa que resolve redefinir ResetPasswordStartResult
signIn(SignInInputs)
Inicia o fluxo de entrada.
function signIn(signInInputs: SignInInputs): Promise<SignInResult>
Parâmetros
- signInInputs
- SignInInputs
Entradas para o fluxo de entrada
Retornos
Promise<SignInResult>
Uma promessa que resolve o SignInResult
signUp(SignUpInputs)
Inicia o fluxo de inscrição.
function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>
Parâmetros
- signUpInputs
- SignUpInputs
Entradas para o fluxo de inscrição
Retornos
Promise<SignUpResult>
Uma promessa que resolve para SignUpResult
Detalhes do método herdado
acquireTokenByCode(AuthorizationCodeRequest)
function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>
Parâmetros
- request
-
AuthorizationCodeRequest
Retornos
Promise<AuthenticationResult>
Herdado de IPublicClientApplication.acquireTokenByCode
acquireTokenPopup(PopupRequest)
function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>
Parâmetros
- request
-
PopupRequest
Retornos
Promise<AuthenticationResult>
Herdado de IPublicClientApplication.acquireTokenPopup
acquireTokenRedirect(RedirectRequest)
function acquireTokenRedirect(request: RedirectRequest): Promise<void>
Parâmetros
- request
-
RedirectRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.acquireTokenRedirect
acquireTokenSilent(SilentRequest)
function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>
Parâmetros
- silentRequest
-
SilentRequest
Retornos
Promise<AuthenticationResult>
Herdado de IPublicClientApplication.acquireTokenSilent
addEventCallback(EventCallbackFunction, EventType[])
function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string
Parâmetros
- callback
-
EventCallbackFunction
- eventTypes
-
EventType[]
Retornos
null | string
Herdado de IPublicClientApplication.addEventCallback
addPerformanceCallback(PerformanceCallbackFunction)
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
Parâmetros
- callback
- PerformanceCallbackFunction
Retornos
string
Herdado de IPublicClientApplication.addPerformanceCallback
clearCache(ClearCacheRequest)
function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>
Parâmetros
- logoutRequest
-
ClearCacheRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.clearCache
disableAccountStorageEvents()
function disableAccountStorageEvents()
Herdado de IPublicClientApplication.disableAccountStorageEvents
enableAccountStorageEvents()
function enableAccountStorageEvents()
Herdado de IPublicClientApplication.enableAccountStorageEvents
getAccount(AccountFilter)
function getAccount(accountFilter: AccountFilter): null | AccountInfo
Parâmetros
- accountFilter
- AccountFilter
Retornos
null | AccountInfo
Herdado de IPublicClientApplication.getAccount
getAccountByHomeId(string)
function getAccountByHomeId(homeAccountId: string): null | AccountInfo
Parâmetros
- homeAccountId
-
string
Retornos
null | AccountInfo
Herdado de IPublicClientApplication.getAccountByHomeId
getAccountByLocalId(string)
function getAccountByLocalId(localId: string): null | AccountInfo
Parâmetros
- localId
-
string
Retornos
null | AccountInfo
Herdado de IPublicClientApplication.getAccountByLocalId
getAccountByUsername(string)
function getAccountByUsername(userName: string): null | AccountInfo
Parâmetros
- userName
-
string
Retornos
null | AccountInfo
Herdado de IPublicClientApplication.getAccountByUsername
getActiveAccount()
function getActiveAccount(): null | AccountInfo
Retornos
null | AccountInfo
Herdado de IPublicClientApplication.getActiveAccount
getAllAccounts()
function getAllAccounts(): AccountInfo[]
Retornos
Herdado de IPublicClientApplication.getAllAccounts
getLogger()
getTokenCache()
function getTokenCache(): ITokenCache
Retornos
ITokenCache
Herdado de IPublicClientApplication.getTokenCache
handleRedirectPromise(string)
function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>
Parâmetros
- hash
-
string
Retornos
Promise<null | AuthenticationResult>
Herdado de IPublicClientApplication.handleRedirectPromise
hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>
Parâmetros
- result
-
AuthenticationResult
- request
-
PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>
Retornos
Promise<void>
Herdado de IPublicClientApplication.hydrateCache
initialize(InitializeApplicationRequest)
function initialize(request?: InitializeApplicationRequest): Promise<void>
Parâmetros
- request
-
InitializeApplicationRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.initialize
initializeWrapperLibrary(WrapperSKU, string)
function initializeWrapperLibrary(sku: WrapperSKU, version: string)
Parâmetros
- sku
-
WrapperSKU
- version
-
string
Herdado de IPublicClientApplication.initializeWrapperLibrary
loginPopup(PopupRequest)
function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>
Parâmetros
- request
-
PopupRequest
Retornos
Promise<AuthenticationResult>
Herdado de IPublicClientApplication.loginPopup
loginRedirect(RedirectRequest)
function loginRedirect(request?: RedirectRequest): Promise<void>
Parâmetros
- request
-
RedirectRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.loginRedirect
logout(EndSessionRequest)
function logout(logoutRequest?: EndSessionRequest): Promise<void>
Parâmetros
- logoutRequest
-
EndSessionRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.logout
logoutPopup(EndSessionPopupRequest)
function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>
Parâmetros
- logoutRequest
-
EndSessionPopupRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.logoutPopup
logoutRedirect(EndSessionRequest)
function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>
Parâmetros
- logoutRequest
-
EndSessionRequest
Retornos
Promise<void>
Herdado de IPublicClientApplication.logoutRedirect
removeEventCallback(string)
function removeEventCallback(callbackId: string)
Parâmetros
- callbackId
-
string
Herdado de IPublicClientApplication.removeEventCallback
removePerformanceCallback(string)
function removePerformanceCallback(callbackId: string): boolean
Parâmetros
- callbackId
-
string
Retornos
boolean
Herdado de IPublicClientApplication.removePerformanceCallback
setActiveAccount(null | AccountInfo)
function setActiveAccount(account: null | AccountInfo)
Parâmetros
- account
-
null | AccountInfo
Herdado de IPublicClientApplication.setActiveAccount
setLogger(Logger)
function setLogger(logger: Logger)
Parâmetros
- logger
- Logger
Herdado de IPublicClientApplication.setLogger
setNavigationClient(INavigationClient)
function setNavigationClient(navigationClient: INavigationClient)
Parâmetros
- navigationClient
-
INavigationClient
Herdado de IPublicClientApplication.setNavigationClient
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>
Parâmetros
- request
-
Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>
Retornos
Promise<AuthenticationResult>
Herdado de IPublicClientApplication.ssoSilent