IPublicClientApplication interface

Пакет:

@azure/msal-browser

Методы

acquireTokenByCode(AuthorizationCodeRequest)
acquireTokenPopup(PopupRequest)
acquireTokenRedirect(RedirectRequest)
acquireTokenSilent(SilentRequest)
addEventCallback(EventCallbackFunction, EventType[])
addPerformanceCallback(PerformanceCallbackFunction)
clearCache(ClearCacheRequest)
disableAccountStorageEvents()
enableAccountStorageEvents()
getAccount(AccountFilter)
getAccountByHomeId(string)
getAccountByLocalId(string)
getAccountByUsername(string)
getActiveAccount()
getAllAccounts()
getLogger()
getTokenCache()
handleRedirectPromise(string)
hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
initialize(InitializeApplicationRequest)
initializeWrapperLibrary(WrapperSKU, string)
loginPopup(PopupRequest)
loginRedirect(RedirectRequest)
logout(EndSessionRequest)
logoutPopup(EndSessionPopupRequest)
logoutRedirect(EndSessionRequest)
removeEventCallback(string)
removePerformanceCallback(string)
setActiveAccount(null | AccountInfo)
setLogger(Logger)
setNavigationClient(INavigationClient)
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)

Сведения о методе

acquireTokenByCode(AuthorizationCodeRequest)

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

Параметры

request

AuthorizationCodeRequest

Возвращаемое значение

Promise<AuthenticationResult>

acquireTokenPopup(PopupRequest)

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

Параметры

request

PopupRequest

Возвращаемое значение

Promise<AuthenticationResult>

acquireTokenRedirect(RedirectRequest)

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

Параметры

request

RedirectRequest

Возвращаемое значение

Promise<void>

acquireTokenSilent(SilentRequest)

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

Параметры

silentRequest

SilentRequest

Возвращаемое значение

Promise<AuthenticationResult>

addEventCallback(EventCallbackFunction, EventType[])

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

Параметры

callback

EventCallbackFunction

eventTypes

EventType[]

Возвращаемое значение

null | string

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Параметры

callback

PerformanceCallbackFunction

Возвращаемое значение

string

clearCache(ClearCacheRequest)

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

Параметры

logoutRequest

ClearCacheRequest

Возвращаемое значение

Promise<void>

disableAccountStorageEvents()

function disableAccountStorageEvents()

enableAccountStorageEvents()

function enableAccountStorageEvents()

getAccount(AccountFilter)

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Параметры

accountFilter

AccountFilter

Возвращаемое значение

null | AccountInfo

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Параметры

homeAccountId

string

Возвращаемое значение

null | AccountInfo

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): null | AccountInfo

Параметры

localId

string

Возвращаемое значение

null | AccountInfo

getAccountByUsername(string)

function getAccountByUsername(userName: string): null | AccountInfo

Параметры

userName

string

Возвращаемое значение

null | AccountInfo

getActiveAccount()

function getActiveAccount(): null | AccountInfo

Возвращаемое значение

null | AccountInfo

getAllAccounts()

function getAllAccounts(): AccountInfo[]

Возвращаемое значение

AccountInfo[]

getLogger()

function getLogger(): Logger

Возвращаемое значение

Logger

getTokenCache()

function getTokenCache(): ITokenCache

Возвращаемое значение

ITokenCache

handleRedirectPromise(string)

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

Параметры

hash

string

Возвращаемое значение

Promise<null | AuthenticationResult>

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>

Параметры

result

AuthenticationResult

request

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

Возвращаемое значение

Promise<void>

initialize(InitializeApplicationRequest)

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

Параметры

request

InitializeApplicationRequest

Возвращаемое значение

Promise<void>

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Параметры

sku

WrapperSKU

version

string

loginPopup(PopupRequest)

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

Параметры

request

PopupRequest

Возвращаемое значение

Promise<AuthenticationResult>

loginRedirect(RedirectRequest)

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

Параметры

request

RedirectRequest

Возвращаемое значение

Promise<void>

logout(EndSessionRequest)

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

Параметры

logoutRequest

EndSessionRequest

Возвращаемое значение

Promise<void>

logoutPopup(EndSessionPopupRequest)

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

Параметры

logoutRequest

EndSessionPopupRequest

Возвращаемое значение

Promise<void>

logoutRedirect(EndSessionRequest)

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

Параметры

logoutRequest

EndSessionRequest

Возвращаемое значение

Promise<void>

removeEventCallback(string)

function removeEventCallback(callbackId: string)

Параметры

callbackId

string

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

Параметры

callbackId

string

Возвращаемое значение

boolean

setActiveAccount(null | AccountInfo)

function setActiveAccount(account: null | AccountInfo)

Параметры

account

null | AccountInfo

setLogger(Logger)

function setLogger(logger: Logger)

Параметры

logger

Logger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

Параметры

navigationClient

INavigationClient

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

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Параметры

request

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

Возвращаемое значение

Promise<AuthenticationResult>