You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

350 lines
20 KiB

4 years ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.Facebook</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Owin.FacebookAuthenticationExtensions">
  8. <summary>
  9. Extension methods for using <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
  10. </summary>
  11. </member>
  12. <member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
  13. <summary>
  14. Authenticate users using Facebook
  15. </summary>
  16. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  17. <param name="options">Middleware configuration options</param>
  18. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  19. </member>
  20. <member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,System.String,System.String)">
  21. <summary>
  22. Authenticate users using Facebook
  23. </summary>
  24. <param name="app">The <see cref="T:Owin.IAppBuilder"/> passed to the configuration method</param>
  25. <param name="appId">The appId assigned by Facebook</param>
  26. <param name="appSecret">The appSecret assigned by Facebook</param>
  27. <returns>The updated <see cref="T:Owin.IAppBuilder"/></returns>
  28. </member>
  29. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware">
  30. <summary>
  31. OWIN middleware for authenticating users using Facebook
  32. </summary>
  33. </member>
  34. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
  35. <summary>
  36. Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
  37. </summary>
  38. <param name="next">The next middleware in the OWIN pipeline to invoke</param>
  39. <param name="app">The OWIN application</param>
  40. <param name="options">Configuration options for the middleware</param>
  41. </member>
  42. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.CreateHandler">
  43. <summary>
  44. Provides the <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler"/> object for processing authentication-related requests.
  45. </summary>
  46. <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>
  47. </member>
  48. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions">
  49. <summary>
  50. Configuration options for <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"/>
  51. </summary>
  52. </member>
  53. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.#ctor">
  54. <summary>
  55. Initializes a new <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions"/>
  56. </summary>
  57. </member>
  58. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppId">
  59. <summary>
  60. Gets or sets the Facebook-assigned appId
  61. </summary>
  62. </member>
  63. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppSecret">
  64. <summary>
  65. Gets or sets the Facebook-assigned app secret
  66. </summary>
  67. </member>
  68. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AuthorizationEndpoint">
  69. <summary>
  70. Gets or sets the URI where the client will be redirected to authenticate.
  71. </summary>
  72. </member>
  73. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.TokenEndpoint">
  74. <summary>
  75. Gets or sets the URI the middleware will access to exchange the OAuth token.
  76. </summary>
  77. </member>
  78. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.UserInformationEndpoint">
  79. <summary>
  80. Gets or sets the URI the middleware will access to obtain the user information.
  81. </summary>
  82. </member>
  83. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelCertificateValidator">
  84. <summary>
  85. Gets or sets the a pinned certificate validator to use to validate the endpoints used
  86. in back channel communications belong to Facebook.
  87. </summary>
  88. <value>
  89. The pinned certificate validator.
  90. </value>
  91. <remarks>If this property is null then the default certificate checks are performed,
  92. validating the subject name and if the signing chain is a trusted party.</remarks>
  93. </member>
  94. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelTimeout">
  95. <summary>
  96. Gets or sets timeout value in milliseconds for back channel communications with Facebook.
  97. </summary>
  98. <value>
  99. The back channel timeout in milliseconds.
  100. </value>
  101. </member>
  102. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelHttpHandler">
  103. <summary>
  104. The HttpMessageHandler used to communicate with Facebook.
  105. This cannot be set at the same time as BackchannelCertificateValidator unless the value
  106. can be downcast to a WebRequestHandler.
  107. </summary>
  108. </member>
  109. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Caption">
  110. <summary>
  111. Get or sets the text that the user can display on a sign in user interface.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.CallbackPath">
  115. <summary>
  116. The request path within the application's base path where the user-agent will be returned.
  117. The middleware will process this request when it arrives.
  118. Default value is "/signin-facebook".
  119. </summary>
  120. </member>
  121. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SignInAsAuthenticationType">
  122. <summary>
  123. 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"/>.
  124. </summary>
  125. </member>
  126. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Provider">
  127. <summary>
  128. Gets or sets the <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider"/> used to handle authentication events.
  129. </summary>
  130. </member>
  131. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.StateDataFormat">
  132. <summary>
  133. Gets or sets the type used to secure data handled by the middleware.
  134. </summary>
  135. </member>
  136. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Scope">
  137. <summary>
  138. A list of permissions to request.
  139. </summary>
  140. </member>
  141. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SendAppSecretProof">
  142. <summary>
  143. Gets or sets if the appsecret_proof should be generated and sent with Facebook API calls.
  144. This is enabled by default.
  145. </summary>
  146. </member>
  147. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Fields">
  148. <summary>
  149. The list of fields to retrieve from the UserInformationEndpoint.
  150. https://developers.facebook.com/docs/graph-api/reference/user
  151. </summary>
  152. </member>
  153. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.CookieManager">
  154. <summary>
  155. An abstraction for reading and setting cookies during the authentication process.
  156. </summary>
  157. </member>
  158. <member name="T:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext">
  159. <summary>
  160. Context passed when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
  161. </summary>
  162. </member>
  163. <member name="M:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
  164. <summary>
  165. Creates a new context object.
  166. </summary>
  167. <param name="context">The OWIN request context</param>
  168. <param name="options">The Facebook middleware options</param>
  169. <param name="properties">The authenticaiton properties of the challenge</param>
  170. <param name="redirectUri">The initial redirect URI</param>
  171. </member>
  172. <member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.RedirectUri">
  173. <summary>
  174. Gets the URI used for the redirect operation.
  175. </summary>
  176. </member>
  177. <member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.Properties">
  178. <summary>
  179. Gets the authentication properties of the challenge
  180. </summary>
  181. </member>
  182. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext">
  183. <summary>
  184. Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
  185. </summary>
  186. </member>
  187. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,Newtonsoft.Json.Linq.JObject,System.String,System.String)">
  188. <summary>
  189. Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext"/>
  190. </summary>
  191. <param name="context">The OWIN environment</param>
  192. <param name="user">The JSON-serialized user</param>
  193. <param name="accessToken">Facebook Access token</param>
  194. <param name="expires">Seconds until expiration</param>
  195. </member>
  196. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.User">
  197. <summary>
  198. Gets the JSON-serialized user
  199. </summary>
  200. </member>
  201. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.AccessToken">
  202. <summary>
  203. Gets the Facebook access token
  204. </summary>
  205. </member>
  206. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.ExpiresIn">
  207. <summary>
  208. Gets the Facebook access token expiration time
  209. </summary>
  210. </member>
  211. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Id">
  212. <summary>
  213. Gets the Facebook user ID
  214. </summary>
  215. </member>
  216. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Name">
  217. <summary>
  218. Gets the user's name
  219. </summary>
  220. </member>
  221. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.UserName">
  222. <summary>
  223. Gets the Facebook username
  224. </summary>
  225. </member>
  226. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Email">
  227. <summary>
  228. Gets the Facebook email
  229. </summary>
  230. </member>
  231. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Identity">
  232. <summary>
  233. Gets the <see cref="T:System.Security.Claims.ClaimsIdentity"/> representing the user
  234. </summary>
  235. </member>
  236. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Properties">
  237. <summary>
  238. Gets or sets a property bag for common authentication properties
  239. </summary>
  240. </member>
  241. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider">
  242. <summary>
  243. Default <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider"/> implementation.
  244. </summary>
  245. </member>
  246. <member name="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider">
  247. <summary>
  248. Specifies callback methods which the <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware"></see> invokes to enable developer control over the authentication process. /&gt;
  249. </summary>
  250. </member>
  251. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
  252. <summary>
  253. Invoked whenever Facebook succesfully authenticates a user
  254. </summary>
  255. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  256. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  257. </member>
  258. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
  259. <summary>
  260. 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.
  261. </summary>
  262. <param name="context"></param>
  263. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  264. </member>
  265. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
  266. <summary>
  267. Called when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
  268. </summary>
  269. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  270. </member>
  271. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.#ctor">
  272. <summary>
  273. Initializes a <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider"/>
  274. </summary>
  275. </member>
  276. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
  277. <summary>
  278. Invoked whenever Facebook succesfully authenticates a user
  279. </summary>
  280. <param name="context">Contains information about the login session as well as the user <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
  281. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  282. </member>
  283. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
  284. <summary>
  285. 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.
  286. </summary>
  287. <param name="context"></param>
  288. <returns>A <see cref="T:System.Threading.Tasks.Task"/> representing the completed operation.</returns>
  289. </member>
  290. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
  291. <summary>
  292. Called when a Challenge causes a redirect to authorize endpoint in the Facebook middleware
  293. </summary>
  294. <param name="context">Contains redirect URI and <see cref="T:Microsoft.Owin.Security.AuthenticationProperties"/> of the challenge </param>
  295. </member>
  296. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnAuthenticated">
  297. <summary>
  298. Gets or sets the function that is invoked when the Authenticated method is invoked.
  299. </summary>
  300. </member>
  301. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnReturnEndpoint">
  302. <summary>
  303. Gets or sets the function that is invoked when the ReturnEndpoint method is invoked.
  304. </summary>
  305. </member>
  306. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnApplyRedirect">
  307. <summary>
  308. Gets or sets the delegate that is invoked when the ApplyRedirect method is invoked.
  309. </summary>
  310. </member>
  311. <member name="T:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext">
  312. <summary>
  313. Provides context information to middleware providers.
  314. </summary>
  315. </member>
  316. <member name="M:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
  317. <summary>
  318. </summary>
  319. <param name="context">OWIN environment</param>
  320. <param name="ticket">The authentication ticket</param>
  321. </member>
  322. <member name="T:Microsoft.Owin.Security.Facebook.Resources">
  323. <summary>
  324. A strongly-typed resource class, for looking up localized strings, etc.
  325. </summary>
  326. </member>
  327. <member name="P:Microsoft.Owin.Security.Facebook.Resources.ResourceManager">
  328. <summary>
  329. Returns the cached ResourceManager instance used by this class.
  330. </summary>
  331. </member>
  332. <member name="P:Microsoft.Owin.Security.Facebook.Resources.Culture">
  333. <summary>
  334. Overrides the current thread's CurrentUICulture property for all
  335. resource lookups using this strongly typed resource class.
  336. </summary>
  337. </member>
  338. <member name="P:Microsoft.Owin.Security.Facebook.Resources.Exception_OptionMustBeProvided">
  339. <summary>
  340. Looks up a localized string similar to The &apos;{0}&apos; option must be provided..
  341. </summary>
  342. </member>
  343. <member name="P:Microsoft.Owin.Security.Facebook.Resources.Exception_ValidatorHandlerMismatch">
  344. <summary>
  345. Looks up a localized string similar to An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler..
  346. </summary>
  347. </member>
  348. </members>
  349. </doc>