Class EventHandler

Hierarchy

EventHandler

Index

Constructors

Methods

addEventCallback emitEvent removeEventCallback subscribeCrossTab unsubscribeCrossTab

Constructors

constructor

new EventHandler(logger?): EventHandler
Parameters
- Optional logger: Logger
Returns EventHandler
- Defined in msal-browser/src/event/EventHandler.ts:28

Methods

addEventCallback

addEventCallback(callback, eventTypes?, callbackId?): null | string
Adds event callbacks to array
Parameters
- callback: EventCallbackFunction
  
  callback to be invoked when an event is raised
- Optional eventTypes: EventType[]
  
  list of events that this callback will be invoked for, if not provided callback will be invoked for all events
- Optional callbackId: string
  
  Identifier for the callback, used to locate and remove the callback when no longer required
Returns null | string
- Defined in msal-browser/src/event/EventHandler.ts:45

emitEvent

emitEvent(eventType, interactionType?, payload?, error?): void
Emits events by calling callback with event message
Parameters
- eventType: EventType
- Optional interactionType: InteractionType
- Optional payload: EventPayload
- Optional error: EventError
Returns void
- Defined in msal-browser/src/event/EventHandler.ts:83

removeEventCallback

removeEventCallback(callbackId): void
Removes callback with provided id from callback array
Parameters
- callbackId: string
Returns void
- Defined in msal-browser/src/event/EventHandler.ts:71

subscribeCrossTab

subscribeCrossTab(): void
Listen for events broadcasted from other tabs/instances

Returns void
- Defined in msal-browser/src/event/EventHandler.ts:149

unsubscribeCrossTab

unsubscribeCrossTab(): void
Unsubscribe from broadcast events

Returns void
- Defined in msal-browser/src/event/EventHandler.ts:159

Generated using TypeDoc