-
Notifications
You must be signed in to change notification settings - Fork 6
/
EventHandler.yml
108 lines (105 loc) · 3.43 KB
/
EventHandler.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
### YamlMime:TSType
name: EventHandler
uid: '@azure/msal-browser.EventHandler'
package: '@azure/msal-browser'
summary: ''
fullName: EventHandler
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: 'EventHandler(Logger, ICrypto)'
uid: '@azure/msal-browser.EventHandler.constructor'
package: '@azure/msal-browser'
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'new EventHandler(logger: Logger, browserCrypto: ICrypto)'
parameters:
- id: logger
type: Logger
description: ''
- id: browserCrypto
type: ICrypto
description: ''
methods:
- name: addEventCallback(EventCallbackFunction)
uid: '@azure/msal-browser.EventHandler.addEventCallback'
package: '@azure/msal-browser'
summary: Adds event callbacks to array
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function addEventCallback(callback: EventCallbackFunction): string |
null
parameters:
- id: callback
type: <xref uid="@azure/msal-browser.EventCallbackFunction" />
description: |+
return:
description: ''
type: string | null
- name: disableAccountStorageEvents()
uid: '@azure/msal-browser.EventHandler.disableAccountStorageEvents'
package: '@azure/msal-browser'
summary: >-
Removes event listener that emits an event when a user account is added or
removed from localstorage in a different browser tab or window
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: function disableAccountStorageEvents()
- name: 'emitEvent(EventType, InteractionType, EventPayload, EventError)'
uid: '@azure/msal-browser.EventHandler.emitEvent'
package: '@azure/msal-browser'
summary: Emits events by calling callback with event message
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function emitEvent(eventType: EventType, interactionType?:
InteractionType, payload?: EventPayload, error?: EventError)
parameters:
- id: eventType
type: <xref uid="@azure/msal-browser.EventType" />
description: ''
- id: interactionType
type: <xref uid="@azure/msal-browser.InteractionType" />
description: ''
- id: payload
type: <xref uid="@azure/msal-browser.EventPayload" />
description: ''
- id: error
type: <xref uid="@azure/msal-browser.EventError" />
description: |+
- name: enableAccountStorageEvents()
uid: '@azure/msal-browser.EventHandler.enableAccountStorageEvents'
package: '@azure/msal-browser'
summary: >-
Adds event listener that emits an event when a user account is added or
removed from localstorage in a different browser tab or window
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: function enableAccountStorageEvents()
- name: removeEventCallback(string)
uid: '@azure/msal-browser.EventHandler.removeEventCallback'
package: '@azure/msal-browser'
summary: Removes callback with provided id from callback array
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function removeEventCallback(callbackId: string)'
parameters:
- id: callbackId
type: string
description: |+