BrowserUtils module

パッケージ:

@azure/msal-browser

関数

addClientCapabilitiesToClaims(string, string[])
blockAcquireTokenInPopups()	AcquireToken API の呼び出しからポップアップに読み込まれた redirectUri をブロックする
blockAPICallsBeforeInitialize(boolean)	initialize が呼び出されていない場合にエラーをスローします
blockNonBrowserEnvironment()	ブラウザー以外の環境でトークン要求が行われた場合にエラーをスローします
blockRedirectInIframe(boolean)	明示的に許可されていない限り、iframe でのリダイレクト操作をブロックする
blockReloadInHiddenIframes()	認証を完了し、iframe 内で別の認証要求を試行している場合は、エラーをスローします。
clearHash(Window)	ウィンドウ URL からハッシュをクリアします。
createGuid()	現在のタイムスタンプから UUID v7 を作成するラッパー関数。
getCurrentUri()	現在のウィンドウ URL をリダイレクト URI として返します
getHomepage()	現在のウィンドウの場所のホーム ページ URL を取得します。
isInIframe()	現在のウィンドウが iframe 内にあるかどうかを示すブール値を返します。
isInPopup()	現在のウィンドウが msal によって開かれたポップアップかどうかを示すブール値を返します。
preconnect(string)	/token 要求を予期して DNS 解決と SSL 接続を開始する事前接続リンク要素をヘッダーに追加します。
preflightCheck(boolean)	認証要求を行う前にアプリ環境を検証するヘルパー
redirectPreflightCheck(boolean, BrowserConfiguration)	リダイレクト要求を行う前にアプリ環境を検証するヘルパー
replaceHash(string)	現在のハッシュを指定された URL からのハッシュに置き換えます

関数の詳細

addClientCapabilitiesToClaims(string, string[])

function addClientCapabilitiesToClaims(claims?: string, clientCapabilities?: string[]): string

パラメーター

claims

string

clientCapabilities

string[]

返品

string

blockAcquireTokenInPopups()

AcquireToken API の呼び出しからポップアップに読み込まれた redirectUri をブロックする

function blockAcquireTokenInPopups()

blockAPICallsBeforeInitialize(boolean)

initialize が呼び出されていない場合にエラーをスローします

function blockAPICallsBeforeInitialize(initialized: boolean)

パラメーター

initialized

boolean

blockNonBrowserEnvironment()

ブラウザー以外の環境でトークン要求が行われた場合にエラーをスローします

function blockNonBrowserEnvironment()

blockRedirectInIframe(boolean)

明示的に許可されていない限り、iframe でのリダイレクト操作をブロックする

function blockRedirectInIframe(allowRedirectInIframe: boolean)

パラメーター

allowRedirectInIframe

boolean

アプリが iframe 内にあるときにリダイレクトを許可する構成値

blockReloadInHiddenIframes()

認証を完了し、iframe 内で別の認証要求を試行している場合は、エラーをスローします。

function blockReloadInHiddenIframes()

clearHash(Window)

ウィンドウ URL からハッシュをクリアします。

function clearHash(contentWindow: Window)

パラメーター

contentWindow

Window

createGuid()

現在のタイムスタンプから UUID v7 を作成するラッパー関数。

function createGuid(): string

返品

string

getCurrentUri()

現在のウィンドウ URL をリダイレクト URI として返します

function getCurrentUri(): string

返品

string

getHomepage()

現在のウィンドウの場所のホーム ページ URL を取得します。

function getHomepage(): string

返品

string

isInIframe()

現在のウィンドウが iframe 内にあるかどうかを示すブール値を返します。

function isInIframe(): boolean

返品

boolean

isInPopup()

現在のウィンドウが msal によって開かれたポップアップかどうかを示すブール値を返します。

function isInPopup(): boolean

返品

boolean

preconnect(string)

/token 要求を予期して DNS 解決と SSL 接続を開始する事前接続リンク要素をヘッダーに追加します。

function preconnect(authority: string)

パラメーター

authority

string

preflightCheck(boolean)

認証要求を行う前にアプリ環境を検証するヘルパー

function preflightCheck(initialized: boolean)

パラメーター

initialized

boolean

redirectPreflightCheck(boolean, BrowserConfiguration)

リダイレクト要求を行う前にアプリ環境を検証するヘルパー

function redirectPreflightCheck(initialized: boolean, config: BrowserConfiguration)

パラメーター

initialized

boolean

config

BrowserConfiguration

replaceHash(string)

現在のハッシュを指定された URL からのハッシュに置き換えます

function replaceHash(url: string)

パラメーター

url

string