4 <name>Microsoft.AspNetCore.Http.Features</name>
7 <member name="T:Microsoft.AspNetCore.Http.Features.IFeatureCollection">
9 Represents a collection of HTTP features.
12 <member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.IsReadOnly">
14 Indicates if the collection can be modified.
17 <member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Revision">
19 Incremented for each modification and can be used to verify cached results.
22 <member name="P:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Item(System.Type)">
24 Gets or sets a given feature. Setting a null value removes the feature.
26 <param name="key"></param>
27 <returns>The requested feature, or null if it is not present.</returns>
29 <member name="M:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Get``1">
31 Retrieves the requested feature from the collection.
33 <typeparam name="TFeature">The feature key.</typeparam>
34 <returns>The requested feature, or null if it is not present.</returns>
36 <member name="M:Microsoft.AspNetCore.Http.Features.IFeatureCollection.Set``1(``0)">
38 Sets the given feature in the collection.
40 <typeparam name="TFeature">The feature key.</typeparam>
41 <param name="instance">The feature value.</param>
43 <member name="P:Microsoft.AspNetCore.Http.Features.IFormFeature.HasFormContentType">
45 Indicates if the request has a supported form content-type.
48 <member name="P:Microsoft.AspNetCore.Http.Features.IFormFeature.Form">
50 The parsed form, if any.
53 <member name="M:Microsoft.AspNetCore.Http.Features.IFormFeature.ReadForm">
55 Parses the request body as a form.
59 <member name="M:Microsoft.AspNetCore.Http.Features.IFormFeature.ReadFormAsync(System.Threading.CancellationToken)">
61 Parses the request body as a form.
63 <param name="cancellationToken"></param>
66 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpBodyControlFeature">
68 Controls the IO behavior for the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body"/> and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body"/>
71 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpBodyControlFeature.AllowSynchronousIO">
73 Gets or sets a value that controls whether synchronous IO is allowed for the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body"/> and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body"/>
76 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature">
78 Information regarding the TCP/IP connection carrying the request.
81 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.ConnectionId">
83 The unique identifier for the connection the request was received on. This is primarily for diagnostic purposes.
86 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.RemoteIpAddress">
88 The IPAddress of the client making the request. Note this may be for a proxy rather than the end user.
91 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.LocalIpAddress">
93 The local IPAddress on which the request was received.
96 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.RemotePort">
98 The remote port of the client making the request.
101 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpConnectionFeature.LocalPort">
103 The local port on which the request was received.
106 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature">
108 Feature to inspect and modify the maximum request body size for a single request.
111 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.IsReadOnly">
113 Indicates whether <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.MaxRequestBodySize"/> is read-only.
114 If true, this could mean that the request body has already been read from
115 or that <see cref="M:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.UpgradeAsync"/> was called.
118 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpMaxRequestBodySizeFeature.MaxRequestBodySize">
120 The maximum allowed size of the current request body in bytes.
121 When set to null, the maximum request body size is unlimited.
122 This cannot be modified after the reading the request body has started.
123 This limit does not affect upgraded connections which are always unlimited.
126 Defaults to the server's global max request body size limit.
129 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature">
131 Contains the details of a given request. These properties should all be mutable.
132 None of these properties should ever be set to null.
135 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Protocol">
137 The HTTP-version as defined in RFC 7230. E.g. "HTTP/1.1"
140 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Scheme">
142 The request uri scheme. E.g. "http" or "https". Note this value is not included
143 in the original request, it is inferred by checking if the transport used a TLS
147 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Method">
149 The request method as defined in RFC 7230. E.g. "GET", "HEAD", "POST", etc..
152 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.PathBase">
154 The first portion of the request path associated with application root. The value
155 is un-escaped. The value may be string.Empty.
158 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Path">
160 The portion of the request path that identifies the requested resource. The value
161 is un-escaped. The value may be string.Empty if <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.PathBase"/> contains the
165 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.QueryString">
167 The query portion of the request-target as defined in RFC 7230. The value
168 may be string.Empty. If not empty then the leading '?' will be included. The value
169 is in its original form, without un-escaping.
172 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.RawTarget">
174 The request target as it was sent in the HTTP request. This property contains the
175 raw path and full query, as well as other request targets such as * for OPTIONS
176 requests (https://tools.ietf.org/html/rfc7230#section-5.3).
179 This property is not used internally for routing or authorization decisions. It has not
180 been UrlDecoded and care should be taken in its use.
183 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Headers">
185 Headers included in the request, aggregated by header name. The values are not split
186 or merged across header lines. E.g. The following headers:
187 HeaderA: value1, value2
189 Result in Headers["HeaderA"] = { "value1, value2", "value3" }
192 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestFeature.Body">
194 A <see cref="T:System.IO.Stream"/> representing the request body, if any. Stream.Null may be used
195 to represent an empty request body.
198 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpRequestIdentifierFeature">
200 Feature to identify a request.
203 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestIdentifierFeature.TraceIdentifier">
205 Identifier to trace a request.
208 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpRequestLifetimeFeature.RequestAborted">
210 A <see cref="T:System.Threading.CancellationToken"/> that fires if the request is aborted and
211 the application should cease processing. The token will not fire if the request
212 completes successfully.
215 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpRequestLifetimeFeature.Abort">
217 Forcefully aborts the request if it has not already completed. This will result in
218 RequestAborted being triggered.
221 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature">
223 Represents the fields and state of an HTTP response.
226 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode">
228 The status-code as defined in RFC 7230. The default value is 200.
231 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase">
233 The reason-phrase as defined in RFC 7230. Note this field is no longer supported by HTTP/2.
236 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers">
238 The response headers to send. Headers with multiple values will be emitted as multiple headers.
241 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Body">
243 The <see cref="T:System.IO.Stream"/> for writing the response body.
246 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.HasStarted">
248 Indicates if the response has started. If true, the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode"/>,
249 <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase"/>, and <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers"/> are now immutable, and
250 OnStarting should no longer be called.
253 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.OnStarting(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">
255 Registers a callback to be invoked just before the response starts. This is the
256 last chance to modify the <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.Headers"/>, <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.StatusCode"/>, or
257 <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.ReasonPhrase"/>.
259 <param name="callback">The callback to invoke when starting the response.</param>
260 <param name="state">The state to pass into the callback.</param>
262 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpResponseFeature.OnCompleted(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">
264 Registers a callback to be invoked after a response has fully completed. This is
265 intended for resource cleanup.
267 <param name="callback">The callback to invoke after the response has completed.</param>
268 <param name="state">The state to pass into the callback.</param>
270 <member name="T:Microsoft.AspNetCore.Http.Features.IHttpSendFileFeature">
272 Provides an efficient mechanism for transferring files from disk to the network.
275 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpSendFileFeature.SendFileAsync(System.String,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">
277 Sends the requested file in the response body. This may bypass the IHttpResponseFeature.Body
278 <see cref="T:System.IO.Stream"/>. A response may include multiple writes.
280 <param name="path">The full disk path to the file.</param>
281 <param name="offset">The offset in the file to start at.</param>
282 <param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
283 <param name="cancellation">A <see cref="T:System.Threading.CancellationToken"/> used to abort the transmission.</param>
286 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.IsUpgradableRequest">
288 Indicates if the server can upgrade this request to an opaque, bidirectional stream.
291 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.UpgradeAsync">
293 Attempt to upgrade the request to an opaque, bidirectional stream. The response status code
294 and headers need to be set before this is invoked. Check <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpUpgradeFeature.IsUpgradableRequest"/>
299 <member name="P:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.IsWebSocketRequest">
301 Indicates if this is a WebSocket upgrade request.
304 <member name="M:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.AcceptAsync(Microsoft.AspNetCore.Http.WebSocketAcceptContext)">
306 Attempts to upgrade the request to a <see cref="T:System.Net.WebSockets.WebSocket"/>. Check <see cref="P:Microsoft.AspNetCore.Http.Features.IHttpWebSocketFeature.IsWebSocketRequest"/>
307 before invoking this.
309 <param name="context"></param>
312 <member name="T:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature">
314 A helper for creating the response Set-Cookie header.
317 <member name="P:Microsoft.AspNetCore.Http.Features.IResponseCookiesFeature.Cookies">
319 Gets the wrapper for the response Set-Cookie header.
322 <member name="P:Microsoft.AspNetCore.Http.Features.ITlsConnectionFeature.ClientCertificate">
324 Synchronously retrieves the client certificate, if any.
327 <member name="M:Microsoft.AspNetCore.Http.Features.ITlsConnectionFeature.GetClientCertificateAsync(System.Threading.CancellationToken)">
329 Asynchronously retrieves the client certificate, if any.
333 <member name="T:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature">
335 Provides information regarding TLS token binding parameters.
338 TLS token bindings help mitigate the risk of impersonation by an attacker in the
339 event an authenticated client's bearer tokens are somehow exfiltrated from the
340 client's machine. See https://datatracker.ietf.org/doc/draft-popov-token-binding/
341 for more information.
344 <member name="M:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature.GetProvidedTokenBindingId">
346 Gets the 'provided' token binding identifier associated with the request.
348 <returns>The token binding identifier, or null if the client did not
349 supply a 'provided' token binding or valid proof of possession of the
350 associated private key. The caller should treat this identifier as an
351 opaque blob and should not try to parse it.</returns>
353 <member name="M:Microsoft.AspNetCore.Http.Features.ITlsTokenBindingFeature.GetReferredTokenBindingId">
355 Gets the 'referred' token binding identifier associated with the request.
357 <returns>The token binding identifier, or null if the client did not
358 supply a 'referred' token binding or valid proof of possession of the
359 associated private key. The caller should treat this identifier as an
360 opaque blob and should not try to parse it.</returns>
362 <member name="T:Microsoft.AspNetCore.Http.CookieOptions">
364 Options used to create a new cookie.
367 <member name="M:Microsoft.AspNetCore.Http.CookieOptions.#ctor">
369 Creates a default cookie with a path of '/'.
372 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.Domain">
374 Gets or sets the domain to associate the cookie with.
376 <returns>The domain to associate the cookie with.</returns>
378 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.Path">
380 Gets or sets the cookie path.
382 <returns>The cookie path.</returns>
384 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.Expires">
386 Gets or sets the expiration date and time for the cookie.
388 <returns>The expiration date and time for the cookie.</returns>
390 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.Secure">
392 Gets or sets a value that indicates whether to transmit the cookie using Secure Sockets Layer (SSL)--that is, over HTTPS only.
394 <returns>true to transmit the cookie only over an SSL connection (HTTPS); otherwise, false.</returns>
396 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.SameSite">
398 Gets or sets the value for the SameSite attribute of the cookie. The default value is <see cref="F:Microsoft.AspNetCore.Http.SameSiteMode.Lax"/>
400 <returns>The <see cref="T:Microsoft.AspNetCore.Http.SameSiteMode"/> representing the enforcement mode of the cookie.</returns>
402 <member name="P:Microsoft.AspNetCore.Http.CookieOptions.HttpOnly">
404 Gets or sets a value that indicates whether a cookie is accessible by client-side script.
406 <returns>true if a cookie must not be accessible by client-side script; otherwise, false.</returns>
408 <member name="T:Microsoft.AspNetCore.Http.IFormCollection">
410 Represents the parsed form values sent with the HttpRequest.
413 <member name="P:Microsoft.AspNetCore.Http.IFormCollection.Count">
415 Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
418 The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
421 <member name="P:Microsoft.AspNetCore.Http.IFormCollection.Keys">
423 Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
424 <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
427 An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
428 that implements <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
431 <member name="M:Microsoft.AspNetCore.Http.IFormCollection.ContainsKey(System.String)">
433 Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains an element
434 with the specified key.
437 The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" />.
440 true if the <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains an element with
441 the key; otherwise, false.
443 <exception cref="T:System.ArgumentNullException">
447 <member name="M:Microsoft.AspNetCore.Http.IFormCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
449 Gets the value associated with the specified key.
452 The key of the value to get.
455 The key of the value to get.
456 When this method returns, the value associated with the specified key, if the
457 key is found; otherwise, the default value for the type of the value parameter.
458 This parameter is passed uninitialized.
461 true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> contains
462 an element with the specified key; otherwise, false.
464 <exception cref="T:System.ArgumentNullException">
468 <member name="P:Microsoft.AspNetCore.Http.IFormCollection.Item(System.String)">
470 Gets the value with the specified key.
473 The key of the value to get.
476 The element with the specified key, or <c>StringValues.Empty</c> if the key is not present.
478 <exception cref="T:System.ArgumentNullException">
482 <see cref="T:Microsoft.AspNetCore.Http.IFormCollection" /> has a different indexer contract than
483 <see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>StringValues.Empty</c> for missing entries
484 rather than throwing an Exception.
487 <member name="P:Microsoft.AspNetCore.Http.IFormCollection.Files">
489 The file collection sent with the request.
491 <returns>The files included with the request.</returns>
493 <member name="T:Microsoft.AspNetCore.Http.IFormFile">
495 Represents a file sent with the HttpRequest.
498 <member name="P:Microsoft.AspNetCore.Http.IFormFile.ContentType">
500 Gets the raw Content-Type header of the uploaded file.
503 <member name="P:Microsoft.AspNetCore.Http.IFormFile.ContentDisposition">
505 Gets the raw Content-Disposition header of the uploaded file.
508 <member name="P:Microsoft.AspNetCore.Http.IFormFile.Headers">
510 Gets the header dictionary of the uploaded file.
513 <member name="P:Microsoft.AspNetCore.Http.IFormFile.Length">
515 Gets the file length in bytes.
518 <member name="P:Microsoft.AspNetCore.Http.IFormFile.Name">
520 Gets the name from the Content-Disposition header.
523 <member name="P:Microsoft.AspNetCore.Http.IFormFile.FileName">
525 Gets the file name from the Content-Disposition header.
528 <member name="M:Microsoft.AspNetCore.Http.IFormFile.OpenReadStream">
530 Opens the request stream for reading the uploaded file.
533 <member name="M:Microsoft.AspNetCore.Http.IFormFile.CopyTo(System.IO.Stream)">
535 Copies the contents of the uploaded file to the <paramref name="target"/> stream.
537 <param name="target">The stream to copy the file contents to.</param>
539 <member name="M:Microsoft.AspNetCore.Http.IFormFile.CopyToAsync(System.IO.Stream,System.Threading.CancellationToken)">
541 Asynchronously copies the contents of the uploaded file to the <paramref name="target"/> stream.
543 <param name="target">The stream to copy the file contents to.</param>
544 <param name="cancellationToken"></param>
546 <member name="T:Microsoft.AspNetCore.Http.IFormFileCollection">
548 Represents the collection of files sent with the HttpRequest.
551 <member name="T:Microsoft.AspNetCore.Http.IHeaderDictionary">
553 Represents HttpRequest and HttpResponse headers
556 <member name="P:Microsoft.AspNetCore.Http.IHeaderDictionary.Item(System.String)">
558 IHeaderDictionary has a different indexer contract than IDictionary, where it will return StringValues.Empty for missing entries.
560 <param name="key"></param>
561 <returns>The stored value, or StringValues.Empty if the key is not present.</returns>
563 <member name="P:Microsoft.AspNetCore.Http.IHeaderDictionary.ContentLength">
565 Strongly typed access to the Content-Length header. Implementations must keep this in sync with the string representation.
568 <member name="T:Microsoft.AspNetCore.Http.IQueryCollection">
570 Represents the HttpRequest query string collection
573 <member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Count">
575 Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
578 The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
581 <member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Keys">
583 Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
584 <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
587 An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
588 that implements <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
591 <member name="M:Microsoft.AspNetCore.Http.IQueryCollection.ContainsKey(System.String)">
593 Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains an element
594 with the specified key.
597 The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" />.
600 true if the <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains an element with
601 the key; otherwise, false.
603 <exception cref="T:System.ArgumentNullException">
607 <member name="M:Microsoft.AspNetCore.Http.IQueryCollection.TryGetValue(System.String,Microsoft.Extensions.Primitives.StringValues@)">
609 Gets the value associated with the specified key.
612 The key of the value to get.
615 The key of the value to get.
616 When this method returns, the value associated with the specified key, if the
617 key is found; otherwise, the default value for the type of the value parameter.
618 This parameter is passed uninitialized.
621 true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> contains
622 an element with the specified key; otherwise, false.
624 <exception cref="T:System.ArgumentNullException">
628 <member name="P:Microsoft.AspNetCore.Http.IQueryCollection.Item(System.String)">
630 Gets the value with the specified key.
633 The key of the value to get.
636 The element with the specified key, or <c>StringValues.Empty</c> if the key is not present.
638 <exception cref="T:System.ArgumentNullException">
642 <see cref="T:Microsoft.AspNetCore.Http.IQueryCollection" /> has a different indexer contract than
643 <see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>StringValues.Empty</c> for missing entries
644 rather than throwing an Exception.
647 <member name="T:Microsoft.AspNetCore.Http.IRequestCookieCollection">
649 Represents the HttpRequest cookie collection
652 <member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Count">
654 Gets the number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
657 The number of elements contained in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
660 <member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Keys">
662 Gets an <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the
663 <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
666 An <see cref="T:System.Collections.Generic.ICollection`1" /> containing the keys of the object
667 that implements <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
670 <member name="M:Microsoft.AspNetCore.Http.IRequestCookieCollection.ContainsKey(System.String)">
672 Determines whether the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains an element
673 with the specified key.
676 The key to locate in the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" />.
679 true if the <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains an element with
680 the key; otherwise, false.
682 <exception cref="T:System.ArgumentNullException">
686 <member name="M:Microsoft.AspNetCore.Http.IRequestCookieCollection.TryGetValue(System.String,System.String@)">
688 Gets the value associated with the specified key.
691 The key of the value to get.
694 The key of the value to get.
695 When this method returns, the value associated with the specified key, if the
696 key is found; otherwise, the default value for the type of the value parameter.
697 This parameter is passed uninitialized.
700 true if the object that implements <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> contains
701 an element with the specified key; otherwise, false.
703 <exception cref="T:System.ArgumentNullException">
707 <member name="P:Microsoft.AspNetCore.Http.IRequestCookieCollection.Item(System.String)">
709 Gets the value with the specified key.
712 The key of the value to get.
715 The element with the specified key, or <c>string.Empty</c> if the key is not present.
717 <exception cref="T:System.ArgumentNullException">
721 <see cref="T:Microsoft.AspNetCore.Http.IRequestCookieCollection" /> has a different indexer contract than
722 <see cref="T:System.Collections.Generic.IDictionary`2" />, as it will return <c>string.Empty</c> for missing entries
723 rather than throwing an Exception.
726 <member name="T:Microsoft.AspNetCore.Http.IResponseCookies">
728 A wrapper for the response Set-Cookie header.
731 <member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Append(System.String,System.String)">
733 Add a new cookie and value.
735 <param name="key">Name of the new cookie.</param>
736 <param name="value">Value of the new cookie.</param>
738 <member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Append(System.String,System.String,Microsoft.AspNetCore.Http.CookieOptions)">
742 <param name="key">Name of the new cookie.</param>
743 <param name="value">Value of the new cookie.</param>
744 <param name="options"><see cref="T:Microsoft.AspNetCore.Http.CookieOptions"/> included in the new cookie setting.</param>
746 <member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Delete(System.String)">
748 Sets an expired cookie.
750 <param name="key">Name of the cookie to expire.</param>
752 <member name="M:Microsoft.AspNetCore.Http.IResponseCookies.Delete(System.String,Microsoft.AspNetCore.Http.CookieOptions)">
754 Sets an expired cookie.
756 <param name="key">Name of the cookie to expire.</param>
757 <param name="options">
758 <see cref="T:Microsoft.AspNetCore.Http.CookieOptions"/> used to discriminate the particular cookie to expire. The
759 <see cref="P:Microsoft.AspNetCore.Http.CookieOptions.Domain"/> and <see cref="P:Microsoft.AspNetCore.Http.CookieOptions.Path"/> values are especially important.
762 <member name="P:Microsoft.AspNetCore.Http.ISession.IsAvailable">
764 Indicate whether the current session has loaded.
767 <member name="P:Microsoft.AspNetCore.Http.ISession.Id">
769 A unique identifier for the current session. This is not the same as the session cookie
770 since the cookie lifetime may not be the same as the session entry lifetime in the data store.
773 <member name="P:Microsoft.AspNetCore.Http.ISession.Keys">
775 Enumerates all the keys, if any.
778 <member name="M:Microsoft.AspNetCore.Http.ISession.LoadAsync(System.Threading.CancellationToken)">
780 Load the session from the data store. This may throw if the data store is unavailable.
784 <member name="M:Microsoft.AspNetCore.Http.ISession.CommitAsync(System.Threading.CancellationToken)">
786 Store the session in the data store. This may throw if the data store is unavailable.
790 <member name="M:Microsoft.AspNetCore.Http.ISession.TryGetValue(System.String,System.Byte[]@)">
792 Retrieve the value of the given key, if present.
794 <param name="key"></param>
795 <param name="value"></param>
798 <member name="M:Microsoft.AspNetCore.Http.ISession.Set(System.String,System.Byte[])">
800 Set the given key and value in the current session. This will throw if the session
801 was not established prior to sending the response.
803 <param name="key"></param>
804 <param name="value"></param>
806 <member name="M:Microsoft.AspNetCore.Http.ISession.Remove(System.String)">
808 Remove the given key from the session if present.
810 <param name="key"></param>
812 <member name="M:Microsoft.AspNetCore.Http.ISession.Clear">
814 Remove all entries from the current session, if any.
815 The session cookie is not removed.