-
Notifications
You must be signed in to change notification settings - Fork 112
/
ISessionStore.xml
124 lines (124 loc) · 9.88 KB
/
ISessionStore.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
<Type Name="ISessionStore" FullName="Microsoft.AspNetCore.Session.ISessionStore">
<TypeSignature Language="C++ CLI" Value="public interface class ISessionStore" />
<TypeSignature Language="C#" Value="public interface ISessionStore" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ISessionStore" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Session.ISessionStore" />
<TypeSignature Language="VB.NET" Value="Public Interface ISessionStore" />
<TypeSignature Language="F#" Value="type ISessionStore = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ISessionStore" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Session</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Storage for sessions that maintain user data while the user browses a web application.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Create">
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::AspNetCore::Http::ISession ^ Create(System::String ^ sessionKey, TimeSpan idleTimeout, Func<bool> ^ tryEstablishSession, bool isNewSessionKey);" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Http.ISession Create (string sessionKey, TimeSpan idleTimeout, Func<bool> tryEstablishSession, bool isNewSessionKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.AspNetCore.Http.ISession Create(string sessionKey, valuetype System.TimeSpan idleTimeout, class System.Func`1<bool> tryEstablishSession, bool isNewSessionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Session.ISessionStore.Create(System.String,System.TimeSpan,System.Func{System.Boolean},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function Create (sessionKey As String, idleTimeout As TimeSpan, tryEstablishSession As Func(Of Boolean), isNewSessionKey As Boolean) As ISession" />
<MemberSignature Language="F#" Value="abstract member Create : string * TimeSpan * Func<bool> * bool -> Microsoft.AspNetCore.Http.ISession" Usage="iSessionStore.Create (sessionKey, idleTimeout, tryEstablishSession, isNewSessionKey)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Session</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Http.ISession</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sessionKey" Type="System.String" Index="0" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
<Parameter Name="idleTimeout" Type="System.TimeSpan" Index="1" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
<Parameter Name="tryEstablishSession" Type="System.Func<System.Boolean>" Index="2" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
<Parameter Name="isNewSessionKey" Type="System.Boolean" Index="3" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1" />
</Parameters>
<Docs>
<param name="sessionKey">To be added.</param>
<param name="idleTimeout">To be added.</param>
<param name="tryEstablishSession">To be added.</param>
<param name="isNewSessionKey">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::AspNetCore::Http::ISession ^ Create(System::String ^ sessionKey, TimeSpan idleTimeout, TimeSpan ioTimeout, Func<bool> ^ tryEstablishSession, bool isNewSessionKey);" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Http.ISession Create (string sessionKey, TimeSpan idleTimeout, TimeSpan ioTimeout, Func<bool> tryEstablishSession, bool isNewSessionKey);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.AspNetCore.Http.ISession Create(string sessionKey, valuetype System.TimeSpan idleTimeout, valuetype System.TimeSpan ioTimeout, class System.Func`1<bool> tryEstablishSession, bool isNewSessionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Session.ISessionStore.Create(System.String,System.TimeSpan,System.TimeSpan,System.Func{System.Boolean},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function Create (sessionKey As String, idleTimeout As TimeSpan, ioTimeout As TimeSpan, tryEstablishSession As Func(Of Boolean), isNewSessionKey As Boolean) As ISession" />
<MemberSignature Language="F#" Value="abstract member Create : string * TimeSpan * TimeSpan * Func<bool> * bool -> Microsoft.AspNetCore.Http.ISession" Usage="iSessionStore.Create (sessionKey, idleTimeout, ioTimeout, tryEstablishSession, isNewSessionKey)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Session</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Http.ISession</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sessionKey" Type="System.String" Index="0" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="idleTimeout" Type="System.TimeSpan" Index="1" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="ioTimeout" Type="System.TimeSpan" Index="2" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="tryEstablishSession" Type="System.Func<System.Boolean>" Index="3" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
<Parameter Name="isNewSessionKey" Type="System.Boolean" Index="4" FrameworkAlternate="aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0;aspnetcore-8.0;aspnetcore-9.0" />
</Parameters>
<Docs>
<param name="sessionKey">A unique key used to lookup the session.</param>
<param name="idleTimeout">How long the session can be inactive (e.g. not accessed) before it will expire.</param>
<param name="ioTimeout">
The maximum amount of time <see cref="M:Microsoft.AspNetCore.Http.ISession.LoadAsync(System.Threading.CancellationToken)" /> and
<see cref="M:Microsoft.AspNetCore.Http.ISession.CommitAsync(System.Threading.CancellationToken)" /> are allowed take.
</param>
<param name="tryEstablishSession">
A callback invoked during <see cref="M:Microsoft.AspNetCore.Http.ISession.Set(System.String,System.Byte[])" /> to verify that modifying the session is currently valid.
If the callback returns <see langword="false" />, <see cref="M:Microsoft.AspNetCore.Http.ISession.Set(System.String,System.Byte[])" /> should throw an <see cref="T:System.InvalidOperationException" />.
<see cref="T:Microsoft.AspNetCore.Session.SessionMiddleware" /> provides a callback that returns <see langword="false" /> if the session was not established
prior to sending the response.
</param>
<param name="isNewSessionKey">
<see langword="true" /> if establishing a new session; <see langword="false" /> if resuming a session.</param>
<summary>
Create a new or resume an <see cref="T:Microsoft.AspNetCore.Http.ISession" />.
</summary>
<returns>The <see cref="T:Microsoft.AspNetCore.Http.ISession" /> that was created or resumed.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>