Class BrowserUtils

Utility class for browser specific functions

Hierarchy

BrowserUtils

Index

Constructors

Methods

blockAPICallsBeforeInitialize blockAcquireTokenInPopups blockNonBrowserEnvironment blockRedirectInIframe blockReloadInHiddenIframes clearHash getCurrentUri getHomepage isInIframe isInPopup replaceHash

Constructors

constructor

new BrowserUtils(): BrowserUtils
Returns BrowserUtils

Methods

`Static` blockAPICallsBeforeInitialize

blockAPICallsBeforeInitialize(initialized): void
Throws error if initialize hasn't been called
Parameters
- initialized: boolean
Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:149

`Static` blockAcquireTokenInPopups

blockAcquireTokenInPopups(): void
Block redirectUri loaded in popup from calling AcquireToken APIs

Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:124

`Static` blockNonBrowserEnvironment

blockNonBrowserEnvironment(isBrowserEnvironment): void
Throws error if token requests are made in non-browser environment
Parameters
- isBrowserEnvironment: boolean
  
  Flag indicating if environment is a browser.
Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:137

`Static` blockRedirectInIframe

blockRedirectInIframe(interactionType, allowRedirectInIframe): void
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
- Defined in msal-browser/src/utils/BrowserUtils.ts:104

`Static` blockReloadInHiddenIframes

blockReloadInHiddenIframes(): void
Throws error if we have completed an auth and are attempting another auth request inside an iframe.

Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:87

`Static` clearHash

clearHash(contentWindow): void
Clears hash from window url.
Parameters
- contentWindow: Window
Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:22

`Static` getCurrentUri

getCurrentUri(): string
Returns current window URL as redirect uri

Returns string
- Defined in msal-browser/src/utils/BrowserUtils.ts:70

`Static` getHomepage

getHomepage(): string
Gets the homepage url for the current window location.

Returns string
- Defined in msal-browser/src/utils/BrowserUtils.ts:77

`Static` isInIframe

isInIframe(): boolean
Returns boolean of whether the current window is in an iframe or not.

Returns boolean
- Defined in msal-browser/src/utils/BrowserUtils.ts:48

`Static` isInPopup

isInPopup(): boolean
Returns boolean of whether or not the current window is a popup opened by msal

Returns boolean
- Defined in msal-browser/src/utils/BrowserUtils.ts:55

`Static` replaceHash

replaceHash(url): void
Replaces current hash with hash from provided url
Parameters
- url: string
Returns void
- Defined in msal-browser/src/utils/BrowserUtils.ts:38

Generated using TypeDoc