projects / platform / core / dotnet / build-tools.git / blob
? search:


9d3f846c9e68ad207856cdafd3e58e770db6172a
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.ResponseCaching</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCache.Get(System.String)">\r
8             <summary>\r
9             Gets the cached response for the given key, if it exists.\r
10             If no cached response exists for the given key, <c>null</c> is returned.\r
11             </summary>\r
12             <param name="key">The cache key to look up.</param>\r
13             <returns>The response cache entry if it exists; otherwise <c>null</c>.</returns>\r
14         </member>\r
15         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCache.GetAsync(System.String)">\r
16             <summary>\r
17             Gets the cached response for the given key, if it exists.\r
18             If no cached response exists for the given key, <c>null</c> is returned.\r
19             </summary>\r
20             <param name="key">The cache key to look up.</param>\r
21             <returns>The response cache entry if it exists; otherwise <c>null</c>.</returns>\r
22         </member>\r
23         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCache.Set(System.String,Microsoft.AspNetCore.ResponseCaching.IResponseCacheEntry,System.TimeSpan)">\r
24             <summary>\r
25             Stores the given response in the response cache.\r
26             </summary>\r
27             <param name="key">The cache key to store the response under.</param>\r
28             <param name="entry">The response cache entry to store.</param>\r
29             <param name="validFor">The amount of time the entry will be kept in the cache before expiring, relative to now.</param>\r
30         </member>\r
31         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCache.SetAsync(System.String,Microsoft.AspNetCore.ResponseCaching.IResponseCacheEntry,System.TimeSpan)">\r
32             <summary>\r
33             Stores the given response in the response cache.\r
34             </summary>\r
35             <param name="key">The cache key to store the response under.</param>\r
36             <param name="entry">The response cache entry to store.</param>\r
37             <param name="validFor">The amount of time the entry will be kept in the cache before expiring, relative to now.</param>\r
38             <returns>No result is returned.</returns>\r
39         </member>\r
40         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingKeyProvider.CreateBaseKey(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
41             <summary>\r
42             Create a base key for a response cache entry.\r
43             </summary>\r
44             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
45             <returns>The created base key.</returns>\r
46         </member>\r
47         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingKeyProvider.CreateStorageVaryByKey(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
48             <summary>\r
49             Create a vary key for storing cached responses.\r
50             </summary>\r
51             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
52             <returns>The created vary key.</returns>\r
53         </member>\r
54         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingKeyProvider.CreateLookupVaryByKeys(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
55             <summary>\r
56             Create one or more vary keys for looking up cached responses.\r
57             </summary>\r
58             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
59             <returns>An ordered <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the vary keys to try when looking up items.</returns>\r
60         </member>\r
61         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingPolicyProvider.AttemptResponseCaching(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
62             <summary>\r
63             Determine whether the response caching logic should be attempted for the incoming HTTP request.\r
64             </summary>\r
65             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
66             <returns><c>true</c> if response caching logic should be attempted; otherwise <c>false</c>.</returns>\r
67         </member>\r
68         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingPolicyProvider.AllowCacheLookup(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
69             <summary>\r
70             Determine whether a cache lookup is allowed for the incoming HTTP request.\r
71             </summary>\r
72             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
73             <returns><c>true</c> if cache lookup for this request is allowed; otherwise <c>false</c>.</returns>\r
74         </member>\r
75         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingPolicyProvider.AllowCacheStorage(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
76             <summary>\r
77             Determine whether storage of the response is allowed for the incoming HTTP request.\r
78             </summary>\r
79             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
80             <returns><c>true</c> if storage of the response for this request is allowed; otherwise <c>false</c>.</returns>\r
81         </member>\r
82         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingPolicyProvider.IsResponseCacheable(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
83             <summary>\r
84             Determine whether the response received by the middleware can be cached for future requests.\r
85             </summary>\r
86             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
87             <returns><c>true</c> if the response is cacheable; otherwise <c>false</c>.</returns>\r
88         </member>\r
89         <member name="M:Microsoft.AspNetCore.ResponseCaching.IResponseCachingPolicyProvider.IsCachedEntryFresh(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
90             <summary>\r
91             Determine whether the response retrieved from the response cache is fresh and can be served.\r
92             </summary>\r
93             <param name="context">The <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext"/>.</param>\r
94             <returns><c>true</c> if the cached entry is fresh; otherwise <c>false</c>.</returns>\r
95         </member>\r
96         <member name="T:Microsoft.AspNetCore.ResponseCaching.ISystemClock">\r
97             <summary>\r
98             Abstracts the system clock to facilitate testing.\r
99             </summary>\r
100         </member>\r
101         <member name="P:Microsoft.AspNetCore.ResponseCaching.ISystemClock.UtcNow">\r
102             <summary>\r
103             Retrieves the current system time in UTC.\r
104             </summary>\r
105         </member>\r
106         <member name="T:Microsoft.AspNetCore.ResponseCaching.LoggerExtensions">\r
107             <summary>\r
108             Defines *all* the logger messages produced by response caching\r
109             </summary>\r
110         </member>\r
111         <member name="M:Microsoft.AspNetCore.ResponseCaching.ResponseCachingMiddleware.OnFinalizeCacheHeaders(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
112             <summary>\r
113             Finalize cache headers.\r
114             </summary>\r
115             <param name="context"></param>\r
116             <returns><c>true</c> if a vary by entry needs to be stored in the cache; otherwise <c>false</c>.</returns>\r
117         </member>\r
118         <member name="M:Microsoft.AspNetCore.ResponseCaching.ResponseCachingMiddleware.OnStartResponse(Microsoft.AspNetCore.ResponseCaching.ResponseCachingContext)">\r
119             <summary>\r
120             Mark the response as started and set the response time if no reponse was started yet.\r
121             </summary>\r
122             <param name="context"></param>\r
123             <returns><c>true</c> if the response was not started before this call; otherwise <c>false</c>.</returns>\r
124         </member>\r
125         <member name="P:Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions.SizeLimit">\r
126             <summary>\r
127             The size limit for the response cache middleware in bytes. The default is set to 100 MB.\r
128             </summary>\r
129         </member>\r
130         <member name="P:Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions.MaximumBodySize">\r
131             <summary>\r
132             The largest cacheable size for the response body in bytes. The default is set to 64 MB.\r
133             </summary>\r
134         </member>\r
135         <member name="P:Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions.UseCaseSensitivePaths">\r
136             <summary>\r
137             <c>true</c> if request paths are case-sensitive; otherwise <c>false</c>. The default is to treat paths as case-insensitive.\r
138             </summary>\r
139         </member>\r
140         <member name="P:Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions.SystemClock">\r
141             <summary>\r
142             For testing purposes only.\r
143             </summary>\r
144         </member>\r
145         <member name="P:Microsoft.AspNetCore.ResponseCaching.StreamUtilities.BodySegmentSize">\r
146             <summary>\r
147             The segment size for buffering the response body in bytes. The default is set to 80 KB (81920 Bytes) to avoid allocations on the LOH.\r
148             </summary>\r
149         </member>\r
150         <member name="T:Microsoft.AspNetCore.ResponseCaching.SystemClock">\r
151             <summary>\r
152             Provides access to the normal system clock.\r
153             </summary>\r
154         </member>\r
155         <member name="P:Microsoft.AspNetCore.ResponseCaching.SystemClock.UtcNow">\r
156             <summary>\r
157             Retrieves the current system time in UTC.\r
158             </summary>\r
159         </member>\r
160         <member name="T:Microsoft.Extensions.DependencyInjection.ResponseCachingServicesExtensions">\r
161             <summary>\r
162             Extension methods for the ResponseCaching middleware.\r
163             </summary>\r
164         </member>\r
165         <member name="M:Microsoft.Extensions.DependencyInjection.ResponseCachingServicesExtensions.AddResponseCaching(Microsoft.Extensions.DependencyInjection.IServiceCollection)">\r
166             <summary>\r
167             Add response caching services.\r
168             </summary>\r
169             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>\r
170             <returns></returns>\r
171         </member>\r
172         <member name="M:Microsoft.Extensions.DependencyInjection.ResponseCachingServicesExtensions.AddResponseCaching(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions})">\r
173             <summary>\r
174             Add response caching services and configure the related options.\r
175             </summary>\r
176             <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for adding services.</param>\r
177             <param name="configureOptions">A delegate to configure the <see cref="T:Microsoft.AspNetCore.ResponseCaching.ResponseCachingOptions"/>.</param>\r
178             <returns></returns>\r
179         </member>\r
180     </members>\r
181 </doc>\r
Domain: Dotnet / Common;