Microsoft.Identity.Client.Desktop.4.36.1/netcoreapp3.1/Microsoft.Identity.Client.Desktop.xml

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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.Identity.Client.Desktop</name>
    </assembly>
    <members>
        <member name="T:Microsoft.Identity.Client.Desktop.DesktopExtensions">
            <summary>
            MSAL extensions for desktop apps
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Desktop.DesktopExtensions.WithDesktopFeatures(Microsoft.Identity.Client.PublicClientApplicationBuilder)">
            <summary>
            Adds enhanced support for desktop applications, e.g. CLI, WinForms, WPF apps.
             
            Support added is around:
             
            - Windows Authentication Manager (WAM) broker, the recommended authentication mechanism on Windows 10 - https://aka.ms/msal-net-wam
            - WebView2 embedded web view, based on Microsoft Edge - https://aka.ms/msal-net-webview2
            </summary>
            <remarks>These extensions live in a separate package to avoid adding dependencies to MSAL</remarks>
        </member>
        <member name="M:Microsoft.Identity.Client.Desktop.DesktopExtensions.AddSupportForWebView2(Microsoft.Identity.Client.PublicClientApplicationBuilder)">
            <summary>
            Enables Windows broker flows on older platforms, such as .NET framework, where these are not available in the box with Microsoft.Identity.Client
            For details about Windows broker, see https://aka.ms/msal-net-wam
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Desktop.WamExtension">
            <summary>
            WAM related extensions.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Desktop.WamExtension.WithWindowsBroker(Microsoft.Identity.Client.PublicClientApplicationBuilder,System.Boolean)">
            <summary>
            Enables Windows broker flows on older platforms, such as .NET framework, where these are not available in the box with Microsoft.Identity.Client
            For details about Windows broker, see https://aka.ms/msal-net-wam
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.AadPlugin.GetAccountsAsync(System.String,Microsoft.Identity.Client.AuthorityInfo,Microsoft.Identity.Client.Cache.ICacheSessionManager,Microsoft.Identity.Client.Instance.Discovery.IInstanceDiscoveryManager)">
            <summary>
            The algorithm here is much more complex in order to workaround a limitation in the AAD plugin's
            handling of guest accounts:
             
            1. Read the accounts from WAM.AADPlugin
            2. For each account, we need to find its home_account_id as the one from WAM may not be correct
            3. If we can find a cached account with the same LocalAccountId or UPN, use it
            4. If not, make a simple silent token request and use the client info provided
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.AccountPicker.UseSplashScreen">
            <summary>
            Account Picker APIs do not work well with console apps because the console
            window belongs to a different process, which causes a security exception.
            In general, if the parent window handle does not belong to the current process,
            we need to take control over the window handle by injecting a splash screen.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.AccountPicker.ShowPickerWithSplashScreenAsync">
            <summary>
            The account picker API has bug that prevent correct usage from console apps.
            To workaround, show a splash screen and attach to it.
            </summary>
            <returns></returns>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WamBroker.LegacyOsWamProxy">
            <summary>
            Some Windows APIs do not exist in all versions of Windows, such as WebAuthenticationCoreManager.FindAllAccountsAsync
            Windows provides a mechanism to detect their presence via ApiInformation.IsMethodPresent, however, just **loading** a
            class that has WebAuthenticationCoreManager.FindAllAccountsAsync in the code produces a MissingMethod exception.
             
            This class groups all these legacy APIs and keeps them separated so as to avoid the problem - callers should ensure ApiInformation.IsMethodPresent
            is called before.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.MsaPlugin.GetAccountsAsync(System.String,Microsoft.Identity.Client.AuthorityInfo,Microsoft.Identity.Client.Cache.ICacheSessionManager,Microsoft.Identity.Client.Instance.Discovery.IInstanceDiscoveryManager)">
            <summary>
            Generally the MSA plugin will NOT return the accounts back to the app. This is due
            to privacy concerns. However, some test apps are allowed to do this, hence the code.
            Normal 1st and 3rd party apps must use AcquireTokenInteractive to login first, and then MSAL will
            save the account for later use.
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WamBroker.SynchronizationContextExtensions">
            <summary>
            Based on https://thomaslevesque.com/2015/11/11/explicitly-switch-to-the-ui-thread-in-an-async-method/
            Makes the synchronization context await-able
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WamBroker.WamBroker">
            <summary>
            Important: all the WAM code has Win10 specific types and MUST be guarded against
            usage on older Windows, Mac and Linux, otherwise TypeLoadExceptions occur
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.WamBroker.#ctor(Microsoft.Identity.Client.UI.CoreUIParent,Microsoft.Identity.Client.ApplicationConfiguration,Microsoft.Identity.Client.Core.ICoreLogger,Microsoft.Identity.Client.Platforms.Features.WamBroker.IWamPlugin,Microsoft.Identity.Client.Platforms.Features.WamBroker.IWamPlugin,Microsoft.Identity.Client.Platforms.Features.WamBroker.IWamProxy,Microsoft.Identity.Client.Platforms.Features.WamBroker.IWebAccountProviderFactory,Microsoft.Identity.Client.Platforms.Features.WamBroker.IAccountPickerFactory,Microsoft.Identity.Client.Platforms.Features.WamBroker.IMsaPassthroughHandler)">
            <summary>
            Ctor. Only call if on Win10, otherwise a TypeLoadException occurs. See DesktopOsHelper.IsWin10
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.WamBroker.AcquireTokenInteractiveAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters,Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenInteractiveParameters)">
            <summary>
            In WAM, AcquireTokenInteractive is always associated to an account. WAM also allows for an "account picker" to be displayed,
            which is similar to the EVO browser experience, allowing the user to add an account or use an existing one.
             
            MSAL does not have a concept of account picker so MSAL.AccquireTokenInteractive will:
             
            1. Call WAM.AccountPicker if an IAccount (or possibly login_hint) is not configured
            2. Figure out the WAM.AccountID associated to the MSAL.Account
            3. Call WAM.AcquireTokenInteractive with the WAM.AccountID
             
            To make matters more complicated, WAM has 2 plugins - AAD and MSA. With AAD plugin,
            it is possible to list all WAM accounts and find the one associated to the MSAL account.
            However, MSA plugin does NOT allow listing of accounts, and the only way to figure out the
            WAM account ID is to use the account picker. This makes AcquireTokenSilent impossible for MSA,
            because we would not be able to map an Msal.Account to a WAM.Account. To overcome this,
            we save the WAM.AccountID in MSAL's cache.
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WamBroker.WebTokenRequestResultWrapper">
            <summary>
            Wrapper class to enable testing, since WebTokenRequestResult object doesn't have any ctor
            and interface is not accessible.
            </summary>
        </member>
        <member name="F:Microsoft.Identity.Client.Platforms.Features.WamBroker.win32.Splash.components">
            <summary>
            Required designer variable.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.win32.Splash.Dispose(System.Boolean)">
            <summary>
            Clean up any resources being used.
            </summary>
            <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WamBroker.win32.Splash.InitializeComponent">
            <summary>
            Required method for Designer support - do not modify
            the contents of this method with the code editor.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WebView2WebUi.WinFormsPanelWithWebView2.InvokeHandlingOwnerWindow(System.Action)">
            <summary>
            Some calls need to be made on the UI thread and this is the central place to check if we have an owner
            window and if so, ensure we invoke on that proper thread.
            </summary>
            <param name="action"></param>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventHandler">
            <summary>
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventHandler">
            <summary>
            </summary>
        </member>
        <member name="F:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.NavigationWaitMiliSecs">
            <summary>
            This is how long we allow between completed navigations.
            </summary>
        </member>
        <member name="F:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.NavigationOverallTimeout">
            <summary>
            This is how long all redirect navigations are allowed to run for before a graceful
            termination of the entire browser based authentication process is attempted.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.WaitForCompletionOrTimeout(System.Threading.Thread)">
            <summary>
            Waits on the UI Thread to complete normally for NavigationOverallTimeout.
            After it attempts shutdown the UI thread graceful followed by aborting
            the thread if a graceful shutdown is not successful.
            </summary>
            <param name="uiThread"></param>
            <returns>Returns true if the UI thread completed on its own before the timeout. Otherwise false.</returns>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWebUI.OnAuthenticate">
            <summary>
            Callers expect the call to show the authentication dialog to be synchronous. This is easy in the
            interactive case as ShowDialog is a synchronous call. However, ShowDialog will always show
            the dialog. It can not be hidden. So it can not be used in the silent case. Instead we need
            to do the equivalent of creating our own modal dialog. We start a new thread, launch an
            invisible window on that thread. The original calling thread blocks until the secondary
            UI thread completes.
            </summary>
            <returns></returns>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.#ctor(System.Object)">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.NavigationWaitMiliSecs">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.CloseBrowser">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.SuppressBrowserSubDialogs">
            <summary>
            Make sure that the browser control does not surface any of it's own dialogs.
            For instance bad certificate or javascript error dialogs.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.SignalDone(System.Exception)">
            <summary>
            This method must only be called from the UI thread. Since this is the
            callers opportunity to call dispose on this object. Calling
            Dispose must be done on the same thread on which this object
            was constructed.
            </summary>
            <param name="exception"></param>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.OnClosingUrl">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.OnNavigationCanceled(System.Int32)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.SilentWindowsFormsAuthenticationDialog.Dispose(System.Boolean)">
            <summary>
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs">
            <summary>
            Event arguments for <c>BeforeNavigate</c> event.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.#ctor(System.String,System.Byte[],System.String,System.Int32,System.String,System.Object)">
            <summary>
            Initializes a new instance of <c>WebBrowserBeforeNavigateEventArgs</c>.
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Url">
            <summary>
            The URL to be navigated to.
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.PostData">
            <summary>
            The data to send to the server, if the HTTP POST transaction is used.
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Headers">
            <summary>
            Additional HTTP headers to send to the server
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.Flags">
            <summary>
            The following flag, or zero.
            beforeNavigateExternalFrameTarget (H0001)
            Internet Explorer 7 or later. This navigation is the result of
            an external window or tab that targets this browser.
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.TargetFrameName">
            <summary>
            The name of the frame in which to display the resource,
            or null if no named frame is targeted for the resource.
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs.WebBrowserActiveXInstance">
            <summary>
            A pointer to the IDispatch interface for the WebBrowserControl object that represents the window or frame.
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.#ctor(System.String,System.String,System.Int32,System.Object)">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.TargetFrameName">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.Url">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.WebBrowserActiveXInstance">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs.StatusCode">
            <summary>
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog">
            <summary>
            The browser dialog used for user authentication
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.#ctor(System.Object)">
            <summary>
            Default constructor
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnAuthenticate">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.ShowBrowser">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnClosingUrl">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialog.OnNavigationCanceled(System.Int32)">
            <summary>
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.ownerWindow">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.#ctor(System.Object)">
            <summary>
            </summary>
        </member>
        <member name="P:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowser">
            <summary>
            Gets Web Browser control used by the dialog.
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowserBeforeNavigateHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserBeforeNavigateEventArgs)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.WebBrowserNavigateErrorHandler(System.Object,Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WebBrowserNavigateErrorEventArgs)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnClosingUrl">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnNavigationCanceled(System.Int32)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.OnAuthenticate">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.InvokeHandlingOwnerWindow(System.Action)">
            <summary>
            Some calls need to be made on the UI thread and this is the central place to check if we have an owner
            window and if so, ensure we invoke on that proper thread.
            </summary>
            <param name="action"></param>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.Dispose(System.Boolean)">
            <summary>
            </summary>
        </member>
        <member name="M:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.CreateExceptionForAuthenticationUiFailed(System.Int32)">
            <summary>
            </summary>
        </member>
        <member name="T:Microsoft.Identity.Client.Platforms.Features.WinFormsLegacyWebUi.WindowsFormsWebAuthenticationDialogBase.NativeMethods">
            <summary>
            </summary>
        </member>
    </members>
</doc>