Microsoft.Owin.Security.Facebook.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Owin.Security.Facebook</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext">
  8. <summary>在质询导致重定向到 Facebook 中间件中的授权终结点时传递上下文</summary>
  9. </member>
  10. <member name="M:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions,Microsoft.Owin.Security.AuthenticationProperties,System.String)">
  11. <summary>创建新的上下文对象。</summary>
  12. <param name="context">OWIN 请求上下文</param>
  13. <param name="options">Facebook 中间件选项</param>
  14. <param name="properties">质询的身份验证属性</param>
  15. <param name="redirectUri">初始重定向 URI</param>
  16. </member>
  17. <member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.Properties">
  18. <summary>获取质询的身份验证属性</summary>
  19. </member>
  20. <member name="P:Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext.RedirectUri">
  21. <summary>获取用于重定向操作的 URI。</summary>
  22. </member>
  23. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext">
  24. <summary>包含登录会话及用户 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 的相关信息。</summary>
  25. </member>
  26. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.#ctor(Microsoft.Owin.IOwinContext,Newtonsoft.Json.Linq.JObject,System.String,System.String)">
  27. <summary>初始化 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext" /></summary>
  28. <param name="context">OWIN 环境</param>
  29. <param name="user">JSON 序列化的用户</param>
  30. <param name="accessToken">Facebook 访问令牌</param>
  31. <param name="expires">距过期的秒数</param>
  32. </member>
  33. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.AccessToken">
  34. <summary>获取 Facebook 访问令牌</summary>
  35. </member>
  36. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Email">
  37. <summary>获取 Facebook 电子邮件</summary>
  38. </member>
  39. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.ExpiresIn">
  40. <summary>获取 Facebook 访问令牌过期时间</summary>
  41. </member>
  42. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Id">
  43. <summary>获取 Facebook 用户 ID</summary>
  44. </member>
  45. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Identity">
  46. <summary>获取用于表示用户的 <see cref="T:System.Security.Claims.ClaimsIdentity" /></summary>
  47. </member>
  48. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Link">
  49. <summary>获取或设置指向 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext" /> 的链接。</summary>
  50. <returns>指向 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext" /> 的链接。</returns>
  51. </member>
  52. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Name">
  53. <summary>获取用户的姓名</summary>
  54. </member>
  55. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.Properties">
  56. <summary>获取或设置常见身份验证属性的属性包</summary>
  57. </member>
  58. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.User">
  59. <summary>获取 JSON 序列化的用户</summary>
  60. </member>
  61. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext.UserName">
  62. <summary>获取 Facebook 用户名</summary>
  63. </member>
  64. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware">
  65. <summary>使用 Facebook 对用户进行身份验证的 OWIN 中间件</summary>
  66. </member>
  67. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.#ctor(Microsoft.Owin.OwinMiddleware,Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
  68. <summary>初始化 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware" /></summary>
  69. <param name="next">OWIN 管道中要调用的下一个中间件</param>
  70. <param name="app">OWIN 应用程序</param>
  71. <param name="options">中间件的配置选项</param>
  72. </member>
  73. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware.CreateHandler">
  74. <summary>提供用于处理身份验证相关请求的 <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler" /> 对象。</summary>
  75. <returns>配置了提供给构造函数的 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions" /> 的 <see cref="T:Microsoft.Owin.Security.Infrastructure.AuthenticationHandler" />。</returns>
  76. </member>
  77. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions">
  78. <summary>
  79. <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware" /> 的配置选项</summary>
  80. </member>
  81. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.#ctor">
  82. <summary>初始化新的 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions" /></summary>
  83. </member>
  84. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppId">
  85. <summary>获取或设置 Facebook 分配的 appId</summary>
  86. </member>
  87. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.AppSecret">
  88. <summary>获取或设置 Facebook 分配的应用程序机密</summary>
  89. </member>
  90. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelCertificateValidator">
  91. <summary>获取或设置固定证书验证程序,用于验证在属于 Facebook 的返回通道通信中使用的终结点。</summary>
  92. <returns>固定证书验证程序。</returns>
  93. </member>
  94. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelHttpHandler">
  95. <summary>用于与 Facebook 通信的 HttpMessageHandler。除非值可以向下转换为 WebRequestHandler,否则不能在设置 BackchannelCertificateValidator 的同时设置此项。</summary>
  96. </member>
  97. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.BackchannelTimeout">
  98. <summary>获取或设置与 Facebook 进行的返回通道通信的超时值(以毫秒为单位)。</summary>
  99. <returns>返回通道超时值(以毫秒为单位)。</returns>
  100. </member>
  101. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.CallbackPath">
  102. <summary>应用程序的基路径内将返回用户代理的请求路径。此请求到达时,中间件将处理此请求。默认值为“/signin-facebook”。</summary>
  103. </member>
  104. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Caption">
  105. <summary>获取或设置用户可以在登录用户界面上显示的文本。</summary>
  106. </member>
  107. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Provider">
  108. <summary>获取或设置用于处理身份验证事件的 <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider" />。</summary>
  109. </member>
  110. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.Scope">
  111. <summary>要请求的权限列表。</summary>
  112. </member>
  113. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SendAppSecretProof">
  114. <summary>获取或设置在调用 Facebook API 时是否应生成并发送 appsecret_proof。默认情况下已启用此项。</summary>
  115. </member>
  116. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.SignInAsAuthenticationType">
  117. <summary>获取或设置将负责实际颁发用户 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 的其他身份验证中间件的名称。</summary>
  118. </member>
  119. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions.StateDataFormat">
  120. <summary>获取或设置用于保护由中间件处理的数据的类型。</summary>
  121. </member>
  122. <member name="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider">
  123. <summary>默认 <see cref="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider" /> 实现。</summary>
  124. </member>
  125. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.#ctor">
  126. <summary>初始化 <see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider" /></summary>
  127. </member>
  128. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
  129. <summary>在质询导致重定向到 Facebook 中间件中的授权终结点时调用</summary>
  130. <param name="context">包含质询的重定向 URI 和 <see cref="T:Microsoft.Owin.Security.AuthenticationProperties" /></param>
  131. </member>
  132. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
  133. <summary>每当 Facebook 成功对用户进行身份验证时调用</summary>
  134. <returns>表示已完成的操作的 <see cref="T:System.Threading.Tasks.Task" />。</returns>
  135. <param name="context">包含登录会话及用户 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 的相关信息。</param>
  136. </member>
  137. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnApplyRedirect">
  138. <summary>获取或设置调用 ApplyRedirect 方法时调用的委托。</summary>
  139. </member>
  140. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnAuthenticated">
  141. <summary>获取或设置调用 Authenticated 方法时调用的函数。</summary>
  142. </member>
  143. <member name="P:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.OnReturnEndpoint">
  144. <summary>获取或设置调用 ReturnEndpoint 方法时调用的函数。</summary>
  145. </member>
  146. <member name="M:Microsoft.Owin.Security.Facebook.FacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
  147. <summary>在 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 保存到本地 Cookie 中且浏览器重定向到最初请求的 URL 之前调用。</summary>
  148. <returns>表示已完成的操作的 <see cref="T:System.Threading.Tasks.Task" />。</returns>
  149. </member>
  150. <member name="T:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext">
  151. <summary>向中间件提供程序提供上下文信息。</summary>
  152. </member>
  153. <member name="M:Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext.#ctor(Microsoft.Owin.IOwinContext,Microsoft.Owin.Security.AuthenticationTicket)">
  154. <param name="context">OWIN 环境</param>
  155. <param name="ticket">身份验证票证</param>
  156. </member>
  157. <member name="T:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider">
  158. <summary>指定回调方法,<see cref="T:Microsoft.Owin.Security.Facebook.FacebookAuthenticationMiddleware" /> 调用这些方法使开发人员可以控制身份验证过程。/&amp;amp;gt;</summary>
  159. </member>
  160. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ApplyRedirect(Microsoft.Owin.Security.Facebook.FacebookApplyRedirectContext)">
  161. <summary>在质询导致重定向到 Facebook 中间件中的授权终结点时调用</summary>
  162. <param name="context">包含质询的重定向 URI 和 <see cref="T:Microsoft.Owin.Security.AuthenticationProperties" /></param>
  163. </member>
  164. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.Authenticated(Microsoft.Owin.Security.Facebook.FacebookAuthenticatedContext)">
  165. <summary>每当 Facebook 成功对用户进行身份验证时调用</summary>
  166. <returns>表示已完成的操作的 <see cref="T:System.Threading.Tasks.Task" />。</returns>
  167. <param name="context">包含登录会话及用户 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 的相关信息。</param>
  168. </member>
  169. <member name="M:Microsoft.Owin.Security.Facebook.IFacebookAuthenticationProvider.ReturnEndpoint(Microsoft.Owin.Security.Facebook.FacebookReturnEndpointContext)">
  170. <summary>在 <see cref="T:System.Security.Claims.ClaimsIdentity" /> 保存到本地 Cookie 中且浏览器重定向到最初请求的 URL 之前调用。</summary>
  171. <returns>表示已完成的操作的 <see cref="T:System.Threading.Tasks.Task" />。</returns>
  172. </member>
  173. <member name="T:Owin.FacebookAuthenticationExtensions">
  174. <summary>提供 Facebook 身份验证的扩展方法。</summary>
  175. </member>
  176. <member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,Microsoft.Owin.Security.Facebook.FacebookAuthenticationOptions)">
  177. <summary>生成 OWIN 应用程序的 Facebook 身份验证。</summary>
  178. <returns>生成身份验证的 <see cref="T:Owin.IAppBuilder" />。</returns>
  179. <param name="app">应用程序生成器。</param>
  180. <param name="options">Facebook 身份验证选项。</param>
  181. </member>
  182. <member name="M:Owin.FacebookAuthenticationExtensions.UseFacebookAuthentication(Owin.IAppBuilder,System.String,System.String)">
  183. <summary>生成 OWIN 应用程序的 Facebook 身份验证。</summary>
  184. <returns>生成身份验证的 <see cref="T:Owin.IAppBuilder" />。</returns>
  185. <param name="app">应用程序生成器。</param>
  186. <param name="appId">应用程序 ID。</param>
  187. <param name="appSecret">应用程序密码。</param>
  188. </member>
  189. </members>
  190. </doc>