IPublicClientApplication interface

Package:

@azure/msal-browser

Methods

acquireTokenByCode(AuthorizationCodeRequest)
acquireTokenPopup(PopupRequest)
acquireTokenRedirect(RedirectRequest)
acquireTokenSilent(SilentRequest)
addEventCallback(Function)
addPerformanceCallback(PerformanceCallbackFunction)
disableAccountStorageEvents()
enableAccountStorageEvents()
getAccountByHomeId(string)
getAccountByLocalId(string)
getAccountByUsername(string)
getActiveAccount()
getAllAccounts()
getConfiguration()
getLogger()
getTokenCache()
handleRedirectPromise(string)
initialize()
initializeWrapperLibrary(WrapperSKU, string)
loginPopup(PopupRequest)
loginRedirect(RedirectRequest)
logout(EndSessionRequest)
logoutPopup(EndSessionPopupRequest)
logoutRedirect(EndSessionRequest)
removeEventCallback(string)
removePerformanceCallback(string)
setActiveAccount(AccountInfo | null)
setLogger(Logger)
setNavigationClient(INavigationClient)
ssoSilent(SsoSilentRequest)

Method Details

acquireTokenByCode(AuthorizationCodeRequest)

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

Parameters

request

AuthorizationCodeRequest

Returns

Promise<AuthenticationResult>

acquireTokenPopup(PopupRequest)

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

Parameters

request

PopupRequest

Returns

Promise<AuthenticationResult>

acquireTokenRedirect(RedirectRequest)

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

Parameters

request

RedirectRequest

Returns

Promise<void>

acquireTokenSilent(SilentRequest)

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

Parameters

silentRequest

SilentRequest

Returns

Promise<AuthenticationResult>

addEventCallback(Function)

function addEventCallback(callback: Function): string | null

Parameters

callback

Function

Returns

string | null

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameters

callback

PerformanceCallbackFunction

Returns

string

disableAccountStorageEvents()

function disableAccountStorageEvents()

enableAccountStorageEvents()

function enableAccountStorageEvents()

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): AccountInfo | null

Parameters

homeAccountId

string

Returns

AccountInfo | null

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): AccountInfo | null

Parameters

localId

string

Returns

AccountInfo | null

getAccountByUsername(string)

function getAccountByUsername(userName: string): AccountInfo | null

Parameters

userName

string

Returns

AccountInfo | null

getActiveAccount()

function getActiveAccount(): AccountInfo | null

Returns

AccountInfo | null

getAllAccounts()

function getAllAccounts(): AccountInfo[]

Returns

AccountInfo[]

getConfiguration()

function getConfiguration(): BrowserConfiguration

Returns

BrowserConfiguration

getLogger()

function getLogger(): Logger

Returns

Logger

getTokenCache()

function getTokenCache(): ITokenCache

Returns

ITokenCache

handleRedirectPromise(string)

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

Parameters

hash

string

Returns

Promise<AuthenticationResult | null>

initialize()

function initialize(): Promise<void>

Returns

Promise<void>

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameters

sku

WrapperSKU

version

string

loginPopup(PopupRequest)

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

Parameters

request

PopupRequest

Returns

Promise<AuthenticationResult>

loginRedirect(RedirectRequest)

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

Parameters

request

RedirectRequest

Returns

Promise<void>

logout(EndSessionRequest)

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

Parameters

logoutRequest

EndSessionRequest

Returns

Promise<void>

logoutPopup(EndSessionPopupRequest)

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

Parameters

logoutRequest

EndSessionPopupRequest

Returns

Promise<void>

logoutRedirect(EndSessionRequest)

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

Parameters

logoutRequest

EndSessionRequest

Returns

Promise<void>

removeEventCallback(string)

function removeEventCallback(callbackId: string)

Parameters

callbackId

string

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

Parameters

callbackId

string

Returns

boolean

setActiveAccount(AccountInfo | null)

function setActiveAccount(account: AccountInfo | null)

Parameters

account

AccountInfo | null

setLogger(Logger)

function setLogger(logger: Logger)

Parameters

logger

Logger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

Parameters

navigationClient

INavigationClient

ssoSilent(SsoSilentRequest)

function ssoSilent(request: SsoSilentRequest): Promise<AuthenticationResult>

Parameters

request

SsoSilentRequest

Returns

Promise<AuthenticationResult>