System.Web.Http.Owin.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Web.Http.Owin</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Net.Http.OwinHttpRequestMessageExtensions">
  8. <summary>Provides extension methods for the <see cref="T:System.Net.Http.HttpRequestMessage" /> class.</summary>
  9. </member>
  10. <member name="M:System.Net.Http.OwinHttpRequestMessageExtensions.GetOwinContext(System.Net.Http.HttpRequestMessage)">
  11. <summary>Gets the OWIN context for the specified request.</summary>
  12. <returns>The OWIN environment for the specified context, if available; otherwise <see cref="null" />.</returns>
  13. <param name="request">The HTTP request message.</param>
  14. </member>
  15. <member name="M:System.Net.Http.OwinHttpRequestMessageExtensions.GetOwinEnvironment(System.Net.Http.HttpRequestMessage)">
  16. <summary>Gets the OWIN environment for the specified request.</summary>
  17. <returns>The OWIN environment for the specified request, if available; otherwise <see cref="null" />.</returns>
  18. <param name="request">The HTTP request message.</param>
  19. </member>
  20. <member name="M:System.Net.Http.OwinHttpRequestMessageExtensions.SetOwinContext(System.Net.Http.HttpRequestMessage,Microsoft.Owin.IOwinContext)">
  21. <summary>Sets the OWIN context for the specified request.</summary>
  22. <param name="request">The HTTP request message.</param>
  23. <param name="context">The OWIN context to set.</param>
  24. </member>
  25. <member name="M:System.Net.Http.OwinHttpRequestMessageExtensions.SetOwinEnvironment(System.Net.Http.HttpRequestMessage,System.Collections.Generic.IDictionary{System.String,System.Object})">
  26. <summary>Sets the OWIN environment for the specified request.</summary>
  27. <param name="request">The HTTP request message.</param>
  28. <param name="environment">The OWIN environment to set.</param>
  29. </member>
  30. <member name="T:System.Web.Http.HostAuthenticationAttribute">
  31. <summary>Represents an authentication attribute that authenticates via OWIN middleware.</summary>
  32. </member>
  33. <member name="M:System.Web.Http.HostAuthenticationAttribute.#ctor(System.String)">
  34. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.HostAuthenticationAttribute" /> class.</summary>
  35. <param name="authenticationType">The authentication type of the OWIN middleware to use.</param>
  36. </member>
  37. <member name="P:System.Web.Http.HostAuthenticationAttribute.AllowMultiple"></member>
  38. <member name="M:System.Web.Http.HostAuthenticationAttribute.AuthenticateAsync(System.Web.Http.Filters.HttpAuthenticationContext,System.Threading.CancellationToken)"></member>
  39. <member name="P:System.Web.Http.HostAuthenticationAttribute.AuthenticationType">
  40. <summary>Gets the authentication type of the OWIN middleware to use.</summary>
  41. </member>
  42. <member name="M:System.Web.Http.HostAuthenticationAttribute.ChallengeAsync(System.Web.Http.Filters.HttpAuthenticationChallengeContext,System.Threading.CancellationToken)"></member>
  43. <member name="T:System.Web.Http.HostAuthenticationFilter">
  44. <summary>Represents an authentication filter that authenticates via OWIN middleware.</summary>
  45. </member>
  46. <member name="M:System.Web.Http.HostAuthenticationFilter.#ctor(System.String)">
  47. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.HostAuthenticationFilter" /> class.</summary>
  48. <param name="authenticationType">The authentication type of the OWIN middleware to use.</param>
  49. </member>
  50. <member name="P:System.Web.Http.HostAuthenticationFilter.AllowMultiple">
  51. <summary>Gets a value indicating whether the filter allows multiple authentication.</summary>
  52. <returns>true if the filter allows multiple authentication; otherwise, false.</returns>
  53. </member>
  54. <member name="M:System.Web.Http.HostAuthenticationFilter.AuthenticateAsync(System.Web.Http.Filters.HttpAuthenticationContext,System.Threading.CancellationToken)">
  55. <summary>Asynchronously authenticates the request.</summary>
  56. <returns>The task that completes the authentication.</returns>
  57. <param name="context">The authentication context.</param>
  58. <param name="cancellationToken">The cancellation token.</param>
  59. </member>
  60. <member name="P:System.Web.Http.HostAuthenticationFilter.AuthenticationType">
  61. <summary>Gets the authentication type of the OWIN middleware to use.</summary>
  62. <returns>The authentication type of the OWIN middleware to use.</returns>
  63. </member>
  64. <member name="M:System.Web.Http.HostAuthenticationFilter.ChallengeAsync(System.Web.Http.Filters.HttpAuthenticationChallengeContext,System.Threading.CancellationToken)">
  65. <summary>Asynchronously challenges an authentication.</summary>
  66. <returns>The task that completes the challenge.</returns>
  67. <param name="context">The context.</param>
  68. <param name="cancellationToken">The cancellation token.</param>
  69. </member>
  70. <member name="T:System.Web.Http.OwinHttpConfigurationExtensions">
  71. <summary>Provides extension methods for the <see cref="T:System.Web.Http.HttpConfiguration" /> class.</summary>
  72. </member>
  73. <member name="M:System.Web.Http.OwinHttpConfigurationExtensions.SuppressDefaultHostAuthentication(System.Web.Http.HttpConfiguration)">
  74. <summary>Enables suppression of the host's default authentication.</summary>
  75. <param name="configuration">The server configuration.</param>
  76. </member>
  77. <member name="T:System.Web.Http.Owin.HttpMessageHandlerAdapter">
  78. <summary>Represents an OWIN component that submits requests to an <see cref="T:System.Net.Http.HttpMessageHandler" /> when invoked.</summary>
  79. </member>
  80. <member name="M:System.Web.Http.Owin.HttpMessageHandlerAdapter.#ctor(Microsoft.Owin.OwinMiddleware,System.Net.Http.HttpMessageHandler,System.Web.Http.Hosting.IHostBufferPolicySelector)">
  81. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" /> class.</summary>
  82. <param name="next">The next component in the pipeline.</param>
  83. <param name="messageHandler">The <see cref="T:System.Net.Http.HttpMessageHandler" /> to submit requests to.</param>
  84. <param name="bufferPolicySelector">The <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> that determines whether or not to buffer requests and responses.</param>
  85. </member>
  86. <member name="M:System.Web.Http.Owin.HttpMessageHandlerAdapter.#ctor(Microsoft.Owin.OwinMiddleware,System.Web.Http.Owin.HttpMessageHandlerOptions)">
  87. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" /> class.</summary>
  88. <param name="next">The next component in the pipeline.</param>
  89. <param name="options">The options to configure this adapter.</param>
  90. </member>
  91. <member name="P:System.Web.Http.Owin.HttpMessageHandlerAdapter.AppDisposing">
  92. <summary>Gets the cancellation token that triggers cleanup of this component.</summary>
  93. <returns>The cancellation token.</returns>
  94. </member>
  95. <member name="P:System.Web.Http.Owin.HttpMessageHandlerAdapter.BufferPolicySelector">
  96. <summary>Gets the <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> that determines whether or not to buffer requests and responses.</summary>
  97. <returns>The <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> that determines whether or not to buffer requests and responses.</returns>
  98. </member>
  99. <member name="M:System.Web.Http.Owin.HttpMessageHandlerAdapter.Dispose">
  100. <summary>Releases all resources used by the current instance of the <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" /> class.</summary>
  101. </member>
  102. <member name="M:System.Web.Http.Owin.HttpMessageHandlerAdapter.Dispose(System.Boolean)">
  103. <summary>Releases unmanaged and optionally managed resources.</summary>
  104. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  105. </member>
  106. <member name="P:System.Web.Http.Owin.HttpMessageHandlerAdapter.ExceptionHandler">
  107. <summary>Gets the <see cref="T:System.Web.Http.ExceptionHandling.IExceptionHandler" /> to use to process unhandled exceptions.</summary>
  108. <returns>The <see cref="T:System.Web.Http.ExceptionHandling.IExceptionHandler" /> to use to process unhandled exceptions.</returns>
  109. </member>
  110. <member name="P:System.Web.Http.Owin.HttpMessageHandlerAdapter.ExceptionLogger">
  111. <summary>Gets the <see cref="T:System.Web.Http.ExceptionHandling.IExceptionLogger" /> to use to log unhandled exceptions.</summary>
  112. <returns>The <see cref="T:System.Web.Http.ExceptionHandling.IExceptionLogger" /> to use to log unhandled exceptions.</returns>
  113. </member>
  114. <member name="M:System.Web.Http.Owin.HttpMessageHandlerAdapter.Invoke(Microsoft.Owin.IOwinContext)">
  115. <returns>Returns <see cref="T:System.Threading.Tasks.Task" />.</returns>
  116. </member>
  117. <member name="P:System.Web.Http.Owin.HttpMessageHandlerAdapter.MessageHandler">
  118. <summary>Gets the <see cref="T:System.Net.Http.HttpMessageHandler" /> to submit requests to.</summary>
  119. <returns>The <see cref="T:System.Net.Http.HttpMessageHandler" /> to submit requests to.</returns>
  120. </member>
  121. <member name="T:System.Web.Http.Owin.HttpMessageHandlerOptions">
  122. <summary>Represents the options for configuring an <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" />.</summary>
  123. </member>
  124. <member name="M:System.Web.Http.Owin.HttpMessageHandlerOptions.#ctor">
  125. <summary>Initializes a new instance of the<see cref="T:System.Web.Http.Owin.HttpMessageHandlerOptions" /> class.</summary>
  126. </member>
  127. <member name="P:System.Web.Http.Owin.HttpMessageHandlerOptions.AppDisposing">
  128. <summary>Gets or sets the <see cref="T:System.Threading.CancellationToken" /> that triggers cleanup of the <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" />.</summary>
  129. <returns>The <see cref="T:System.Threading.CancellationToken" /> that triggers cleanup of the <see cref="T:System.Web.Http.Owin.HttpMessageHandlerAdapter" />.</returns>
  130. </member>
  131. <member name="P:System.Web.Http.Owin.HttpMessageHandlerOptions.BufferPolicySelector">
  132. <summary>Gets or sets the <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> that determines whether or not to buffer requests and responses.</summary>
  133. <returns>The <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> that determines whether or not to buffer requests and responses.</returns>
  134. </member>
  135. <member name="P:System.Web.Http.Owin.HttpMessageHandlerOptions.ExceptionHandler">
  136. <summary>Gets or sets the <see cref="T:System.Web.Http.ExceptionHandling.IExceptionHandler" /> to use to process unhandled exceptions.</summary>
  137. <returns>The <see cref="T:System.Web.Http.ExceptionHandling.IExceptionHandler" /> to use to process unhandled exceptions.</returns>
  138. </member>
  139. <member name="P:System.Web.Http.Owin.HttpMessageHandlerOptions.ExceptionLogger">
  140. <summary>Gets or sets the <see cref="T:System.Web.Http.ExceptionHandling.IExceptionLogger" /> to use to log unhandled exceptions.</summary>
  141. <returns>The <see cref="T:System.Web.Http.ExceptionHandling.IExceptionLogger" /> to use to log unhandled exceptions.</returns>
  142. </member>
  143. <member name="P:System.Web.Http.Owin.HttpMessageHandlerOptions.MessageHandler">
  144. <summary>Gets or sets the <see cref="T:System.Net.Http.HttpMessageHandler" /> to submit requests to.</summary>
  145. <returns>The <see cref="T:System.Net.Http.HttpMessageHandler" /> to submit requests to.</returns>
  146. </member>
  147. <member name="T:System.Web.Http.Owin.OwinBufferPolicySelector">
  148. <summary>Provides the default implementation of <see cref="T:System.Web.Http.Hosting.IHostBufferPolicySelector" /> used by the OWIN Web API adapter.</summary>
  149. </member>
  150. <member name="M:System.Web.Http.Owin.OwinBufferPolicySelector.#ctor">
  151. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Owin.OwinBufferPolicySelector" /> class.</summary>
  152. </member>
  153. <member name="M:System.Web.Http.Owin.OwinBufferPolicySelector.UseBufferedInputStream(System.Object)">
  154. <summary>Determines whether the host should buffer the HttpRequestMessage entity body.</summary>
  155. <returns>true if buffering should be used; otherwise a streamed request should be used.</returns>
  156. <param name="hostContext">The host context.</param>
  157. </member>
  158. <member name="M:System.Web.Http.Owin.OwinBufferPolicySelector.UseBufferedOutputStream(System.Net.Http.HttpResponseMessage)">
  159. <summary>Determines whether the host should buffer the HttpResponseMessage entity body.</summary>
  160. <returns>true if buffering should be used; otherwise a streamed response should be used.</returns>
  161. <param name="response">The response.</param>
  162. </member>
  163. <member name="T:System.Web.Http.Owin.OwinExceptionCatchBlocks">
  164. <summary>Provides the catch blocks used within this assembly.</summary>
  165. </member>
  166. <member name="P:System.Web.Http.Owin.OwinExceptionCatchBlocks.HttpMessageHandlerAdapterBufferContent">
  167. <summary>Gets the catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.BufferContent.</summary>
  168. <returns>The catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.BufferContent.</returns>
  169. </member>
  170. <member name="P:System.Web.Http.Owin.OwinExceptionCatchBlocks.HttpMessageHandlerAdapterBufferError">
  171. <summary>Gets the catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.BufferError.</summary>
  172. <returns>The catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.BufferError.</returns>
  173. </member>
  174. <member name="P:System.Web.Http.Owin.OwinExceptionCatchBlocks.HttpMessageHandlerAdapterComputeContentLength">
  175. <summary>Gets the catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.ComputeContentLength.</summary>
  176. <returns>The catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.ComputeContentLength.</returns>
  177. </member>
  178. <member name="P:System.Web.Http.Owin.OwinExceptionCatchBlocks.HttpMessageHandlerAdapterStreamContent">
  179. <summary>Gets the catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.StreamContent.</summary>
  180. <returns>The catch block in System.Web.Http.Owin.HttpMessageHandlerAdapter.StreamContent.</returns>
  181. </member>
  182. <member name="T:System.Web.Http.Owin.PassiveAuthenticationMessageHandler">
  183. <summary>Represents a message handler that treats all OWIN authentication middleware as passive.</summary>
  184. </member>
  185. <member name="M:System.Web.Http.Owin.PassiveAuthenticationMessageHandler.#ctor">
  186. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Owin.PassiveAuthenticationMessageHandler" /> class.</summary>
  187. </member>
  188. <member name="M:System.Web.Http.Owin.PassiveAuthenticationMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  189. <summary>Asynchronously sends a message request.</summary>
  190. <returns>The task that completes the asynchronous operation.</returns>
  191. <param name="request">The message request.</param>
  192. <param name="cancellationToken">The cancellation token.</param>
  193. </member>
  194. </members>
  195. </doc>