PageRenderTime 50ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/SmartDatabaseWebApplication/packages/Microsoft.AspNet.WebPages.WebData.3.2.4/lib/net45/WebMatrix.WebData.xml

https://bitbucket.org/metunccsmartdatabaseteam/smartdatabasewebapplication-rest
XML | 851 lines | 851 code | 0 blank | 0 comment | 0 complexity | 2500a3939bd61c4b8adb321efe722a4e MD5 | raw file

Large files files are truncated, but you can click here to view the full file

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>WebMatrix.WebData</name>
  5. </assembly>
  6. <members>
  7. <member name="T:WebMatrix.WebData.ExtendedMembershipProvider">
  8. <summary>Represents an abstract class that is used to extend the membership system that is provided by the <see cref="T:System.Web.Security.MembershipProvider" /> class.</summary>
  9. </member>
  10. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.#ctor">
  11. <summary>When overridden in a derived class, instantiates a new instance of the <see cref="T:WebMatrix.WebData.ExtendedMembershipProvider" /> class.</summary>
  12. </member>
  13. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.ConfirmAccount(System.String)">
  14. <summary>Activates a pending membership account.</summary>
  15. <returns>true if the account is confirmed; otherwise, false.</returns>
  16. <param name="accountConfirmationToken">A confirmation token to pass to the authentication provider.</param>
  17. </member>
  18. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.ConfirmAccount(System.String,System.String)">
  19. <summary>Activates a pending membership account for the specified user.</summary>
  20. <returns>true if the account is confirmed; otherwise, false.</returns>
  21. <param name="userName">The user name.</param>
  22. <param name="accountConfirmationToken">A confirmation token to pass to the authentication provider.</param>
  23. </member>
  24. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateAccount(System.String,System.String)">
  25. <summary>Creates a new user account using the specified user name and password.</summary>
  26. <returns>A token that can be sent to the user to confirm the account.</returns>
  27. <param name="userName">The user name.</param>
  28. <param name="password">The password.</param>
  29. </member>
  30. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateAccount(System.String,System.String,System.Boolean)">
  31. <summary>When overridden in a derived class, creates a new user account using the specified user name and password, optionally requiring that the new account must be confirmed before the account is available for use.</summary>
  32. <returns>A token that can be sent to the user to confirm the account.</returns>
  33. <param name="userName">The user name.</param>
  34. <param name="password">The password.</param>
  35. <param name="requireConfirmationToken">(Optional) true to specify that the account must be confirmed; otherwise, false. The default is false.</param>
  36. </member>
  37. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateOrUpdateOAuthAccount(System.String,System.String,System.String)">
  38. <summary>When overridden in a derived class, creates a new OAuth membership account, or updates an existing OAuth Membership account.</summary>
  39. <param name="provider">The OAuth or OpenID provider.</param>
  40. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  41. <param name="userName">The user name.</param>
  42. </member>
  43. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateUserAndAccount(System.String,System.String)">
  44. <summary>Creates a new user profile and a new membership account.</summary>
  45. <returns>A token that can be sent to the user to confirm the user account.</returns>
  46. <param name="userName">The user name.</param>
  47. <param name="password">The password.</param>
  48. </member>
  49. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateUserAndAccount(System.String,System.String,System.Boolean)">
  50. <summary>Creates a new user profile and a new membership account.</summary>
  51. <returns>A token that can be sent to the user to confirm the user account.</returns>
  52. <param name="userName">The user name.</param>
  53. <param name="password">The password.</param>
  54. <param name="requireConfirmation">(Optional) true to specify that the user account must be confirmed; otherwise, false. The default is false.</param>
  55. </member>
  56. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateUserAndAccount(System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  57. <summary>When overridden in a derived class, creates a new user profile and a new membership account.</summary>
  58. <returns>A token that can be sent to the user to confirm the user account.</returns>
  59. <param name="userName">The user name.</param>
  60. <param name="password">The password.</param>
  61. <param name="requireConfirmation">(Optional) true to specify that the user account must be confirmed; otherwise, false. The default is false.</param>
  62. <param name="values">(Optional) A dictionary that contains additional user attributes to store in the user profile. The default is null.</param>
  63. </member>
  64. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.CreateUserAndAccount(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  65. <summary>When overridden in a derived class, creates a new user profile and a new membership account.</summary>
  66. <returns>A token that can be sent to the user to confirm the user account.</returns>
  67. <param name="userName">The user name.</param>
  68. <param name="password">The password.</param>
  69. <param name="values">(Optional) A dictionary that contains additional user attributes to store in the user profile. The default is null.</param>
  70. </member>
  71. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.DeleteAccount(System.String)">
  72. <summary>When overridden in a derived class, deletes the specified membership account.</summary>
  73. <returns>true if the user account was deleted; otherwise, false.</returns>
  74. <param name="userName">The user name.</param>
  75. </member>
  76. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.DeleteOAuthAccount(System.String,System.String)">
  77. <summary>When overridden in a derived class, deletes the OAuth or OpenID account with the specified provider name and provider user ID.</summary>
  78. <param name="provider">The name of the OAuth or OpenID provider.</param>
  79. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  80. </member>
  81. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.DeleteOAuthToken(System.String)">
  82. <summary>Deletes the specified OAuth token.</summary>
  83. <param name="token">The token to delete.</param>
  84. </member>
  85. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GeneratePasswordResetToken(System.String)">
  86. <summary>Generates a password reset token that can be sent to a user in email.</summary>
  87. <returns>A token to send to the user.</returns>
  88. <param name="userName">The user name.</param>
  89. </member>
  90. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GeneratePasswordResetToken(System.String,System.Int32)">
  91. <summary>When overridden in a derived class, generates a password reset token that can be sent to a user in email.</summary>
  92. <returns>A token to send to the user.</returns>
  93. <param name="userName">The user name.</param>
  94. <param name="tokenExpirationInMinutesFromNow">(Optional) The time, in minutes, until the password reset token expires. The default is 1440 (24 hours).</param>
  95. </member>
  96. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetAccountsForUser(System.String)">
  97. <summary>When overridden in a derived class, returns all OAuth membership accounts associated with the specified user name.</summary>
  98. <returns>A list of all OAuth membership accounts associated with the specified user name.</returns>
  99. <param name="userName">The user name.</param>
  100. </member>
  101. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetCreateDate(System.String)">
  102. <summary>When overridden in a derived class, returns the date and time when the specified user account was created.</summary>
  103. <returns>The date and time the account was created, or <see cref="F:System.DateTime.MinValue" /> if the account creation date is not available.</returns>
  104. <param name="userName">The user name of the account.</param>
  105. </member>
  106. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetLastPasswordFailureDate(System.String)">
  107. <summary>When overridden in a derived class, returns the date and time when an incorrect password was most recently entered for the specified user account.</summary>
  108. <returns>The date and time when an incorrect password was most recently entered for this user account, or <see cref="F:System.DateTime.MinValue" /> if an incorrect password has not been entered for this user account.</returns>
  109. <param name="userName">The user name of the account.</param>
  110. </member>
  111. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetOAuthTokenSecret(System.String)">
  112. <summary>Gets the OAuth token secret.</summary>
  113. <returns>The OAuth token.</returns>
  114. <param name="token">The OAuth token.</param>
  115. </member>
  116. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetPasswordChangedDate(System.String)">
  117. <summary>When overridden in a derived class, returns the date and time when the password was most recently changed for the specified membership account.</summary>
  118. <returns>The date and time when the password was more recently changed for membership account, or <see cref="F:System.DateTime.MinValue" /> if the password has never been changed for this user account.</returns>
  119. <param name="userName">The user name of the account.</param>
  120. </member>
  121. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetPasswordFailuresSinceLastSuccess(System.String)">
  122. <summary>When overridden in a derived class, returns the number of times that the password for the specified user account was incorrectly entered since the most recent successful login or since the user account was created.</summary>
  123. <returns>The count of failed password attempts for the specified user account.</returns>
  124. <param name="userName">The user name of the account.</param>
  125. </member>
  126. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetUserIdFromOAuth(System.String,System.String)">
  127. <summary>When overridden in a derived class, returns the user ID for the specified OAuth or OpenID provider and provider user ID.</summary>
  128. <param name="provider">The name of the OAuth or OpenID provider.</param>
  129. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  130. </member>
  131. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetUserIdFromPasswordResetToken(System.String)">
  132. <summary>When overridden in a derived class, returns an ID for a user based on a password reset token.</summary>
  133. <returns>The user ID.</returns>
  134. <param name="token">The password reset token.</param>
  135. </member>
  136. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.GetUserNameFromId(System.Int32)">
  137. <summary>Returns the user name that is associated with the specified user ID.</summary>
  138. <returns>The user name.</returns>
  139. <param name="userId">The user ID to get the name for.</param>
  140. </member>
  141. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.HasLocalAccount(System.Int32)">
  142. <summary>Indicates whether the user has a local account.</summary>
  143. <returns>true if the membership has a local account; otherwise, false.</returns>
  144. <param name="userId">The user ID.</param>
  145. </member>
  146. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.IsConfirmed(System.String)">
  147. <summary>When overridden in a derived class, returns a value that indicates whether the user account has been confirmed by the provider.</summary>
  148. <returns>true if the user is confirmed; otherwise, false.</returns>
  149. <param name="userName">The user name.</param>
  150. </member>
  151. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.ReplaceOAuthRequestTokenWithAccessToken(System.String,System.String,System.String)">
  152. <summary>Replaces the OAuth request token with access token.</summary>
  153. <param name="requestToken">The request token.</param>
  154. <param name="accessToken">The access token.</param>
  155. <param name="accessTokenSecret">The access token secret.</param>
  156. </member>
  157. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.ResetPasswordWithToken(System.String,System.String)">
  158. <summary>When overridden in a derived class, resets a password after verifying that the specified password reset token is valid.</summary>
  159. <returns>true if the password was changed; otherwise, false.</returns>
  160. <param name="token">A password reset token.</param>
  161. <param name="newPassword">The new password.</param>
  162. </member>
  163. <member name="M:WebMatrix.WebData.ExtendedMembershipProvider.StoreOAuthRequestToken(System.String,System.String)">
  164. <summary>Stores the OAuth request token.</summary>
  165. <param name="requestToken">The request token.</param>
  166. <param name="requestTokenSecret">The request token secret.</param>
  167. </member>
  168. <member name="T:WebMatrix.WebData.FormsAuthenticationSettings">
  169. <summary>Defines key names that override default settings in the &lt;appSettings&gt; section of the Web.config file.</summary>
  170. </member>
  171. <member name="F:WebMatrix.WebData.FormsAuthenticationSettings.DefaultLoginUrl">
  172. <summary>The key to access the default login URL.</summary>
  173. </member>
  174. <member name="F:WebMatrix.WebData.FormsAuthenticationSettings.LoginUrlKey">
  175. <summary>The key to access the login URL key.</summary>
  176. </member>
  177. <member name="F:WebMatrix.WebData.FormsAuthenticationSettings.PreserveLoginUrlKey">
  178. <summary>The key to access the setting that preserves the term "login" instead of overriding it with "logon".</summary>
  179. </member>
  180. <member name="T:WebMatrix.WebData.OAuthAccountData">
  181. <summary>Represents an OAuth or OpenID account.</summary>
  182. </member>
  183. <member name="M:WebMatrix.WebData.OAuthAccountData.#ctor(System.String,System.String)">
  184. <summary>Initializes a new instance of the <see cref="T:WebMatrix.WebData.OAuthAccountData" /> class by using the specified OAuth or Open ID provider and provider user ID.</summary>
  185. <param name="provider">The provider.</param>
  186. <param name="providerUserId">The provider user id.</param>
  187. </member>
  188. <member name="P:WebMatrix.WebData.OAuthAccountData.Provider">
  189. <summary>Gets the OAuth or Open ID provider name.</summary>
  190. <returns>The provider name.</returns>
  191. </member>
  192. <member name="P:WebMatrix.WebData.OAuthAccountData.ProviderUserId">
  193. <summary>Gets the OAuth or Open ID provider user ID.</summary>
  194. <returns>The provider user ID.</returns>
  195. </member>
  196. <member name="T:WebMatrix.WebData.PreApplicationStartCode">
  197. <summary>Provides a registration point for the simple membership pre-application start code.</summary>
  198. </member>
  199. <member name="M:WebMatrix.WebData.PreApplicationStartCode.Start">
  200. <summary>Registers the simple membership pre-application start code.</summary>
  201. </member>
  202. <member name="T:WebMatrix.WebData.SimpleMembershipProvider">
  203. <summary>Provides support for website membership tasks, such as creating accounts, deleting accounts, and managing passwords.</summary>
  204. </member>
  205. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.#ctor">
  206. <summary>Initializes a new instance of the <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class.</summary>
  207. </member>
  208. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.#ctor(System.Web.Security.MembershipProvider)">
  209. <summary>Initializes a new instance of the <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class by using the specified membership provider.</summary>
  210. <param name="previousProvider">The membership provider to use.</param>
  211. </member>
  212. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.ApplicationName">
  213. <summary>Gets or sets the name of the application.</summary>
  214. <returns>The name of the application.</returns>
  215. </member>
  216. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.CasingBehavior">
  217. <summary>Gets or sets the <see cref="T:WebMatrix.WebData.SimpleMembershipProviderCasingBehavior" /> for this provider.</summary>
  218. </member>
  219. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ChangePassword(System.String,System.String,System.String)">
  220. <summary>Changes the password for the specified membership account.</summary>
  221. <returns>true if the password is successfully changed; otherwise, false.</returns>
  222. <param name="username">The user name.</param>
  223. <param name="oldPassword">The old password.</param>
  224. <param name="newPassword">The new password.</param>
  225. </member>
  226. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ChangePasswordQuestionAndAnswer(System.String,System.String,System.String,System.String)">
  227. <summary>Changes the password question and answer for the specified account.</summary>
  228. <returns>true if the password question and answer are successfully changed; otherwise, false.</returns>
  229. <param name="username">The user name.</param>
  230. <param name="password">The new password.</param>
  231. <param name="newPasswordQuestion">The security question that the user must answer in order to change the password.</param>
  232. <param name="newPasswordAnswer">The answer to the security question.</param>
  233. </member>
  234. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ConfirmAccount(System.String)">
  235. <summary>Activates a pending membership account.</summary>
  236. <returns>true if the user account is confirmed; otherwise, false.</returns>
  237. <param name="accountConfirmationToken">A confirmation token to pass to the authentication provider.</param>
  238. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  239. </member>
  240. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ConfirmAccount(System.String,System.String)">
  241. <summary>Indicates whether the user account is confirmed.</summary>
  242. <returns>true if the user account is confirmed; otherwise, false.</returns>
  243. <param name="userName">The username.</param>
  244. <param name="accountConfirmationToken">The account confirmation.</param>
  245. </member>
  246. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.CreateAccount(System.String,System.String,System.Boolean)">
  247. <summary>Creates a new user account by using the specified user name and password.</summary>
  248. <returns>A token that can be sent to the user to confirm the user account.</returns>
  249. <param name="userName">The user name.</param>
  250. <param name="password">The password.</param>
  251. <param name="requireConfirmationToken">(Optional) true to specify that the user account must be confirmed; otherwise, false. The default is false.</param>
  252. <exception cref="T:System.Web.Security.MembershipCreateUserException">
  253. <paramref name="username" /> is empty.-or-<paramref name="username" /> already has a user account.-or-<paramref name="password" /> is empty.-or-<paramref name="password" /> is longer than 128 characters.-or-A user record that corresponds to <paramref name="username" /> does not exist in the <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.UserTableName" /> table (the user profile table).-or-The database operation failed.</exception>
  254. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  255. </member>
  256. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.CreateOrUpdateOAuthAccount(System.String,System.String,System.String)">
  257. <summary>Creates a new OAuth membership account, or updates an existing OAuth Membership account.</summary>
  258. <param name="provider">The OAuth or OpenID provider.</param>
  259. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  260. <param name="userName">The user name.</param>
  261. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  262. <exception cref="T:System.Web.Security.MembershipCreateUserException">
  263. <paramref name="username" /> is empty.-or-A user record that corresponds to <paramref name="username" /> does not exist in the <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.UserTableName" /> table (the user profile table).-or-The database operation failed.</exception>
  264. </member>
  265. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.CreateUser(System.String,System.String,System.String,System.String,System.String,System.Boolean,System.Object,System.Web.Security.MembershipCreateStatus@)">
  266. <summary>Adds the specified user to the membership database.</summary>
  267. <returns>A <see cref="T:System.Web.Security.MembershipUser" /> object that is populated with the information for the newly created user account.</returns>
  268. <param name="username">The user name for the new user account.</param>
  269. <param name="password">The password for the new user account.</param>
  270. <param name="email">The email address for the new user account.</param>
  271. <param name="passwordQuestion">The security question for the new user account.</param>
  272. <param name="passwordAnswer">The answer to the security question for the new user account.</param>
  273. <param name="isApproved">true to indicate that the user account is approved to be validated; otherwise, false.</param>
  274. <param name="providerUserKey">The unique identifier from the membership data source for the user account.</param>
  275. <param name="status">When this method returns, contains a <see cref="T:System.Web.Security.MembershipCreateStatus" /> enumeration value that indicates whether the user account was created successfully. This parameter is passed uninitiated.</param>
  276. </member>
  277. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.CreateUserAndAccount(System.String,System.String,System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Object})">
  278. <summary>Creates a new user profile and a new membership account.</summary>
  279. <returns>A token that can be sent to the user to confirm the user account.</returns>
  280. <param name="userName">The user name.</param>
  281. <param name="password">The password.</param>
  282. <param name="requireConfirmation">(Optional) true to specify that the user account must be confirmed by using the <see cref="M:WebMatrix.WebData.SimpleMembershipProvider.ConfirmAccount(System.String)" /> method; otherwise, false. The default is false. </param>
  283. <param name="values">(Optional) A dictionary that contains additional key/value pair attributes that you can add to the data store as default values for new user profile. The key for each entry is the database column, and the value of each entry is the value for the column. The default is null.</param>
  284. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  285. <exception cref="T:System.Web.Security.MembershipCreateUserException">A membership account for this user name already exists in the membership database.</exception>
  286. </member>
  287. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.DeleteAccount(System.String)">
  288. <summary>Deletes the specified membership account.</summary>
  289. <returns>true if the user account was deleted; otherwise, false.</returns>
  290. <param name="userName">The user name.</param>
  291. <exception cref="T:System.ArgumentException">
  292. <paramref name="username" /> is null or empty.</exception>
  293. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  294. </member>
  295. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.DeleteOAuthAccount(System.String,System.String)">
  296. <summary>Deletes the OAuth or OpenID account with the specified provider name and provider user ID.</summary>
  297. <param name="provider">The name of the OAuth or OpenID provider.</param>
  298. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  299. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  300. <exception cref="T:System.Web.Security.MembershipCreateUserException">
  301. <paramref name="username" /> is empty.-or-A user record that corresponds to <paramref name="username" /> does not exist in the <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.UserTableName" /> table (the user profile table).-or-The database operation failed.</exception>
  302. </member>
  303. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.DeleteOAuthToken(System.String)">
  304. <summary>Deletes the specified OAuth token.</summary>
  305. <param name="token">The token to delete.</param>
  306. </member>
  307. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.DeleteUser(System.String,System.Boolean)">
  308. <summary>Deletes the specified user account, and optionally deletes all profile data that is related to that user account.</summary>
  309. <returns>true if the user account was deleted; otherwise, false.</returns>
  310. <param name="username">The user name.</param>
  311. <param name="deleteAllRelatedData">true to delete profile data that is related to the user, or false to retain data that is related to the user.</param>
  312. <exception cref="T:System.ArgumentException">
  313. <paramref name="username" /> is null or empty.</exception>
  314. </member>
  315. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.EnablePasswordReset">
  316. <summary>Gets a value that indicates whether the membership provider lets users reset their passwords.</summary>
  317. <returns>true if the membership provider supports password reset; otherwise, false. The default is true.</returns>
  318. </member>
  319. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.EnablePasswordRetrieval">
  320. <summary>Gets a value that indicates whether the membership provider lets users retrieve their passwords.</summary>
  321. <returns>true if the membership provider supports password retrieval; otherwise, false. The default is false.</returns>
  322. </member>
  323. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.FindUsersByEmail(System.String,System.Int32,System.Int32,System.Int32@)">
  324. <summary>Returns all of the user accounts whose email address matches the specified email address.</summary>
  325. <returns>A collection that contains a page of <paramref name="pageSize" /> user accounts starting at the page specified by <paramref name="pageIndex" />.</returns>
  326. <param name="emailToMatch">The email address to search for.</param>
  327. <param name="pageIndex">The zero-based index of the page of results to return.</param>
  328. <param name="pageSize">The size of the page of results to return.</param>
  329. <param name="totalRecords">When this method returns, contains the total number of matched user accounts.</param>
  330. </member>
  331. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.FindUsersByName(System.String,System.Int32,System.Int32,System.Int32@)">
  332. <summary>Returns all of the user accounts whose name matches the specified user name.</summary>
  333. <returns>A collection that contains a page of <paramref name="pageSize" /> user accounts starting at the page specified by <paramref name="pageIndex" />.</returns>
  334. <param name="usernameToMatch">The user name to search for.</param>
  335. <param name="pageIndex">The zero-based index of the page of results to return.</param>
  336. <param name="pageSize">The size of the page of results to return.</param>
  337. <param name="totalRecords">When this method returns, contains the total number of matched users.</param>
  338. </member>
  339. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GeneratePasswordResetToken(System.String,System.Int32)">
  340. <summary>Generates a password reset token that can be sent to a user in email.</summary>
  341. <returns>A token to send to the user.</returns>
  342. <param name="userName">The user name.</param>
  343. <param name="tokenExpirationInMinutesFromNow">(Optional) The time, in minutes, until the password reset token expires. The default is 1440 (24 hours).</param>
  344. <exception cref="T:System.ArgumentException">
  345. <paramref name="username" /> is empty.</exception>
  346. <exception cref="T:System.Configuration.Provider.ProviderException">The database operation failed.</exception>
  347. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  348. </member>
  349. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetAccountsForUser(System.String)">
  350. <summary>Returns all OAuth membership accounts that are associated with the specified user name.</summary>
  351. <returns>A list of all OAuth membership accounts that are associated with the specified user name.</returns>
  352. <param name="userName">The user name.</param>
  353. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  354. </member>
  355. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetAllUsers(System.Int32,System.Int32,System.Int32@)">
  356. <summary>Returns all of the user accounts in the data source.</summary>
  357. <returns>A collection that contains a page of <paramref name="pageSize" /> user accounts starting at the page specified by <paramref name="pageIndex" />.</returns>
  358. <param name="pageIndex">The zero-based index of the page of results to return.</param>
  359. <param name="pageSize">The size of the page of results to return.</param>
  360. <param name="totalRecords">When this method returns, contains the total number of matched user accounts.</param>
  361. </member>
  362. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetCreateDate(System.String)">
  363. <summary>Returns the date and time when the specified user account was created.</summary>
  364. <returns>The date and time on which the user account was created, or <see cref="F:System.DateTime.MinValue" /> if the user account creation date is not available.</returns>
  365. <param name="userName">The user name of the account.</param>
  366. <exception cref="T:System.InvalidOperationException">The user specified by <paramref name="userName" /> does not have a user account.</exception>
  367. </member>
  368. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetLastPasswordFailureDate(System.String)">
  369. <summary>Returns the date and time when an incorrect password was most recently entered for the specified user account.</summary>
  370. <returns>The date and time when an incorrect password was most recently entered for this user account, or <see cref="F:System.DateTime.MinValue" /> if an incorrect password has not been entered for this user account.</returns>
  371. <param name="userName">The user name of the account.</param>
  372. </member>
  373. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetNumberOfUsersOnline">
  374. <summary>Returns the number of users who are currently accessing the application.</summary>
  375. <returns>The number of users who are currently accessing the application.</returns>
  376. </member>
  377. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetOAuthTokenSecret(System.String)">
  378. <summary>Returns the OAuth token secret.</summary>
  379. <returns>The OAuth token.</returns>
  380. <param name="token">The token.</param>
  381. </member>
  382. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetPassword(System.String,System.String)">
  383. <summary>Returns the password for the specified user account from the data source.</summary>
  384. <returns>The password for the specified user account.</returns>
  385. <param name="username">The user to retrieve the password for.</param>
  386. <param name="answer">The answer for the password security question.</param>
  387. <exception cref="T:System.NotSupportedException">
  388. <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.EnablePasswordRetrieval" /> is false.</exception>
  389. <exception cref="T:System.Web.Security.MembershipPasswordException">
  390. <paramref name="answer" /> does not match the security answer for the user account and <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.RequiresQuestionAndAnswer" /> is true.</exception>
  391. </member>
  392. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetPasswordChangedDate(System.String)">
  393. <summary>Returns the date and time when the password was most recently changed for the specified membership account.</summary>
  394. <returns>The date and time when the password was more recently changed for this account, or <see cref="F:System.DateTime.MinValue" /> if the password has never been changed for this membership account.</returns>
  395. <param name="userName">The user name of the account.</param>
  396. <exception cref="T:System.InvalidOperationException">The user specified by <paramref name="userName" /> does not have a membership account.</exception>
  397. </member>
  398. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetPasswordFailuresSinceLastSuccess(System.String)">
  399. <summary>Returns the number of times that the password for the specified user account was incorrectly entered since the most recent successful login or since the user account was created.</summary>
  400. <returns>The count of failed password attempts for the specified user account, or -1 if the user specified by <paramref name="userName" /> does not have a user account.</returns>
  401. <param name="userName">The user name of the account.</param>
  402. </member>
  403. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUser(System.Object,System.Boolean)">
  404. <summary>Returns information about the user account using the specified user ID, and optionally updates the timestamp of the most recent activity for the user account.</summary>
  405. <returns>An object that is populated with the user account information, or null if <paramref name="providerUserKey" /> is not found.</returns>
  406. <param name="providerUserKey">The ID for the user account to get information for. The ID is a <see cref="T:System.Int32" /> value that is stored as an <see cref="T:System.Object" /> instance.</param>
  407. <param name="userIsOnline">true to update the last-activity timestamp for the user account, or false to return user account information without updating the timestamp.</param>
  408. </member>
  409. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUser(System.String,System.Boolean)">
  410. <summary>Returns information about the user account using the specified user name, and optionally updates the timestamp of the most recent activity for the user account.</summary>
  411. <returns>An object that is populated with the user account information, or null if <paramref name="username" /> is not found.</returns>
  412. <param name="username">The name of the user to get information for.</param>
  413. <param name="userIsOnline">true to update the last-activity timestamp for the user account, or false to return user account information without updating the timestamp.</param>
  414. </member>
  415. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUserId(System.String)">
  416. <summary>Returns the ID for a user based on the specified user name.</summary>
  417. <returns>The user ID.</returns>
  418. <param name="userName">The user name.</param>
  419. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  420. </member>
  421. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUserIdFromOAuth(System.String,System.String)">
  422. <summary>Returns the user ID for the specified OAuth or OpenID provider and provider user ID.</summary>
  423. <returns>The user ID, or -1 if there is no user ID associated with the OAuth or Open ID provider user ID.</returns>
  424. <param name="provider">The name of the OAuth or OpenID provider.</param>
  425. <param name="providerUserId">The OAuth or OpenID provider user ID. This is not the user ID of the user account, but the user ID on the OAuth or Open ID provider.</param>
  426. </member>
  427. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUserIdFromPasswordResetToken(System.String)">
  428. <summary>Returns the ID for a user based on a password reset token.</summary>
  429. <returns>The user ID, or -1 if there is no user ID associated with the specified password reset token.</returns>
  430. <param name="token">The password reset token.</param>
  431. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  432. </member>
  433. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUserNameByEmail(System.String)">
  434. <summary>Returns the user name that is associated with the specified email address.</summary>
  435. <returns>The user name that is associated with the specified email address, or null if no match is found.</returns>
  436. <param name="email">The email address to search for.</param>
  437. </member>
  438. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.GetUserNameFromId(System.Int32)">
  439. <summary>Returns the user name that is associated with the specified user ID.</summary>
  440. <returns>The user name.</returns>
  441. <param name="userId">The user ID to get the name for.</param>
  442. </member>
  443. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.HasLocalAccount(System.Int32)">
  444. <summary>Indicates whether the user has local account.</summary>
  445. <returns>true if the user has local account; otherwise, false.</returns>
  446. <param name="userId">The user ID.</param>
  447. </member>
  448. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.Initialize(System.String,System.Collections.Specialized.NameValueCollection)">
  449. <summary>Initializes the provider.</summary>
  450. <param name="name">The friendly name of the provider.</param>
  451. <param name="config">A collection of name/value pairs that represent provider-specific attributes.</param>
  452. <exception cref="T:System.ArgumentNullException">
  453. <paramref name="config" /> is null.</exception>
  454. <exception cref="T:System.Configuration.Provider.ProviderException">
  455. <paramref name="config" /> contains an unrecognized attribute.</exception>
  456. </member>
  457. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.IsConfirmed(System.String)">
  458. <summary>Returns a value that indicates whether the user account has been confirmed by the provider.</summary>
  459. <returns>true if the user account has been confirmed; otherwise, false.</returns>
  460. <param name="userName">The user name.</param>
  461. <exception cref="T:System.ArgumentException">
  462. <paramref name="userName" /> is null or empty.</exception>
  463. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  464. </member>
  465. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.MaxInvalidPasswordAttempts">
  466. <summary>Gets the number of invalid password or password-answer attempts that are allowed before the membership user is locked out.</summary>
  467. <returns>The number of invalid password or password-answer attempts that are allowed before the membership user is locked out.</returns>
  468. </member>
  469. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.MinRequiredNonAlphanumericCharacters">
  470. <summary>Gets the minimum number of special (non-alphanumeric) characters that a password must contain.</summary>
  471. <returns>The minimum number of special characters that a password must contain.</returns>
  472. </member>
  473. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.MinRequiredPasswordLength">
  474. <summary>Gets the minimum length that is required for a password.</summary>
  475. <returns>The minimum length that is required for a password.</returns>
  476. </member>
  477. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.PasswordAttemptWindow">
  478. <summary>Gets the number of minutes during which the maximum number of invalid password or security-question answer attempts are allowed before the user account is locked out.</summary>
  479. <returns>The number of minutes.</returns>
  480. </member>
  481. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.PasswordFormat">
  482. <summary>Gets a value that indicates the format for storing passwords.</summary>
  483. <returns>One of the enumeration values that indicates the format.</returns>
  484. </member>
  485. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.PasswordStrengthRegularExpression">
  486. <summary>Gets the regular expression that is used to evaluate password complexity.</summary>
  487. <returns>The regular expression that is used to evaluate password complexity.</returns>
  488. </member>
  489. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ReplaceOAuthRequestTokenWithAccessToken(System.String,System.String,System.String)">
  490. <summary>Replaces OAuth request token with access token.</summary>
  491. <param name="requestToken">The request token.</param>
  492. <param name="accessToken">The access token.</param>
  493. <param name="accessTokenSecret">The access token secret.</param>
  494. </member>
  495. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.RequiresQuestionAndAnswer">
  496. <summary>Gets a value that indicates whether the membership provider requires that the user answer a security question for password reset and retrieval.</summary>
  497. <returns>true if a security-question answer is required; otherwise, false. The default is true.</returns>
  498. </member>
  499. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.RequiresUniqueEmail">
  500. <summary>Gets a value that indicates whether the membership provider requires a unique email address for each user name.</summary>
  501. <returns>true if the membership provider requires a unique email address; otherwise, false. The default is true.</returns>
  502. </member>
  503. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ResetPassword(System.String,System.String)">
  504. <summary>Resets the password for a user account to a new, automatically generated password.</summary>
  505. <returns>The new password for the specified user account.</returns>
  506. <param name="username">The user account to reset the password for.</param>
  507. <param name="answer">The answer to the security question for the new user.</param>
  508. <exception cref="T:System.NotSupportedException">
  509. <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.EnablePasswordReset" /> is false.</exception>
  510. <exception cref="T:System.Web.Security.MembershipPasswordException">
  511. <paramref name="answer" /> does not match the security answer for the user account in the membership table and <see cref="P:WebMatrix.WebData.SimpleMembershipProvider.RequiresQuestionAndAnswer" /> is true.</exception>
  512. </member>
  513. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ResetPasswordWithToken(System.String,System.String)">
  514. <summary>Resets a password after verifying that the specified password reset token is valid.</summary>
  515. <returns>true if the password was changed; otherwise, false.</returns>
  516. <param name="token">A password reset token.</param>
  517. <param name="newPassword">The new password.</param>
  518. <exception cref="T:System.ArgumentException">
  519. <paramref name="newPassword" /> is null or empty.</exception>
  520. <exception cref="T:System.InvalidOperationException">The <see cref="T:WebMatrix.WebData.SimpleMembershipProvider" /> class was not initialized using a call to the <see cref="Overload:WebMatrix.WebData.WebSecurity.InitializeDatabaseConnection" /> method.</exception>
  521. </member>
  522. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.StoreOAuthRequestToken(System.String,System.String)">
  523. <summary>Stores an OAuth request token.</summary>
  524. <param name="requestToken">The request token.</param>
  525. <param name="requestTokenSecret">The request token secret.</param>
  526. </member>
  527. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.UnlockUser(System.String)">
  528. <summary>Unlocks a user account so that the membership user can be validated.</summary>
  529. <returns>true if the user account was unlocked; otherwise, false.</returns>
  530. <param name="userName">The user whose user account you want to unlock.</param>
  531. </member>
  532. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.UpdateUser(System.Web.Security.MembershipUser)">
  533. <summary>Updates user information.</summary>
  534. <param name="user">An object that represents the user account to update and the information to update for that user account.</param>
  535. </member>
  536. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.UserIdColumn">
  537. <summary>Gets or sets the name of the database column that contains user IDs.</summary>
  538. <returns>The name of the database column that contains user IDs.</returns>
  539. </member>
  540. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.UserNameColumn">
  541. <summary>Gets or sets the name of the database column that contains user names.</summary>
  542. <returns>The name of the database column that contains user names.</returns>
  543. </member>
  544. <member name="P:WebMatrix.WebData.SimpleMembershipProvider.UserTableName">
  545. <summary>Gets or sets the name of the database table that contains user information.</summary>
  546. <returns>The name of the database table that contains user information.</returns>
  547. </member>
  548. <member name="M:WebMatrix.WebData.SimpleMembershipProvider.ValidateUser(System.String,System.String)">
  549. <summary>Verifies that the specified user account and password exist.</summary>
  550. <returns>true if the specified user name and password exist, and if the account has been confirmed; otherwise, false.</returns>
  551. <param name="username">The name of the user account to validate.</param>
  552. <param name="password">The password for the specified user.</param>
  553. <exception cref="T:System.ArgumentException">
  554. <paramref name="username" /> or <paramref name="password" /> are null or empty.</exception>
  555. </member>
  556. <member name="T:WebMatrix.WebData.SimpleMembershipProviderCasingBehavior">
  557. <summary>Configures the behavior of SimpleMembershipProvider for the casing of user name queries.</summary>
  558. </member>
  559. <member name="F:WebMatrix.WebData.SimpleMembershipProviderCasingBehavior.NormalizeCasing">
  560. <summary>Uses the SQL Upper function to normalize the casing of user names for a case-insensitive comparison. This is the default value.</summary>
  561. </member>
  562. <member name="F:WebMatrix.WebData.SimpleMembershipProviderCasingBehavior.RelyOnDatabaseCollation">
  563. <summary>Relies on the database's configured collation to normalize casing for the comparison of user names. User names are provided to the database exactly as entered by the user.</summary>
  564. </member>
  565. <member name="T:WebMatrix.WebData.SimpleRoleProvider">
  566. <summary>Provides basic role-management functionality.</summary>
  567. </member>
  568. <member name="M:WebMatrix.WebData.SimpleRoleProvider.#ctor">
  569. <summary>Initializes a new instance of t

Large files files are truncated, but you can click here to view the full file