Class BrowserUtils

Utility class for browser specific functions

Hierarchy

BrowserUtils

Index

Constructors

constructor

Methods

Constructors

constructor

new BrowserUtils(): BrowserUtils

Returns BrowserUtils

Methods

Static blockAcquireTokenInPopups

blockAcquireTokenInPopups(): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:114
Block redirectUri loaded in popup from calling AcquireToken APIs

Returns void

Static blockNativeBrokerCalledBeforeInitialized

blockNativeBrokerCalledBeforeInitialized(allowNativeBroker: boolean, initialized: boolean): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:136
Throws error if native brokering is enabled but initialize hasn't been called

Parameters
- allowNativeBroker: boolean
- initialized: boolean
Returns void

Static blockNonBrowserEnvironment

blockNonBrowserEnvironment(isBrowserEnvironment: boolean): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:125
Throws error if token requests are made in non-browser environment

Parameters
- isBrowserEnvironment: boolean
  
  Flag indicating if environment is a browser.
Returns void

Static blockRedirectInIframe

blockRedirectInIframe(interactionType: InteractionType, allowRedirectInIframe: boolean): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:103
Block redirect operations in iframes unless explicitly allowed

Parameters
- interactionType: InteractionType
  
  Interaction type for the request
- allowRedirectInIframe: boolean
  
  Config value to allow redirects when app is inside an iframe
Returns void

Static blockReloadInHiddenIframes

blockReloadInHiddenIframes(): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:90
Throws error if we have completed an auth and are attempting another auth request inside an iframe.

Returns void

Static clearHash

clearHash(contentWindow: Window): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:22
Clears hash from window url.

Parameters
- contentWindow: Window
Returns void

Static detectIEOrEdge

detectIEOrEdge(): boolean

- Defined in msal-browser/src/utils/BrowserUtils.ts:145
Returns boolean of whether current browser is an Internet Explorer or Edge browser.

Returns boolean

Static getBrowserNetworkClient

getBrowserNetworkClient(): INetworkModule

- Defined in msal-browser/src/utils/BrowserUtils.ts:78
Returns best compatible network client object.

Returns INetworkModule

Static getCurrentUri

getCurrentUri(): string

- Defined in msal-browser/src/utils/BrowserUtils.ts:62
Returns current window URL as redirect uri

Returns string

Static getHomepage

getHomepage(): string

- Defined in msal-browser/src/utils/BrowserUtils.ts:69
Gets the homepage url for the current window location.

Returns string

Static isInIframe

isInIframe(): boolean

- Defined in msal-browser/src/utils/BrowserUtils.ts:43
Returns boolean of whether the current window is in an iframe or not.

Returns boolean

Static isInPopup

isInPopup(): boolean

- Defined in msal-browser/src/utils/BrowserUtils.ts:50
Returns boolean of whether or not the current window is a popup opened by msal

Returns boolean

Static replaceHash

replaceHash(url: string): void

- Defined in msal-browser/src/utils/BrowserUtils.ts:34
Replaces current hash with hash from provided url

Parameters
- url: string
Returns void

Generated using TypeDoc