review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.AspNetCore.Http.Extensions</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="M:Microsoft.AspNetCore.Http.HttpContextServerVariableExtensions.GetServerVariable(Microsoft.AspNetCore.Http.HttpContext,System.String)">\r
   8             <summary>\r
   9             Gets the value of a server variable for the current request.\r
  10             </summary>\r
  11             <param name="context">The http context for the request.</param>\r
  12             <param name="variableName">The name of the variable.</param>\r
  13             <returns>\r
  14             <c>null</c> if the server does not support the <see cref="T:Microsoft.AspNetCore.Http.Features.IServerVariablesFeature"/> feature.\r
  15             May return null or empty if the variable does not exist or is not set.\r
  16             </returns>\r
  17         </member>\r
  18         <member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Threading.CancellationToken)">\r
  19             <summary>Asynchronously reads the given number of bytes from the source stream and writes them to another stream.</summary>\r
  20             <returns>A task that represents the asynchronous copy operation.</returns>\r
  21             <param name="source">The stream from which the contents will be copied.</param>\r
  22             <param name="destination">The stream to which the contents of the current stream will be copied.</param>\r
  23             <param name="count">The count of bytes to be copied.</param>\r
  24             <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>\r
  25         </member>\r
  26         <member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Int32,System.Threading.CancellationToken)">\r
  27             <summary>Asynchronously reads the given number of bytes from the source stream and writes them to another stream, using a specified buffer size.</summary>\r
  28             <returns>A task that represents the asynchronous copy operation.</returns>\r
  29             <param name="source">The stream from which the contents will be copied.</param>\r
  30             <param name="destination">The stream to which the contents of the current stream will be copied.</param>\r
  31             <param name="count">The count of bytes to be copied.</param>\r
  32             <param name="bufferSize">The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.</param>\r
  33             <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>\r
  34         </member>\r
  35         <member name="T:Microsoft.AspNetCore.Http.Extensions.UriHelper">\r
  36             <summary>\r
  37             A helper class for constructing encoded Uris for use in headers and other Uris.\r
  38             </summary>\r
  39         </member>\r
  40         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.BuildRelative(Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.QueryString,Microsoft.AspNetCore.Http.FragmentString)">\r
  41             <summary>\r
  42             Combines the given URI components into a string that is properly encoded for use in HTTP headers.\r
  43             </summary>\r
  44             <param name="pathBase">The first portion of the request path associated with application root.</param>\r
  45             <param name="path">The portion of the request path that identifies the requested resource.</param>\r
  46             <param name="query">The query, if any.</param>\r
  47             <param name="fragment">The fragment, if any.</param>\r
  48             <returns>The combined URI components, properly encoded for use in HTTP headers.</returns>\r
  49         </member>\r
  50         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.BuildAbsolute(System.String,Microsoft.AspNetCore.Http.HostString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.QueryString,Microsoft.AspNetCore.Http.FragmentString)">\r
  51             <summary>\r
  52             Combines the given URI components into a string that is properly encoded for use in HTTP headers.\r
  53             Note that unicode in the HostString will be encoded as punycode.\r
  54             </summary>\r
  55             <param name="scheme">http, https, etc.</param>\r
  56             <param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>\r
  57             <param name="pathBase">The first portion of the request path associated with application root.</param>\r
  58             <param name="path">The portion of the request path that identifies the requested resource.</param>\r
  59             <param name="query">The query, if any.</param>\r
  60             <param name="fragment">The fragment, if any.</param>\r
  61             <returns>The combined URI components, properly encoded for use in HTTP headers.</returns>\r
  62         </member>\r
  63         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.FromAbsolute(System.String,System.String@,Microsoft.AspNetCore.Http.HostString@,Microsoft.AspNetCore.Http.PathString@,Microsoft.AspNetCore.Http.QueryString@,Microsoft.AspNetCore.Http.FragmentString@)">\r
  64             <summary>\r
  65             Separates the given absolute URI string into components. Assumes no PathBase.\r
  66             </summary>\r
  67             <param name="uri">A string representation of the uri.</param>\r
  68             <param name="scheme">http, https, etc.</param>\r
  69             <param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>\r
  70             <param name="path">The portion of the request path that identifies the requested resource.</param>\r
  71             <param name="query">The query, if any.</param>\r
  72             <param name="fragment">The fragment, if any.</param>\r
  73         </member>\r
  74         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.Encode(System.Uri)">\r
  75             <summary>\r
  76             Generates a string from the given absolute or relative Uri that is appropriately encoded for use in\r
  77             HTTP headers. Note that a unicode host name will be encoded as punycode.\r
  78             </summary>\r
  79             <param name="uri">The Uri to encode.</param>\r
  80             <returns>The encoded string version of <paramref name="uri"/>.</returns>\r
  81         </member>\r
  82         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedUrl(Microsoft.AspNetCore.Http.HttpRequest)">\r
  83             <summary>\r
  84             Returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers\r
  85             and other HTTP operations.\r
  86             </summary>\r
  87             <param name="request">The request to assemble the uri pieces from.</param>\r
  88             <returns>The encoded string version of the URL from <paramref name="request"/>.</returns>\r
  89         </member>\r
  90         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedPathAndQuery(Microsoft.AspNetCore.Http.HttpRequest)">\r
  91             <summary>\r
  92             Returns the relative URI.\r
  93             </summary>\r
  94             <param name="request">The request to assemble the uri pieces from.</param>\r
  95             <returns>The path and query off of <paramref name="request"/>.</returns>\r
  96         </member>\r
  97         <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetDisplayUrl(Microsoft.AspNetCore.Http.HttpRequest)">\r
  98             <summary>\r
  99             Returns the combined components of the request URL in a fully un-escaped form (except for the QueryString)\r
 100             suitable only for display. This format should not be used in HTTP headers or other HTTP operations.\r
 101             </summary>\r
 102             <param name="request">The request to assemble the uri pieces from.</param>\r
 103             <returns>The combined components of the request URL in a fully un-escaped form (except for the QueryString)\r
 104             suitable only for display.</returns>\r
 105         </member>\r
 106         <member name="M:Microsoft.AspNetCore.Http.ResponseExtensions.Redirect(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Boolean,System.Boolean)">\r
 107             <summary>\r
 108             Returns a redirect response (HTTP 301, HTTP 302, HTTP 307 or HTTP 308) to the client.\r
 109             </summary>\r
 110             <param name="response">The <see cref="T:Microsoft.AspNetCore.Http.HttpResponse"/> to redirect.</param>\r
 111             <param name="location">The URL to redirect the client to. This must be properly encoded for use in http headers where only ASCII characters are allowed.</param>\r
 112             <param name="permanent"><c>True</c> if the redirect is permanent (301 or 308), otherwise <c>false</c> (302 or 307).</param>\r
 113             <param name="preserveMethod"><c>True</c> if the redirect needs to reuse the method and body (308 or 307), otherwise <c>false</c> (301 or 302).</param>\r
 114         </member>\r
 115         <member name="T:Microsoft.AspNetCore.Http.SendFileResponseExtensions">\r
 116             <summary>\r
 117             Provides extensions for HttpResponse exposing the SendFile extension.\r
 118             </summary>\r
 119         </member>\r
 120         <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,Microsoft.Extensions.FileProviders.IFileInfo,System.Threading.CancellationToken)">\r
 121             <summary>\r
 122             Sends the given file using the SendFile extension.\r
 123             </summary>\r
 124             <param name="response"></param>\r
 125             <param name="file">The file.</param>\r
 126             <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>\r
 127         </member>\r
 128         <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,Microsoft.Extensions.FileProviders.IFileInfo,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">\r
 129             <summary>\r
 130             Sends the given file using the SendFile extension.\r
 131             </summary>\r
 132             <param name="response"></param>\r
 133             <param name="file">The file.</param>\r
 134             <param name="offset">The offset in the file.</param>\r
 135             <param name="count">The number of bytes to send, or null to send the remainder of the file.</param>\r
 136             <param name="cancellationToken"></param>\r
 137             <returns></returns>\r
 138         </member>\r
 139         <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Threading.CancellationToken)">\r
 140             <summary>\r
 141             Sends the given file using the SendFile extension.\r
 142             </summary>\r
 143             <param name="response"></param>\r
 144             <param name="fileName">The full path to the file.</param>\r
 145             <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>\r
 146             <returns></returns>\r
 147         </member>\r
 148         <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">\r
 149             <summary>\r
 150             Sends the given file using the SendFile extension.\r
 151             </summary>\r
 152             <param name="response"></param>\r
 153             <param name="fileName">The full path to the file.</param>\r
 154             <param name="offset">The offset in the file.</param>\r
 155             <param name="count">The number of bytes to send, or null to send the remainder of the file.</param>\r
 156             <param name="cancellationToken"></param>\r
 157             <returns></returns>\r
 158         </member>\r
 159         <member name="M:Microsoft.AspNetCore.Http.StreamCopyOperationInternal.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Threading.CancellationToken)">\r
 160             <summary>Asynchronously reads the given number of bytes from the source stream and writes them to another stream.</summary>\r
 161             <returns>A task that represents the asynchronous copy operation.</returns>\r
 162             <param name="source">The stream from which the contents will be copied.</param>\r
 163             <param name="destination">The stream to which the contents of the current stream will be copied.</param>\r
 164             <param name="count">The count of bytes to be copied.</param>\r
 165             <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>\r
 166         </member>\r
 167         <member name="M:Microsoft.AspNetCore.Http.StreamCopyOperationInternal.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Int32,System.Threading.CancellationToken)">\r
 168             <summary>Asynchronously reads the given number of bytes from the source stream and writes them to another stream, using a specified buffer size.</summary>\r
 169             <returns>A task that represents the asynchronous copy operation.</returns>\r
 170             <param name="source">The stream from which the contents will be copied.</param>\r
 171             <param name="destination">The stream to which the contents of the current stream will be copied.</param>\r
 172             <param name="count">The count of bytes to be copied.</param>\r
 173             <param name="bufferSize">The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.</param>\r
 174             <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>\r
 175         </member>\r
 176     </members>\r
 177 </doc>\r