Microsoft.AspNetCore.Http.Extensions.xml 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNetCore.Http.Extensions</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Threading.CancellationToken)">
  8. <summary>Asynchronously reads the bytes from the source stream and writes them to another stream.</summary>
  9. <returns>A task that represents the asynchronous copy operation.</returns>
  10. <param name="source">The stream from which the contents will be copied.</param>
  11. <param name="destination">The stream to which the contents of the current stream will be copied.</param>
  12. <param name="count">The count of bytes to be copied.</param>
  13. <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  14. </member>
  15. <member name="M:Microsoft.AspNetCore.Http.Extensions.StreamCopyOperation.CopyToAsync(System.IO.Stream,System.IO.Stream,System.Nullable{System.Int64},System.Int32,System.Threading.CancellationToken)">
  16. <summary>Asynchronously reads the bytes from the source stream and writes them to another stream, using a specified buffer size.</summary>
  17. <returns>A task that represents the asynchronous copy operation.</returns>
  18. <param name="source">The stream from which the contents will be copied.</param>
  19. <param name="destination">The stream to which the contents of the current stream will be copied.</param>
  20. <param name="count">The count of bytes to be copied.</param>
  21. <param name="bufferSize">The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.</param>
  22. <param name="cancel">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
  23. </member>
  24. <member name="T:Microsoft.AspNetCore.Http.Extensions.UriHelper">
  25. <summary>
  26. A helper class for constructing encoded Uris for use in headers and other Uris.
  27. </summary>
  28. </member>
  29. <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)">
  30. <summary>
  31. Combines the given URI components into a string that is properly encoded for use in HTTP headers.
  32. </summary>
  33. <param name="pathBase">The first portion of the request path associated with application root.</param>
  34. <param name="path">The portion of the request path that identifies the requested resource.</param>
  35. <param name="query">The query, if any.</param>
  36. <param name="fragment">The fragment, if any.</param>
  37. <returns></returns>
  38. </member>
  39. <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)">
  40. <summary>
  41. Combines the given URI components into a string that is properly encoded for use in HTTP headers.
  42. Note that unicode in the HostString will be encoded as punycode.
  43. </summary>
  44. <param name="scheme">http, https, etc.</param>
  45. <param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>
  46. <param name="pathBase">The first portion of the request path associated with application root.</param>
  47. <param name="path">The portion of the request path that identifies the requested resource.</param>
  48. <param name="query">The query, if any.</param>
  49. <param name="fragment">The fragment, if any.</param>
  50. <returns></returns>
  51. </member>
  52. <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@)">
  53. <summary>
  54. Separates the given absolute URI string into components. Assumes no PathBase.
  55. </summary>
  56. <param name="uri">A string representation of the uri.</param>
  57. <param name="scheme">http, https, etc.</param>
  58. <param name="host">The host portion of the uri normally included in the Host header. This may include the port.</param>
  59. <param name="path">The portion of the request path that identifies the requested resource.</param>
  60. <param name="query">The query, if any.</param>
  61. <param name="fragment">The fragment, if any.</param>
  62. </member>
  63. <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.Encode(System.Uri)">
  64. <summary>
  65. Generates a string from the given absolute or relative Uri that is appropriately encoded for use in
  66. HTTP headers. Note that a unicode host name will be encoded as punycode.
  67. </summary>
  68. <param name="uri">The Uri to encode.</param>
  69. <returns></returns>
  70. </member>
  71. <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedUrl(Microsoft.AspNetCore.Http.HttpRequest)">
  72. <summary>
  73. Returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers
  74. and other HTTP operations.
  75. </summary>
  76. <param name="request">The request to assemble the uri pieces from.</param>
  77. <returns></returns>
  78. </member>
  79. <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetEncodedPathAndQuery(Microsoft.AspNetCore.Http.HttpRequest)">
  80. <summary>
  81. Returns the relative url
  82. </summary>
  83. <param name="request">The request to assemble the uri pieces from.</param>
  84. <returns></returns>
  85. </member>
  86. <member name="M:Microsoft.AspNetCore.Http.Extensions.UriHelper.GetDisplayUrl(Microsoft.AspNetCore.Http.HttpRequest)">
  87. <summary>
  88. Returns the combined components of the request URL in a fully un-escaped form (except for the QueryString)
  89. suitable only for display. This format should not be used in HTTP headers or other HTTP operations.
  90. </summary>
  91. <param name="request">The request to assemble the uri pieces from.</param>
  92. <returns></returns>
  93. </member>
  94. <member name="T:Microsoft.AspNetCore.Http.SendFileResponseExtensions">
  95. <summary>
  96. Provides extensions for HttpResponse exposing the SendFile extension.
  97. </summary>
  98. </member>
  99. <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,Microsoft.Extensions.FileProviders.IFileInfo,System.Threading.CancellationToken)">
  100. <summary>
  101. Sends the given file using the SendFile extension.
  102. </summary>
  103. <param name="response"></param>
  104. <param name="file">The file.</param>
  105. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
  106. </member>
  107. <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)">
  108. <summary>
  109. Sends the given file using the SendFile extension.
  110. </summary>
  111. <param name="response"></param>
  112. <param name="file">The file.</param>
  113. <param name="offset">The offset in the file.</param>
  114. <param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
  115. <param name="cancellationToken"></param>
  116. <returns></returns>
  117. </member>
  118. <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Threading.CancellationToken)">
  119. <summary>
  120. Sends the given file using the SendFile extension.
  121. </summary>
  122. <param name="response"></param>
  123. <param name="fileName">The full path to the file.</param>
  124. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
  125. <returns></returns>
  126. </member>
  127. <member name="M:Microsoft.AspNetCore.Http.SendFileResponseExtensions.SendFileAsync(Microsoft.AspNetCore.Http.HttpResponse,System.String,System.Int64,System.Nullable{System.Int64},System.Threading.CancellationToken)">
  128. <summary>
  129. Sends the given file using the SendFile extension.
  130. </summary>
  131. <param name="response"></param>
  132. <param name="fileName">The full path to the file.</param>
  133. <param name="offset">The offset in the file.</param>
  134. <param name="count">The number of bytes to send, or null to send the remainder of the file.</param>
  135. <param name="cancellationToken"></param>
  136. <returns></returns>
  137. </member>
  138. </members>
  139. </doc>