ICustomAuthPublicClientApplication interface

Rozszerzenie

IPublicClientApplication

Metody

getCurrentAccount(CustomAuthActionInputs)

Pobiera bieżące konto z pamięci podręcznej.

resetPassword(ResetPasswordInputs)

Inicjuje przepływ resetowania hasła.

signIn(SignInInputs)

Inicjuje przepływ logowania.

signUp(SignUpInputs)

Inicjuje przepływ rejestracji.

Szczegóły metody

getCurrentAccount(CustomAuthActionInputs)

Pobiera bieżące konto z pamięci podręcznej.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

Parametry

accountRetrievalInputs

CustomAuthActionInputs

Dane wejściowe dotyczące pobierania bieżącego buforowanego konta

Zwraca

Wynik operacji

resetPassword(ResetPasswordInputs)

Inicjuje przepływ resetowania hasła.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

Parametry

resetPasswordInputs
ResetPasswordInputs

Dane wejściowe dla przepływu resetowania hasła

Zwraca

Obietnica, która rozwiązuje problem z resetPasswordStartResult

signIn(SignInInputs)

Inicjuje przepływ logowania.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

Parametry

signInInputs
SignInInputs

Dane wejściowe przepływu logowania

Zwraca

Promise<SignInResult>

Obietnica, która jest rozpoznawana jako SignInResult

signUp(SignUpInputs)

Inicjuje przepływ rejestracji.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

Parametry

signUpInputs
SignUpInputs

Dane wejściowe przepływu rejestracji

Zwraca

Promise<SignUpResult>

Obietnica, która rozwiązuje problem z elementem SignUpResult

Szczegóły metody dziedziczonej

acquireTokenByCode(AuthorizationCodeRequest)

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Parametry

request

AuthorizationCodeRequest

Zwraca

Promise<AuthenticationResult>

Dziedziczone z IPublicClientApplication.acquireTokenByCode

acquireTokenPopup(PopupRequest)

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Parametry

request

PopupRequest

Zwraca

Promise<AuthenticationResult>

Dziedziczone z IPublicClientApplication.acquireTokenPopup

acquireTokenRedirect(RedirectRequest)

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Parametry

request

RedirectRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.acquireTokenRedirect

acquireTokenSilent(SilentRequest)

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Parametry

silentRequest

SilentRequest

Zwraca

Promise<AuthenticationResult>

Dziedziczone z IPublicClientApplication.acquireTokenSilent

addEventCallback(EventCallbackFunction, EventType[])

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Parametry

callback

EventCallbackFunction

eventTypes

EventType[]

Zwraca

null | string

Dziedziczone z IPublicClientApplication.addEventCallback

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parametry

Zwraca

string

Dziedziczone z IPublicClientApplication.addPerformanceCallback

clearCache(ClearCacheRequest)

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Parametry

logoutRequest

ClearCacheRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.clearCache

disableAccountStorageEvents()

function disableAccountStorageEvents()

Dziedziczone z IPublicClientApplication.disableAccountStorageEvents

enableAccountStorageEvents()

function enableAccountStorageEvents()

Dziedziczone z IPublicClientApplication.enableAccountStorageEvents

getAccount(AccountFilter)

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parametry

accountFilter
AccountFilter

Zwraca

null | AccountInfo

Dziedziczone z IPublicClientApplication.getAccount

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parametry

homeAccountId

string

Zwraca

null | AccountInfo

Dziedziczone z IPublicClientApplication.getAccountByHomeId

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): null | AccountInfo

Parametry

localId

string

Zwraca

null | AccountInfo

Dziedziczone z IPublicClientApplication.getAccountByLocalId

getAccountByUsername(string)

function getAccountByUsername(userName: string): null | AccountInfo

Parametry

userName

string

Zwraca

null | AccountInfo

Dziedziczone z IPublicClientApplication.getAccountByUsername

getActiveAccount()

function getActiveAccount(): null | AccountInfo

Zwraca

null | AccountInfo

Dziedziczone z IPublicClientApplication.getActiveAccount

getAllAccounts()

function getAllAccounts(): AccountInfo[]

Zwraca

Dziedziczone z IPublicClientApplication.getAllAccounts

getLogger()

function getLogger(): Logger

Zwraca

Dziedziczone z IPublicClientApplication.getLogger

getTokenCache()

function getTokenCache(): ITokenCache

Zwraca

ITokenCache

Dziedziczone z IPublicClientApplication.getTokenCache

handleRedirectPromise(string)

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Parametry

hash

string

Zwraca

Promise<null | AuthenticationResult>

Dziedziczone z 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>

Parametry

result

AuthenticationResult

request

PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.hydrateCache

initialize(InitializeApplicationRequest)

function initialize(request?: InitializeApplicationRequest): Promise<void>

Parametry

request

InitializeApplicationRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.initialize

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parametry

sku

WrapperSKU

version

string

Dziedziczone z IPublicClientApplication.initializeWrapperLibrary

loginPopup(PopupRequest)

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Parametry

request

PopupRequest

Zwraca

Promise<AuthenticationResult>

Dziedziczone z IPublicClientApplication.loginPopup

loginRedirect(RedirectRequest)

function loginRedirect(request?: RedirectRequest): Promise<void>

Parametry

request

RedirectRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.loginRedirect

logout(EndSessionRequest)

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Parametry

logoutRequest

EndSessionRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.logout

logoutPopup(EndSessionPopupRequest)

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Parametry

logoutRequest

EndSessionPopupRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.logoutPopup

logoutRedirect(EndSessionRequest)

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Parametry

logoutRequest

EndSessionRequest

Zwraca

Promise<void>

Dziedziczone z IPublicClientApplication.logoutRedirect

removeEventCallback(string)

function removeEventCallback(callbackId: string)

Parametry

callbackId

string

Dziedziczone z IPublicClientApplication.removeEventCallback

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

Parametry

callbackId

string

Zwraca

boolean

Dziedziczone z IPublicClientApplication.removePerformanceCallback

setActiveAccount(null | AccountInfo)

function setActiveAccount(account: null | AccountInfo)

Parametry

account

null | AccountInfo

Dziedziczone z IPublicClientApplication.setActiveAccount

setLogger(Logger)

function setLogger(logger: Logger)

Parametry

logger
Logger

Dziedziczone z IPublicClientApplication.setLogger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

Parametry

navigationClient

INavigationClient

Dziedziczone z 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>

Parametry

request

Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

Zwraca

Promise<AuthenticationResult>

Dziedziczone z IPublicClientApplication.ssoSilent