SilentHandler class

Package:

@azure/msal-browser

Extends

InteractionHandler

Constructors

SilentHandler(AuthorizationCodeClient, BrowserCacheManager, CommonAuthorizationCodeRequest, Logger, Required<Pick<BrowserSystemOptions, "navigateFrameWait" | "pollIntervalMilliseconds">>)

Methods

initiateAuthRequest(string)	Creates a hidden iframe to given URL using user-requested scopes as an id.
monitorIframeForHash(HTMLIFrameElement, number)	Monitors an iframe content window until it loads a url with a known hash, or hits a specified timeout.

Inherited Methods

handleCodeResponseFromHash(string, string, Authority, INetworkModule)	Function to handle response parameters from hash.
handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, INetworkModule, boolean)	Process auth code response from AAD

Constructor Details

SilentHandler(AuthorizationCodeClient, BrowserCacheManager, CommonAuthorizationCodeRequest, Logger, Required<Pick<BrowserSystemOptions, "navigateFrameWait" | "pollIntervalMilliseconds">>)

new SilentHandler(authCodeModule: AuthorizationCodeClient, storageImpl: BrowserCacheManager, authCodeRequest: CommonAuthorizationCodeRequest, logger: Logger, systemOptions: Required<Pick<BrowserSystemOptions, "navigateFrameWait" | "pollIntervalMilliseconds">>)

Parameters

authCodeModule

AuthorizationCodeClient

storageImpl

BrowserCacheManager

authCodeRequest

CommonAuthorizationCodeRequest

logger

Logger

systemOptions

Required<Pick<BrowserSystemOptions, "navigateFrameWait" | "pollIntervalMilliseconds">>

Method Details

initiateAuthRequest(string)

Creates a hidden iframe to given URL using user-requested scopes as an id.

function initiateAuthRequest(requestUrl: string): Promise<HTMLIFrameElement>

Parameters

requestUrl

string

Returns

Promise<HTMLIFrameElement>

monitorIframeForHash(HTMLIFrameElement, number)

Monitors an iframe content window until it loads a url with a known hash, or hits a specified timeout.

function monitorIframeForHash(iframe: HTMLIFrameElement, timeout: number): Promise<string>

Parameters

iframe

HTMLIFrameElement

timeout

number

Returns

Promise<string>

Inherited Method Details

handleCodeResponseFromHash(string, string, Authority, INetworkModule)

Function to handle response parameters from hash.

function handleCodeResponseFromHash(locationHash: string, state: string, authority: Authority, networkModule: INetworkModule): Promise<AuthenticationResult>

Parameters

locationHash

string

state

string

authority

Authority

networkModule

INetworkModule

Returns

Promise<AuthenticationResult>

Inherited From InteractionHandler.handleCodeResponseFromHash

handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, INetworkModule, boolean)

Process auth code response from AAD

function handleCodeResponseFromServer(authCodeResponse: AuthorizationCodePayload, state: string, authority: Authority, networkModule: INetworkModule, validateNonce?: boolean): Promise<AuthenticationResult>

Parameters

authCodeResponse

AuthorizationCodePayload

state

string

authority

Authority

networkModule

INetworkModule

validateNonce

boolean

Returns

Promise<AuthenticationResult>

Inherited From InteractionHandler.handleCodeResponseFromServer