Microsoft.Web.WebPages.OAuth.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Web.WebPages.OAuth</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Web.WebPages.OAuth.AuthenticationClientData">
  8. <summary>表示身份验证客户端数据。</summary>
  9. </member>
  10. <member name="M:Microsoft.Web.WebPages.OAuth.AuthenticationClientData.#ctor(DotNetOpenAuth.AspNet.IAuthenticationClient,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  11. <summary>初始化 <see cref="T:Microsoft.Web.WebPages.OAuth.AuthenticationClientData" /> 类的新实例。</summary>
  12. <param name="authenticationClient">身份验证客户端。</param>
  13. <param name="displayName">数据的显示名称。</param>
  14. <param name="extraData">其他数据。</param>
  15. </member>
  16. <member name="P:Microsoft.Web.WebPages.OAuth.AuthenticationClientData.AuthenticationClient">
  17. <summary>获取身份验证客户端。</summary>
  18. <returns>身份验证客户端。</returns>
  19. </member>
  20. <member name="P:Microsoft.Web.WebPages.OAuth.AuthenticationClientData.DisplayName">
  21. <summary>获取或设置数据的显示名称。</summary>
  22. <returns>数据的显示名称。</returns>
  23. </member>
  24. <member name="P:Microsoft.Web.WebPages.OAuth.AuthenticationClientData.ExtraData">
  25. <summary>获取对象的其他数据。</summary>
  26. <returns>对象的其他数据。</returns>
  27. </member>
  28. <member name="T:Microsoft.Web.WebPages.OAuth.OAuthAccount">
  29. <summary>表示 OAuth 或 OpenID 帐户。</summary>
  30. </member>
  31. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthAccount.#ctor(System.String,System.String)">
  32. <summary>初始化 <see cref="T:Microsoft.Web.WebPages.OAuth.OAuthAccount" /> 类的新实例。</summary>
  33. <param name="provider">提供程序的名称。</param>
  34. <param name="providerUserId">提供程序用户 ID。</param>
  35. </member>
  36. <member name="P:Microsoft.Web.WebPages.OAuth.OAuthAccount.Provider">
  37. <summary>获取提供程序名称。</summary>
  38. <returns>提供程序名称。</returns>
  39. </member>
  40. <member name="P:Microsoft.Web.WebPages.OAuth.OAuthAccount.ProviderUserId">
  41. <summary>获取提供程序用户 ID。</summary>
  42. <returns>提供程序用户 ID。</returns>
  43. </member>
  44. <member name="T:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity">
  45. <summary>管理使用 OAuth 身份验证提供程序(如 Facebook、Twitter、LinkedIn、Windows Live)和 OpenID 身份验证提供程序(如 Google 和 Yahoo)的安全性。</summary>
  46. </member>
  47. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.CreateOrUpdateAccount(System.String,System.String,System.String)">
  48. <summary>使用指定的提供程序和提供程序 ID 所对应的用户 ID 创建或更新帐户,并将新帐户与指定的用户名关联起来。</summary>
  49. <param name="providerName">提供程序名称。</param>
  50. <param name="providerUserId">指定的提供程序的用户 ID。</param>
  51. <param name="userName">用户的名称。</param>
  52. </member>
  53. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.DeleteAccount(System.String,System.String)">
  54. <summary>删除指定的成员资格帐户。</summary>
  55. <returns>如果删除了帐户,则为 true;如果未删除,则为 false。</returns>
  56. <param name="providerName">提供程序名称。</param>
  57. <param name="providerUserId">指定的提供程序的用户 ID。</param>
  58. </member>
  59. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.GetAccountsFromUserName(System.String)">
  60. <summary>获取使用指定的用户名进行关联的帐户。</summary>
  61. <returns>帐户的集合。</returns>
  62. <param name="userName">用户名。</param>
  63. </member>
  64. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.GetOAuthClientData(System.String)">
  65. <summary>返回使用指定提供程序的 OAuth 身份验证客户端数据。</summary>
  66. <returns>OAuth 身份验证客户端数据。</returns>
  67. <param name="providerName">提供程序名称。</param>
  68. </member>
  69. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.GetUserName(System.String,System.String)">
  70. <summary>返回指定 OAuth 或 OpenID 提供程序的用户 ID 和提供程序用户 ID。</summary>
  71. <returns>用户 ID;或者如果没有与 OAuth 或 OpenID 提供程序用户 ID 关联的用户 ID,则为 null。</returns>
  72. <param name="providerName">提供程序名称。</param>
  73. <param name="providerUserId">指定的提供程序的用户 ID。</param>
  74. </member>
  75. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.HasLocalAccount(System.Int32)">
  76. <summary>指示用户是否具有本地帐户。</summary>
  77. <returns>如果用户具有本地帐户,则为 true;否则为 false。</returns>
  78. <param name="userId">用户 ID。</param>
  79. </member>
  80. <member name="P:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.IsAuthenticatedWithOAuth">
  81. <summary>获取一个值,该值指示是否已使用 OAuth 对用户进行身份验证。</summary>
  82. <returns>如果已使用 OAuth 对用户进行身份验证,则为 true;否则为 false。</returns>
  83. </member>
  84. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.Login(System.String,System.String,System.Boolean)">
  85. <summary>登录用户。</summary>
  86. <returns>如果登录成功,则为 true;否则为 false。</returns>
  87. <param name="providerName">提供程序名称。</param>
  88. <param name="providerUserId">指定的提供程序的用户 ID。</param>
  89. <param name="createPersistentCookie">若要创建持久 Cookie,使登录信息可以跨浏览器会话保存,则为 true;否则为 false。</param>
  90. </member>
  91. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterClient(DotNetOpenAuth.AspNet.IAuthenticationClient)">
  92. <summary>注册 OAuth 身份验证客户端。</summary>
  93. <param name="client">受支持的 OAuth 客户端之一。</param>
  94. </member>
  95. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterClient(DotNetOpenAuth.AspNet.IAuthenticationClient,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  96. <summary>注册 OAuth 身份验证客户端。</summary>
  97. <param name="client">受支持的 OAuth 客户端之一。</param>
  98. <param name="displayName">显示名称。</param>
  99. <param name="extraData">额外数据。</param>
  100. </member>
  101. <member name="P:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisteredClientData">
  102. <summary>获取已注册的客户端数据的集合。</summary>
  103. <returns>已注册的客户端数据的集合。</returns>
  104. </member>
  105. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterFacebookClient(System.String,System.String)">
  106. <summary>使用指定的标识符注册 Facebook 客户端。</summary>
  107. <param name="appId">应用程序 ID。</param>
  108. <param name="appSecret">应用程序密码。</param>
  109. </member>
  110. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterFacebookClient(System.String,System.String,System.String)">
  111. <summary>使用指定的标识符注册 Facebook 客户端。</summary>
  112. <param name="appId">应用程序标识符。</param>
  113. <param name="appSecret">应用程序密码。</param>
  114. <param name="displayName">显示名称。</param>
  115. </member>
  116. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterFacebookClient(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  117. <summary>使用指定的标识符注册 Facebook 客户端。</summary>
  118. <param name="appId">应用程序标识符。</param>
  119. <param name="appSecret">应用程序密码。</param>
  120. <param name="displayName">显示名称。</param>
  121. <param name="extraData">额外数据。</param>
  122. </member>
  123. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterGoogleClient">
  124. <summary>注册 Google 客户端。</summary>
  125. </member>
  126. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterGoogleClient(System.String)">
  127. <summary>注册 Google 客户端。</summary>
  128. <param name="displayName">显示名称。</param>
  129. </member>
  130. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterGoogleClient(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  131. <summary>注册 Google 客户端。</summary>
  132. <param name="displayName">显示名称。</param>
  133. <param name="extraData">额外数据。</param>
  134. </member>
  135. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterLinkedInClient(System.String,System.String)">
  136. <summary>使用指定的使用者密钥注册 LinkedIn 客户端。</summary>
  137. <param name="consumerKey">使用者密钥。</param>
  138. <param name="consumerSecret">使用者机密。</param>
  139. </member>
  140. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterLinkedInClient(System.String,System.String,System.String)">
  141. <summary>使用指定的使用者密钥注册 LinkedIn 客户端。</summary>
  142. <param name="consumerKey">使用者密钥。</param>
  143. <param name="consumerSecret">使用者机密。</param>
  144. <param name="displayName">显示名称。</param>
  145. </member>
  146. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterLinkedInClient(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  147. <summary>使用指定的使用者密钥注册 LinkedIn 客户端。</summary>
  148. <param name="consumerKey">使用者密钥。</param>
  149. <param name="consumerSecret">使用者机密。</param>
  150. <param name="displayName">显示名称。</param>
  151. <param name="extraData">额外数据。</param>
  152. </member>
  153. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterMicrosoftClient(System.String,System.String)">
  154. <summary>使用指定的标识符注册 Microsoft 客户端。</summary>
  155. <param name="clientId">客户端 ID。</param>
  156. <param name="clientSecret">客户端机密。</param>
  157. </member>
  158. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterMicrosoftClient(System.String,System.String,System.String)">
  159. <summary>使用指定的标识符注册 Microsoft 客户端。</summary>
  160. <param name="clientId">客户端 ID。</param>
  161. <param name="clientSecret">客户端机密。</param>
  162. <param name="displayName">显示名称。</param>
  163. </member>
  164. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterMicrosoftClient(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  165. <summary>使用指定的标识符注册 Microsoft 客户端。</summary>
  166. <param name="clientId">客户端 ID。</param>
  167. <param name="clientSecret">客户端机密。</param>
  168. <param name="displayName">显示名称。</param>
  169. <param name="extraData">额外数据。</param>
  170. </member>
  171. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterTwitterClient(System.String,System.String)">
  172. <summary>使用指定的使用者密钥注册 Twitter 客户端。</summary>
  173. <param name="consumerKey">使用者密钥。</param>
  174. <param name="consumerSecret">使用者机密。</param>
  175. </member>
  176. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterTwitterClient(System.String,System.String,System.String)">
  177. <summary>使用指定的使用者密钥注册 Twitter 客户端。</summary>
  178. <param name="consumerKey">使用者密钥。</param>
  179. <param name="consumerSecret">使用者机密。</param>
  180. <param name="displayName">显示名称。</param>
  181. </member>
  182. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterTwitterClient(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  183. <summary>使用指定的使用者密钥注册 Twitter 客户端。</summary>
  184. <param name="consumerKey">使用者密钥。</param>
  185. <param name="consumerSecret">使用者机密。</param>
  186. <param name="displayName">显示名称。</param>
  187. <param name="extraData">额外数据。</param>
  188. </member>
  189. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterYahooClient">
  190. <summary>注册 Yahoo 客户端。</summary>
  191. </member>
  192. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterYahooClient(System.String)">
  193. <summary>注册 Yahoo 客户端。</summary>
  194. <param name="displayName">显示名称。</param>
  195. </member>
  196. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RegisterYahooClient(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  197. <summary>注册 Yahoo 客户端。</summary>
  198. <param name="displayName">显示名称。</param>
  199. <param name="extraData">额外数据。</param>
  200. </member>
  201. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RequestAuthentication(System.String)">
  202. <summary>通过将用户引导至外部网站,请求指定的提供程序启动身份验证。</summary>
  203. <param name="provider">OAuth 提供程序。</param>
  204. </member>
  205. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.RequestAuthentication(System.String,System.String)">
  206. <summary>通过将用户引导至外部网站,请求指定的提供程序启动身份验证,然后在身份验证成功时,指示提供程序将用户重定向到指定的 URL。</summary>
  207. <param name="provider">OAuth 提供程序。</param>
  208. <param name="returnUrl">身份验证成功时要返回到的 URL。</param>
  209. </member>
  210. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.SerializeProviderUserId(System.String,System.String)">
  211. <summary>序列化提供程序的用户 ID。</summary>
  212. <returns>提供程序的序列化用户 ID。</returns>
  213. <param name="providerName">提供程序的名称。</param>
  214. <param name="providerUserId">提供程序的用户 ID。</param>
  215. </member>
  216. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.TryDeserializeProviderUserId(System.String,System.String@,System.String@)">
  217. <summary>指示提供程序的用户 ID 是否已反序列化。</summary>
  218. <returns>如果提供程序的用户 ID 已反序列化,则为 true;否则为 false。</returns>
  219. <param name="data">数据。</param>
  220. <param name="providerName">提供程序名称。</param>
  221. <param name="providerUserId">提供程序用户 ID。</param>
  222. </member>
  223. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.TryGetOAuthClientData(System.String,Microsoft.Web.WebPages.OAuth.AuthenticationClientData@)">
  224. <summary>指示提供程序是否获取 OAuth 客户端数据。</summary>
  225. <returns>如果提供程序获取 OAuth 客户端数据,则为 true;否则为 false。</returns>
  226. <param name="providerName">提供程序名称。</param>
  227. <param name="clientData">客户端数据。</param>
  228. </member>
  229. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.VerifyAuthentication">
  230. <summary>返回指示用户帐户是否已由提供程序确认的值。</summary>
  231. <returns>一个 <see cref="T:DotNetOpenAuth.AspNet.AuthenticationResult" /> 实例,你可以查询该实例以确定验证是否成功。</returns>
  232. </member>
  233. <member name="M:Microsoft.Web.WebPages.OAuth.OAuthWebSecurity.VerifyAuthentication(System.String)">
  234. <summary>返回指示用户帐户是否已由提供程序确认的值。</summary>
  235. <returns>一个 <see cref="T:DotNetOpenAuth.AspNet.AuthenticationResult" /> 实例,你可以查询该实例以确定验证是否成功。</returns>
  236. <param name="returnUrl">返回 Url。</param>
  237. </member>
  238. <member name="T:Microsoft.Web.WebPages.OAuth.PreApplicationStartCode">
  239. <summary>为基于 OAuth 的安全应用程序预启动代码提供注册点。</summary>
  240. </member>
  241. <member name="M:Microsoft.Web.WebPages.OAuth.PreApplicationStartCode.Start">
  242. <summary>注册 OAuth 应用程序预启动代码。</summary>
  243. </member>
  244. </members>
  245. </doc>