ICustomAuthPublicClientApplication interface

扩展

IPublicClientApplication

方法

getCurrentAccount(CustomAuthActionInputs)

从缓存中获取当前帐户。

resetPassword(ResetPasswordInputs)

启动重置密码流。

signIn(SignInInputs)

启动登录流。

signUp(SignUpInputs)

启动注册流。

方法详细信息

getCurrentAccount(CustomAuthActionInputs)

从缓存中获取当前帐户。

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

参数

accountRetrievalInputs

CustomAuthActionInputs

用于获取当前缓存帐户的输入

返回

操作的结果

resetPassword(ResetPasswordInputs)

启动重置密码流。

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

参数

resetPasswordInputs
ResetPasswordInputs

重置密码流的输入

返回

解析为 ResetPasswordStartResult 的承诺

signIn(SignInInputs)

启动登录流。

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

参数

signInInputs
SignInInputs

登录流的输入

返回

Promise<SignInResult>

解析为 SignInResult 的承诺

signUp(SignUpInputs)

启动注册流。

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

参数

signUpInputs
SignUpInputs

注册流的输入

返回

Promise<SignUpResult>

解析为 SignUpResult 的承诺

继承的方法详细信息

acquireTokenByCode(AuthorizationCodeRequest)

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

参数

request

AuthorizationCodeRequest

返回

Promise<AuthenticationResult>

继承自 IPublicClientApplication.acquireTokenByCode

acquireTokenPopup(PopupRequest)

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

参数

request

PopupRequest

返回

Promise<AuthenticationResult>

继承自 IPublicClientApplication.acquireTokenPopup

acquireTokenRedirect(RedirectRequest)

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

参数

request

RedirectRequest

返回

Promise<void>

继承自 IPublicClientApplication.acquireTokenRedirect

acquireTokenSilent(SilentRequest)

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

参数

silentRequest

SilentRequest

返回

Promise<AuthenticationResult>

继承自 IPublicClientApplication.acquireTokenSilent

addEventCallback(EventCallbackFunction, EventType[])

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

参数

callback

EventCallbackFunction

eventTypes

EventType[]

返回

null | string

继承自 IPublicClientApplication.addEventCallback

addPerformanceCallback(PerformanceCallbackFunction)

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

参数

返回

string

继承自 IPublicClientApplication.addPerformanceCallback

clearCache(ClearCacheRequest)

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

参数

logoutRequest

ClearCacheRequest

返回

Promise<void>

继承自 IPublicClientApplication.clearCache

disableAccountStorageEvents()

function disableAccountStorageEvents()

继承自 IPublicClientApplication.disableAccountStorageEvents

enableAccountStorageEvents()

function enableAccountStorageEvents()

继承自 IPublicClientApplication.enableAccountStorageEvents

getAccount(AccountFilter)

function getAccount(accountFilter: AccountFilter): null | AccountInfo

参数

accountFilter
AccountFilter

返回

null | AccountInfo

继承自 IPublicClientApplication.getAccount

getAccountByHomeId(string)

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

参数

homeAccountId

string

返回

null | AccountInfo

继承自 IPublicClientApplication.getAccountByHomeId

getAccountByLocalId(string)

function getAccountByLocalId(localId: string): null | AccountInfo

参数

localId

string

返回

null | AccountInfo

继承自 IPublicClientApplication.getAccountByLocalId

getAccountByUsername(string)

function getAccountByUsername(userName: string): null | AccountInfo

参数

userName

string

返回

null | AccountInfo

继承自 IPublicClientApplication.getAccountByUsername

getActiveAccount()

function getActiveAccount(): null | AccountInfo

返回

null | AccountInfo

继承自 IPublicClientApplication.getActiveAccount

getAllAccounts()

function getAllAccounts(): AccountInfo[]

返回

继承自 IPublicClientApplication.getAllAccounts

getLogger()

function getLogger(): Logger

返回

继承自 IPublicClientApplication.getLogger

getTokenCache()

function getTokenCache(): ITokenCache

返回

ITokenCache

继承自 IPublicClientApplication.getTokenCache

handleRedirectPromise(string)

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

参数

hash

string

返回

Promise<null | AuthenticationResult>

继承自 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>

参数

result

AuthenticationResult

request

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

返回

Promise<void>

继承自 IPublicClientApplication.hydrateCache

initialize(InitializeApplicationRequest)

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

参数

request

InitializeApplicationRequest

返回

Promise<void>

继承自 IPublicClientApplication.initialize

initializeWrapperLibrary(WrapperSKU, string)

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

参数

sku

WrapperSKU

version

string

继承自 IPublicClientApplication.initializeWrapperLibrary

loginPopup(PopupRequest)

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

参数

request

PopupRequest

返回

Promise<AuthenticationResult>

继承自 IPublicClientApplication.loginPopup

loginRedirect(RedirectRequest)

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

参数

request

RedirectRequest

返回

Promise<void>

继承自 IPublicClientApplication.loginRedirect

logout(EndSessionRequest)

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

参数

logoutRequest

EndSessionRequest

返回

Promise<void>

继承自 IPublicClientApplication.logout

logoutPopup(EndSessionPopupRequest)

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

参数

logoutRequest

EndSessionPopupRequest

返回

Promise<void>

继承自 IPublicClientApplication.logoutPopup

logoutRedirect(EndSessionRequest)

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

参数

logoutRequest

EndSessionRequest

返回

Promise<void>

继承自 IPublicClientApplication.logoutRedirect

removeEventCallback(string)

function removeEventCallback(callbackId: string)

参数

callbackId

string

继承自 IPublicClientApplication.removeEventCallback

removePerformanceCallback(string)

function removePerformanceCallback(callbackId: string): boolean

参数

callbackId

string

返回

boolean

继承自 IPublicClientApplication.removePerformanceCallback

setActiveAccount(null | AccountInfo)

function setActiveAccount(account: null | AccountInfo)

参数

account

null | AccountInfo

继承自 IPublicClientApplication.setActiveAccount

setLogger(Logger)

function setLogger(logger: Logger)

参数

logger
Logger

继承自 IPublicClientApplication.setLogger

setNavigationClient(INavigationClient)

function setNavigationClient(navigationClient: INavigationClient)

参数

navigationClient

INavigationClient

继承自 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>

参数

request

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

返回

Promise<AuthenticationResult>

继承自 IPublicClientApplication.ssoSilent