Microsoft.Owin.Security.Facebook.XML
19 KB
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Owin.Security.Facebook</name>
</assembly>
<members>
<member name="T:Owin.FacebookAuthenticationExtensions">
<summary>
Extension methods for using <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
</summary>
</member>
<member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
<summary>
Authenticate users using Facebook
</summary>
<param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
<param name="options">Middleware configuration options</param>
<returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
</member>
<member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,System.String,System.String)">
<summary>
Authenticate users using Facebook
</summary>
<param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
<param name="appId">The appId assigned by Facebook</param>
<param name="appSecret">The appSecret assigned by Facebook</param>
<returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware">
<summary>
OWIN middleware for authenticating users using Facebook
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
<summary>
Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
</summary>
<param name="next">The next middleware in the OWIN pipeline to invoke</param>
<param name="app">The OWIN application</param>
<param name="options">Configuration options for the middleware</param>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.CreateHandler">
<summary>
Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
</summary>
<returns>An <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> configured with the <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions"/> supplied to the constructor.</returns>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions">
<summary>
Configuration options for <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.#ctor">
<summary>
Initializes a new <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions"/>
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppId">
<summary>
Gets or sets the Facebook-assigned appId
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppSecret">
<summary>
Gets or sets the Facebook-assigned app secret
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AuthorizationEndpoint">
<summary>
Gets or sets the URI where the client will be redirected to authenticate.
The default value is 'https://www.facebook.com/dialog/oauth'.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.TokenEndpoint">
<summary>
Gets or sets the URI the middleware will access to exchange the OAuth token.
The default value is 'https://graph.facebook.com/oauth/access_token'.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.UserInformationEndpoint">
<summary>
Gets or sets the URI the middleware will access to obtain the user information.
The default value is 'https://graph.facebook.com/me'.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelCertificateValidator">
<summary>
Gets or sets the a pinned certificate validator to use to validate the endpoints used
in back channel communications belong to Facebook.
</summary>
<value>
The pinned certificate validator.
</value>
<remarks>If this property is null then the default certificate checks are performed,
validating the subject name and if the signing chain is a trusted party.</remarks>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelTimeout">
<summary>
Gets or sets timeout value in milliseconds for back channel communications with Facebook.
</summary>
<value>
The back channel timeout in milliseconds.
</value>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelHttpHandler">
<summary>
The HttpMessageHandler used to communicate with Facebook.
This cannot be set at the same time as BackchannelCertificateValidator unless the value
can be downcast to a WebRequestHandler.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Caption">
<summary>
Get or sets the text that the user can display on a sign in user interface.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.CallbackPath">
<summary>
The request path within the application's base path where the user-agent will be returned.
The middleware will process this request when it arrives.
Default value is "/signin-facebook".
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SignInAsAuthenticationType">
<summary>
Gets or sets the name of another authentication middleware which will be responsible for actually issuing a user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Provider">
<summary>
Gets or sets the <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider"/> used to handle authentication events.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.StateDataFormat">
<summary>
Gets or sets the type used to secure data handled by the middleware.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Scope">
<summary>
A list of permissions to request.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SendAppSecretProof">
<summary>
Gets or sets if the appsecret_proof should be generated and sent with Facebook API calls.
This is enabled by default.
</summary>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext">
<summary>
Context passed when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
<summary>
Creates a new context object.
</summary>
<param name="context">The OWIN request context</param>
<param name="options">The Facebook middleware options</param>
<param name="properties">The authenticaiton properties of the challenge</param>
<param name="redirectUri">The initial redirect URI</param>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.RedirectUri">
<summary>
Gets the URI used for the redirect operation.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.Properties">
<summary>
Gets the authentication properties of the challenge
</summary>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext">
<summary>
Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,Newtonsoft.Json.Linq.JObject,System.String,System.String)">
<summary>
Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext"/>
</summary>
<param name="context">The OWIN environment</param>
<param name="user">The JSON-serialized user</param>
<param name="accessToken">Facebook Access token</param>
<param name="expires">Seconds until expiration</param>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.User">
<summary>
Gets the JSON-serialized user
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.AccessToken">
<summary>
Gets the Facebook access token
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.ExpiresIn">
<summary>
Gets the Facebook access token expiration time
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Id">
<summary>
Gets the Facebook user ID
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Name">
<summary>
Gets the user's name
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.UserName">
<summary>
Gets the Facebook username
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Email">
<summary>
Gets the Facebook email
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Identity">
<summary>
Gets the <see cref="T:System.Security.Claims.ClaimsIdentity"/> representing the user
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Properties">
<summary>
Gets or sets a property bag for common authentication properties
</summary>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider">
<summary>
Default <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider"/> implementation.
</summary>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider">
<summary>
Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. />
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
<summary>
Invoked whenever Facebook succesfully authenticates a user
</summary>
<param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
<summary>
Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
</summary>
<param name="context"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
<summary>
Called when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
</summary>
<param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.#ctor">
<summary>
Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider"/>
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
<summary>
Invoked whenever Facebook succesfully authenticates a user
</summary>
<param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
<summary>
Invoked prior to the <see cref="T:System.Security.Claims.ClaimsIdentity"/> being saved in a local cookie and the browser being redirected to the originally requested URL.
</summary>
<param name="context"></param>
<returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
<summary>
Called when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
</summary>
<param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnAuthenticated">
<summary>
Gets or sets the function that is invoked when the Authenticated method is invoked.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnReturnEndpoint">
<summary>
Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnApplyRedirect">
<summary>
Gets or sets the delegate that is invoked when the ApplyRedirect method is invoked.
</summary>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext">
<summary>
Provides context information to middleware providers.
</summary>
</member>
<member name="M:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
<summary>
</summary>
<param name="context">OWIN environment</param>
<param name="ticket">The authentication ticket</param>
</member>
<member name="T:Microsoft.Owin.Security.Facebook.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.Resources.Exception_OptionMustBeProvided">
<summary>
Looks up a localized string similar to The '{0}' option must be provided..
</summary>
</member>
<member name="P:Microsoft.Owin.Security.Facebook.Resources.Exception_ValidatorHandlerMismatch">
<summary>
Looks up a localized string similar to An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler..
</summary>
</member>
</members>
</doc>