ICustomAuthPublicClientApplication interface

方法

getCurrentAccount(CustomAuthActionInputs)	從快取取得當前帳戶。
resetPassword(ResetPasswordInputs)	啟動重設密碼流程。
signIn(SignInInputs)	啟動簽到流程。
signUp(SignUpInputs)	啟動報名流程。

繼承的方法

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">>)

getCurrentAccount(CustomAuthActionInputs)

從快取取得當前帳戶。

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

參數

accountRetrievalInputs: CustomAuthActionInputs

取得目前快取帳號的輸入

傳回

GetAccountResult

作業的結果

resetPassword(ResetPasswordInputs)

啟動重設密碼流程。

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

參數

resetPasswordInputs: ResetPasswordInputs

重設密碼流程的輸入

傳回

Promise<ResetPasswordStartResult>

一個承諾，解析為 ResetPasswordStartResult

啟動簽到流程。

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

參數

signInInputs: SignInInputs

登入流程的輸入

傳回

Promise<SignInResult>

一個承諾，目標是 SignInResult

啟動報名流程。

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

參數

callback: PerformanceCallbackFunction

傳回

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[]

傳回

AccountInfo[]

繼承自 IPublicClientApplication.getAllAccounts

getLogger()

function getLogger(): Logger

傳回

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

ICustomAuthPublicClientApplication interface

方法

繼承的方法

方法詳細資料

getCurrentAccount(CustomAuthActionInputs)

參數

傳回

resetPassword(ResetPasswordInputs)

參數

傳回

signIn(SignInInputs)

參數

傳回

signUp(SignUpInputs)

參數

傳回

繼承的方法的詳細資料

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)

參數

傳回