Skip to content

Commit 1cf193e

Browse files
authored
Update api ref docs for 1.0.0 (dotnet#1497)
* Update api ref docs for 1.0.0 * Fix UseWebRoot link * Enable nit-picky mode
1 parent e15d86c commit 1cf193e

File tree

1,790 files changed

+60994
-68084
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,790 files changed

+60994
-68084
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
3+
IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim> Class
4+
==========================================================================================
5+
6+
7+
8+
9+
10+
Namespace
11+
:dn:ns:`Microsoft.AspNet.Identity.CoreCompat`
12+
Assemblies
13+
* Microsoft.AspNet.Identity.AspNetCoreCompat
14+
15+
----
16+
17+
.. contents::
18+
:local:
19+
20+
21+
22+
Inheritance Hierarchy
23+
---------------------
24+
25+
26+
* :dn:cls:`System.Object`
27+
* :dn:cls:`System.Data.Entity.DbContext`
28+
* :dn:cls:`Microsoft.AspNet.Identity.EntityFramework.IdentityDbContext{{TUser},{TRole},{TKey},{TUserLogin},{TUserRole},{TUserClaim}}`
29+
* :dn:cls:`Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext\<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>`
30+
31+
32+
33+
34+
35+
36+
37+
38+
Syntax
39+
------
40+
41+
.. code-block:: csharp
42+
43+
public class IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim> : IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim>, IDisposable, IObjectContextAdapter where TUser : IdentityUser<TKey, TUserLogin, TUserRole, TUserClaim> where TRole : IdentityRole<TKey, TUserRole> where TUserLogin : IdentityUserLogin<TKey> where TUserRole : IdentityUserRole<TKey> where TUserClaim : IdentityUserClaim<TKey> where TRoleClaim : IdentityRoleClaim<TKey>
44+
45+
46+
47+
48+
49+
50+
51+
52+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext`7
53+
:hidden:
54+
55+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>
56+
57+
Constructors
58+
------------
59+
60+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>
61+
:noindex:
62+
:hidden:
63+
64+
65+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext()
66+
67+
68+
69+
70+
.. code-block:: csharp
71+
72+
public IdentityDbContext()
73+
74+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext(System.Data.Common.DbConnection, System.Boolean)
75+
76+
77+
78+
79+
:type existingConnection: System.Data.Common.DbConnection
80+
81+
82+
:type contextOwnsConnection: System.Boolean
83+
84+
85+
.. code-block:: csharp
86+
87+
public IdentityDbContext(DbConnection existingConnection, bool contextOwnsConnection)
88+
89+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext(System.Data.Common.DbConnection, System.Data.Entity.Infrastructure.DbCompiledModel, System.Boolean)
90+
91+
92+
93+
94+
:type existingConnection: System.Data.Common.DbConnection
95+
96+
97+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
98+
99+
100+
:type contextOwnsConnection: System.Boolean
101+
102+
103+
.. code-block:: csharp
104+
105+
public IdentityDbContext(DbConnection existingConnection, DbCompiledModel model, bool contextOwnsConnection)
106+
107+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext(System.Data.Entity.Infrastructure.DbCompiledModel)
108+
109+
110+
111+
112+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
113+
114+
115+
.. code-block:: csharp
116+
117+
public IdentityDbContext(DbCompiledModel model)
118+
119+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext(System.String)
120+
121+
122+
123+
124+
:type nameOrConnectionString: System.String
125+
126+
127+
.. code-block:: csharp
128+
129+
public IdentityDbContext(string nameOrConnectionString)
130+
131+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.IdentityDbContext(System.String, System.Data.Entity.Infrastructure.DbCompiledModel)
132+
133+
134+
135+
136+
:type nameOrConnectionString: System.String
137+
138+
139+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
140+
141+
142+
.. code-block:: csharp
143+
144+
public IdentityDbContext(string nameOrConnectionString, DbCompiledModel model)
145+
146+
147+
Methods
148+
-------
149+
150+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>
151+
:noindex:
152+
:hidden:
153+
154+
155+
.. dn:method:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.OnModelCreating(System.Data.Entity.DbModelBuilder)
156+
157+
158+
159+
160+
:type modelBuilder: System.Data.Entity.DbModelBuilder
161+
162+
163+
.. code-block:: csharp
164+
165+
protected override void OnModelCreating(DbModelBuilder modelBuilder)
166+
167+
.. dn:method:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.ValidateEntity(System.Data.Entity.Infrastructure.DbEntityEntry, System.Collections.Generic.IDictionary<System.Object, System.Object>)
168+
169+
170+
171+
172+
:type entityEntry: System.Data.Entity.Infrastructure.DbEntityEntry
173+
174+
175+
:type items: System.Collections.Generic.IDictionary<System.Collections.Generic.IDictionary`2>{System.Object<System.Object>, System.Object<System.Object>}
176+
:rtype: System.Data.Entity.Validation.DbEntityValidationResult
177+
178+
179+
.. code-block:: csharp
180+
181+
protected override DbEntityValidationResult ValidateEntity(DbEntityEntry entityEntry, IDictionary<object, object> items)
182+
183+
184+
Properties
185+
----------
186+
187+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>
188+
:noindex:
189+
:hidden:
190+
191+
192+
.. dn:property:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser, TRole, TKey, TUserLogin, TUserRole, TUserClaim, TRoleClaim>.RoleClaims
193+
194+
195+
:rtype: System.Data.Entity.IDbSet<System.Data.Entity.IDbSet`1>{TRoleClaim}
196+
197+
198+
.. code-block:: csharp
199+
200+
public virtual IDbSet<TRoleClaim> RoleClaims { get; set; }
201+
202+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
2+
3+
IdentityDbContext<TUser> Class
4+
==============================
5+
6+
7+
8+
9+
10+
Namespace
11+
:dn:ns:`Microsoft.AspNet.Identity.CoreCompat`
12+
Assemblies
13+
* Microsoft.AspNet.Identity.AspNetCoreCompat
14+
15+
----
16+
17+
.. contents::
18+
:local:
19+
20+
21+
22+
Inheritance Hierarchy
23+
---------------------
24+
25+
26+
* :dn:cls:`System.Object`
27+
* :dn:cls:`System.Data.Entity.DbContext`
28+
* :dn:cls:`Microsoft.AspNet.Identity.EntityFramework.IdentityDbContext{{TUser},Microsoft.AspNet.Identity.CoreCompat.IdentityRole,System.String,Microsoft.AspNet.Identity.CoreCompat.IdentityUserLogin,Microsoft.AspNet.Identity.EntityFramework.IdentityUserRole,Microsoft.AspNet.Identity.EntityFramework.IdentityUserClaim}`
29+
* :dn:cls:`Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext{{TUser},Microsoft.AspNet.Identity.CoreCompat.IdentityRole,System.String,Microsoft.AspNet.Identity.CoreCompat.IdentityUserLogin,Microsoft.AspNet.Identity.EntityFramework.IdentityUserRole,Microsoft.AspNet.Identity.EntityFramework.IdentityUserClaim,Microsoft.AspNet.Identity.CoreCompat.IdentityRoleClaim}`
30+
* :dn:cls:`Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext\<TUser>`
31+
32+
33+
34+
35+
36+
37+
38+
39+
Syntax
40+
------
41+
42+
.. code-block:: csharp
43+
44+
public class IdentityDbContext<TUser> : IdentityDbContext<TUser, IdentityRole, string, IdentityUserLogin, IdentityUserRole, IdentityUserClaim, IdentityRoleClaim>, IDisposable, IObjectContextAdapter where TUser : IdentityUser
45+
46+
47+
48+
49+
50+
51+
52+
53+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext`1
54+
:hidden:
55+
56+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>
57+
58+
Constructors
59+
------------
60+
61+
.. dn:class:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>
62+
:noindex:
63+
:hidden:
64+
65+
66+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext()
67+
68+
69+
70+
71+
.. code-block:: csharp
72+
73+
public IdentityDbContext()
74+
75+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext(System.Data.Common.DbConnection, System.Boolean)
76+
77+
78+
79+
80+
:type existingConnection: System.Data.Common.DbConnection
81+
82+
83+
:type contextOwnsConnection: System.Boolean
84+
85+
86+
.. code-block:: csharp
87+
88+
public IdentityDbContext(DbConnection existingConnection, bool contextOwnsConnection)
89+
90+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext(System.Data.Common.DbConnection, System.Data.Entity.Infrastructure.DbCompiledModel, System.Boolean)
91+
92+
93+
94+
95+
:type existingConnection: System.Data.Common.DbConnection
96+
97+
98+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
99+
100+
101+
:type contextOwnsConnection: System.Boolean
102+
103+
104+
.. code-block:: csharp
105+
106+
public IdentityDbContext(DbConnection existingConnection, DbCompiledModel model, bool contextOwnsConnection)
107+
108+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext(System.Data.Entity.Infrastructure.DbCompiledModel)
109+
110+
111+
112+
113+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
114+
115+
116+
.. code-block:: csharp
117+
118+
public IdentityDbContext(DbCompiledModel model)
119+
120+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext(System.String)
121+
122+
123+
124+
125+
:type nameOrConnectionString: System.String
126+
127+
128+
.. code-block:: csharp
129+
130+
public IdentityDbContext(string nameOrConnectionString)
131+
132+
.. dn:constructor:: Microsoft.AspNet.Identity.CoreCompat.IdentityDbContext<TUser>.IdentityDbContext(System.String, System.Data.Entity.Infrastructure.DbCompiledModel)
133+
134+
135+
136+
137+
:type nameOrConnectionString: System.String
138+
139+
140+
:type model: System.Data.Entity.Infrastructure.DbCompiledModel
141+
142+
143+
.. code-block:: csharp
144+
145+
public IdentityDbContext(string nameOrConnectionString, DbCompiledModel model)
146+
147+

0 commit comments

Comments
 (0)