System.Web.Http.Cors.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>System.Web.Http.Cors</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Web.Http.CorsHttpConfigurationExtensions">
  8. <summary>CORS-related extension methods for <see cref="T:System.Web.Http.HttpConfiguration" />.</summary>
  9. </member>
  10. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.EnableCors(System.Web.Http.HttpConfiguration)">
  11. <summary>Enables the support for CORS.</summary>
  12. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  13. </member>
  14. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.EnableCors(System.Web.Http.HttpConfiguration,System.Web.Http.Cors.ICorsPolicyProvider)">
  15. <summary>Enables the support for CORS.</summary>
  16. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  17. <param name="defaultPolicyProvider">The default <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</param>
  18. <exception cref="T:System.ArgumentNullException">httpConfiguration</exception>
  19. </member>
  20. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.GetCorsEngine(System.Web.Http.HttpConfiguration)">
  21. <summary>Gets the <see cref="T:System.Web.Cors.ICorsEngine" /> from the <see cref="T:System.Web.Http.HttpConfiguration" />.</summary>
  22. <returns>The <see cref="T:System.Web.Cors.ICorsEngine" />.</returns>
  23. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  24. <exception cref="T:System.ArgumentNullException">httpConfiguration</exception>
  25. </member>
  26. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.GetCorsPolicyProviderFactory(System.Web.Http.HttpConfiguration)">
  27. <summary>Gets the <see cref="T:System.Web.Http.Cors.ICorsPolicyProviderFactory" /> from the <see cref="T:System.Web.Http.HttpConfiguration" />.</summary>
  28. <returns>The <see cref="T:System.Web.Http.Cors.ICorsPolicyProviderFactory" />.</returns>
  29. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  30. <exception cref="T:System.ArgumentNullException">httpConfiguration</exception>
  31. </member>
  32. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.SetCorsEngine(System.Web.Http.HttpConfiguration,System.Web.Cors.ICorsEngine)">
  33. <summary>Sets the <see cref="T:System.Web.Cors.ICorsEngine" /> on the <see cref="T:System.Web.Http.HttpConfiguration" />.</summary>
  34. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  35. <param name="corsEngine">The <see cref="T:System.Web.Cors.ICorsEngine" />.</param>
  36. <exception cref="T:System.ArgumentNullException">httpConfiguration or corsEngine</exception>
  37. </member>
  38. <member name="M:System.Web.Http.CorsHttpConfigurationExtensions.SetCorsPolicyProviderFactory(System.Web.Http.HttpConfiguration,System.Web.Http.Cors.ICorsPolicyProviderFactory)">
  39. <summary>Sets the <see cref="T:System.Web.Http.Cors.ICorsPolicyProviderFactory" /> on the <see cref="T:System.Web.Http.HttpConfiguration" />.</summary>
  40. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  41. <param name="corsPolicyProviderFactory">The <see cref="T:System.Web.Http.Cors.ICorsPolicyProviderFactory" />.</param>
  42. <exception cref="T:System.ArgumentNullException">httpConfiguration or corsPolicyProviderFactory</exception>
  43. </member>
  44. <member name="T:System.Web.Http.Cors.AttributeBasedPolicyProviderFactory">
  45. <summary>An implementation of <see cref="T:System.Web.Http.Cors.ICorsPolicyProviderFactory" /> that returns the <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" /> from the controller or action attribute.</summary>
  46. </member>
  47. <member name="M:System.Web.Http.Cors.AttributeBasedPolicyProviderFactory.#ctor">
  48. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Cors.AttributeBasedPolicyProviderFactory" /> class.</summary>
  49. </member>
  50. <member name="P:System.Web.Http.Cors.AttributeBasedPolicyProviderFactory.DefaultPolicyProvider">
  51. <summary>Gets or sets the default <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</summary>
  52. <returns>The default <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</returns>
  53. </member>
  54. <member name="M:System.Web.Http.Cors.AttributeBasedPolicyProviderFactory.GetCorsPolicyProvider(System.Net.Http.HttpRequestMessage)">
  55. <summary>Gets the <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" /> for the request.</summary>
  56. <returns>The <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</returns>
  57. <param name="request">The request.</param>
  58. <exception cref="T:System.ArgumentNullException">request</exception>
  59. </member>
  60. <member name="T:System.Web.Http.Cors.CorsHttpRequestMessageExtensions">
  61. <summary>CORS-related extension methods for <see cref="T:System.Net.Http.HttpRequestMessage" />.</summary>
  62. </member>
  63. <member name="M:System.Web.Http.Cors.CorsHttpRequestMessageExtensions.GetCorsRequestContext(System.Net.Http.HttpRequestMessage)">
  64. <summary>Gets the <see cref="T:System.Web.Cors.CorsRequestContext" /> for a given request.</summary>
  65. <returns>The <see cref="T:System.Web.Cors.CorsRequestContext" />.</returns>
  66. <param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage" />.</param>
  67. <exception cref="T:System.ArgumentNullException">request</exception>
  68. </member>
  69. <member name="T:System.Web.Http.Cors.CorsHttpResponseMessageExtensions">
  70. <summary>CORS-related extension methods for <see cref="T:System.Net.Http.HttpResponseMessage" />.</summary>
  71. </member>
  72. <member name="M:System.Web.Http.Cors.CorsHttpResponseMessageExtensions.WriteCorsHeaders(System.Net.Http.HttpResponseMessage,System.Web.Cors.CorsResult)">
  73. <summary>Writes the CORS headers on the response.</summary>
  74. <param name="response">The <see cref="T:System.Net.Http.HttpResponseMessage" />.</param>
  75. <param name="corsResult">The <see cref="T:System.Web.Cors.CorsResult" />.</param>
  76. <exception cref="T:System.ArgumentNullException">response or corsResult</exception>
  77. </member>
  78. <member name="T:System.Web.Http.Cors.CorsMessageHandler">
  79. <summary>Custom <see cref="T:System.Net.Http.DelegatingHandler" /> for handling CORS requests.</summary>
  80. </member>
  81. <member name="M:System.Web.Http.Cors.CorsMessageHandler.#ctor(System.Web.Http.HttpConfiguration)">
  82. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Cors.CorsMessageHandler" /> class.</summary>
  83. <param name="httpConfiguration">The <see cref="T:System.Web.Http.HttpConfiguration" />.</param>
  84. <exception cref="T:System.ArgumentNullException">httpConfiguration</exception>
  85. </member>
  86. <member name="M:System.Web.Http.Cors.CorsMessageHandler.HandleCorsPreflightRequestAsync(System.Net.Http.HttpRequestMessage,System.Web.Cors.CorsRequestContext,System.Threading.CancellationToken)">
  87. <summary>Handles the preflight request specified by CORS.</summary>
  88. <returns>The <see cref="T:System.Threading.Tasks.Task`1" /></returns>
  89. <param name="request">The request.</param>
  90. <param name="corsRequestContext">The cors request context.</param>
  91. <param name="cancellationToken">The cancellation token.</param>
  92. <exception cref="T:System.ArgumentNullException">request or corsRequestContext</exception>
  93. </member>
  94. <member name="M:System.Web.Http.Cors.CorsMessageHandler.HandleCorsRequestAsync(System.Net.Http.HttpRequestMessage,System.Web.Cors.CorsRequestContext,System.Threading.CancellationToken)">
  95. <summary>Handles the actual CORS request.</summary>
  96. <returns>The <see cref="T:System.Threading.Tasks.Task`1" />.</returns>
  97. <param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage" />.</param>
  98. <param name="corsRequestContext">The <see cref="T:System.Web.Cors.CorsRequestContext" />.</param>
  99. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" />.</param>
  100. <exception cref="T:System.ArgumentNullException">request or corsRequestContext</exception>
  101. </member>
  102. <member name="M:System.Web.Http.Cors.CorsMessageHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  103. <summary>Sends an HTTP request to the inner handler to send to the server as an asynchronous operation.</summary>
  104. <returns>Returns <see cref="T:System.Threading.Tasks.Task`1" />. The task object representing the asynchronous operation.</returns>
  105. <param name="request">The HTTP request message to send to the server.</param>
  106. <param name="cancellationToken">A cancellation token to cancel operation.</param>
  107. </member>
  108. <member name="T:System.Web.Http.Cors.DisableCorsAttribute">
  109. <summary>This class defines an attribute that can be applied to an action or a controller to disable CORS.</summary>
  110. </member>
  111. <member name="M:System.Web.Http.Cors.DisableCorsAttribute.#ctor">
  112. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Cors.DisableCorsAttribute" /> class.</summary>
  113. </member>
  114. <member name="M:System.Web.Http.Cors.DisableCorsAttribute.GetCorsPolicyAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  115. <summary>Gets the CORS policy asynchronously.</summary>
  116. <returns>The newly created task for this operation.</returns>
  117. <param name="request">The request.</param>
  118. <param name="cancellationToken">The cancellation token assigned for this task.</param>
  119. </member>
  120. <member name="T:System.Web.Http.Cors.EnableCorsAttribute">
  121. <summary>This class defines an attribute that can be applied to an action or a controller to enable CORS. By default, it allows all origins, methods and headers.</summary>
  122. </member>
  123. <member name="M:System.Web.Http.Cors.EnableCorsAttribute.#ctor(System.String,System.String,System.String)">
  124. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Cors.EnableCorsAttribute" /> class.</summary>
  125. <param name="origins">Comma-separated list of origins that are allowed to access the resource. Use "*" to allow all.</param>
  126. <param name="headers">Comma-separated list of headers that are supported by the resource. Use "*" to allow all. Use null or empty string to allow none.</param>
  127. <param name="methods">Comma-separated list of methods that are supported by the resource. Use "*" to allow all. Use null or empty string to allow none.</param>
  128. </member>
  129. <member name="M:System.Web.Http.Cors.EnableCorsAttribute.#ctor(System.String,System.String,System.String,System.String)">
  130. <summary>Initializes a new instance of the <see cref="T:System.Web.Http.Cors.EnableCorsAttribute" /> class.</summary>
  131. <param name="origins">Comma-separated list of origins that are allowed to access the resource. Use "*" to allow all.</param>
  132. <param name="headers">Comma-separated list of headers that are supported by the resource. Use "*" to allow all. Use null or empty string to allow none.</param>
  133. <param name="methods">Comma-separated list of methods that are supported by the resource. Use "*" to allow all. Use null or empty string to allow none.</param>
  134. <param name="exposedHeaders">Comma-separated list of headers that the resource might use and can be exposed. Use null or empty string to expose none.</param>
  135. </member>
  136. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.ExposedHeaders">
  137. <summary>Gets the headers that the resource might use and can be exposed.</summary>
  138. </member>
  139. <member name="M:System.Web.Http.Cors.EnableCorsAttribute.GetCorsPolicyAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)"></member>
  140. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.Headers">
  141. <summary>Gets the headers that are supported by the resource.</summary>
  142. </member>
  143. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.Methods">
  144. <summary>Gets the methods that are supported by the resource.</summary>
  145. </member>
  146. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.Origins">
  147. <summary>Gets the origins that are allowed to access the resource.</summary>
  148. </member>
  149. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.PreflightMaxAge">
  150. <summary>Gets or sets the number of seconds the results of a preflight request can be cached.</summary>
  151. </member>
  152. <member name="P:System.Web.Http.Cors.EnableCorsAttribute.SupportsCredentials">
  153. <summary>Gets or sets a value indicating whether the resource supports user credentials in the request.</summary>
  154. </member>
  155. <member name="T:System.Web.Http.Cors.ICorsPolicyProvider">
  156. <summary>Provides an abstraction for getting the <see cref="T:System.Web.Cors.CorsPolicy" />.</summary>
  157. </member>
  158. <member name="M:System.Web.Http.Cors.ICorsPolicyProvider.GetCorsPolicyAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
  159. <summary>Gets the <see cref="T:System.Web.Cors.CorsPolicy" />.</summary>
  160. <returns>The <see cref="T:System.Web.Cors.CorsPolicy" />.</returns>
  161. <param name="request">The request.</param>
  162. <param name="cancellationToken">The cancellation token.</param>
  163. </member>
  164. <member name="T:System.Web.Http.Cors.ICorsPolicyProviderFactory">
  165. <summary>Provides an abstraction for getting the <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</summary>
  166. </member>
  167. <member name="M:System.Web.Http.Cors.ICorsPolicyProviderFactory.GetCorsPolicyProvider(System.Net.Http.HttpRequestMessage)">
  168. <summary>Gets the <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" /> for the request.</summary>
  169. <returns>The <see cref="T:System.Web.Http.Cors.ICorsPolicyProvider" />.</returns>
  170. <param name="request">The request.</param>
  171. </member>
  172. <member name="T:System.Web.Http.Cors.Tracing.TraceCategories">
  173. <summary>Category names traced by the default CORS tracing implementation.</summary>
  174. </member>
  175. <member name="F:System.Web.Http.Cors.Tracing.TraceCategories.CorsCategory">
  176. <summary>The trace category for CORS-related events.</summary>
  177. </member>
  178. </members>
  179. </doc>