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.

342 lines
19 KiB

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