Microsoft.Net.Http.Headers.xml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Net.Http.Headers</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Microsoft.Net.Http.Headers.ContentDispositionHeaderValue.SetHttpFileName(Microsoft.Extensions.Primitives.StringSegment)">
  8. <summary>
  9. Sets both FileName and FileNameStar using encodings appropriate for HTTP headers.
  10. </summary>
  11. <param name="fileName"></param>
  12. </member>
  13. <member name="M:Microsoft.Net.Http.Headers.ContentDispositionHeaderValue.SetMimeFileName(Microsoft.Extensions.Primitives.StringSegment)">
  14. <summary>
  15. Sets the FileName parameter using encodings appropriate for MIME headers.
  16. The FileNameStar parameter is removed.
  17. </summary>
  18. <param name="fileName"></param>
  19. </member>
  20. <member name="T:Microsoft.Net.Http.Headers.ContentDispositionHeaderValueIdentityExtensions">
  21. <summary>
  22. Various extension methods for <see cref="T:Microsoft.Net.Http.Headers.ContentDispositionHeaderValue"/> for identifying the type of the disposition header
  23. </summary>
  24. </member>
  25. <member name="M:Microsoft.Net.Http.Headers.ContentDispositionHeaderValueIdentityExtensions.IsFileDisposition(Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
  26. <summary>
  27. Checks if the content disposition header is a file disposition
  28. </summary>
  29. <param name="header">The header to check</param>
  30. <returns>True if the header is file disposition, false otherwise</returns>
  31. </member>
  32. <member name="M:Microsoft.Net.Http.Headers.ContentDispositionHeaderValueIdentityExtensions.IsFormDisposition(Microsoft.Net.Http.Headers.ContentDispositionHeaderValue)">
  33. <summary>
  34. Checks if the content disposition header is a form disposition
  35. </summary>
  36. <param name="header">The header to check</param>
  37. <returns>True if the header is form disposition, false otherwise</returns>
  38. </member>
  39. <member name="M:Microsoft.Net.Http.Headers.EntityTagHeaderValue.Equals(System.Object)">
  40. <summary>
  41. Check against another <see cref="T:Microsoft.Net.Http.Headers.EntityTagHeaderValue"/> for equality.
  42. This equality check should not be used to determine if two values match under the RFC specifications (https://tools.ietf.org/html/rfc7232#section-2.3.2).
  43. </summary>
  44. <param name="obj">The other value to check against for equality.</param>
  45. <returns>
  46. <c>true</c> if the strength and tag of the two values match,
  47. <c>false</c> if the other value is null, is not an <see cref="T:Microsoft.Net.Http.Headers.EntityTagHeaderValue"/>, or if there is a mismatch of strength or tag between the two values.
  48. </returns>
  49. </member>
  50. <member name="M:Microsoft.Net.Http.Headers.EntityTagHeaderValue.Compare(Microsoft.Net.Http.Headers.EntityTagHeaderValue,System.Boolean)">
  51. <summary>
  52. Compares against another <see cref="T:Microsoft.Net.Http.Headers.EntityTagHeaderValue"/> to see if they match under the RFC specifications (https://tools.ietf.org/html/rfc7232#section-2.3.2).
  53. </summary>
  54. <param name="other">The other <see cref="T:Microsoft.Net.Http.Headers.EntityTagHeaderValue"/> to compare against.</param>
  55. <param name="useStrongComparison"><c>true</c> to use a strong comparison, <c>false</c> to use a weak comparison</param>
  56. <returns>
  57. <c>true</c> if the <see cref="T:Microsoft.Net.Http.Headers.EntityTagHeaderValue"/> match for the given comparison type,
  58. <c>false</c> if the other value is null or the comparison failed.
  59. </returns>
  60. </member>
  61. <member name="F:Microsoft.Net.Http.Headers.HeaderQuality.Match">
  62. <summary>
  63. Quality factor to indicate a perfect match.
  64. </summary>
  65. </member>
  66. <member name="F:Microsoft.Net.Http.Headers.HeaderQuality.NoMatch">
  67. <summary>
  68. Quality factor to indicate no match.
  69. </summary>
  70. </member>
  71. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.TryParseSeconds(Microsoft.Extensions.Primitives.StringValues,System.String,System.Nullable{System.TimeSpan}@)">
  72. <summary>
  73. Try to find a target header value among the set of given header values and parse it as a
  74. <see cref="T:System.TimeSpan"/>.
  75. </summary>
  76. <param name="headerValues">
  77. The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> containing the set of header values to search.
  78. </param>
  79. <param name="targetValue">
  80. The target header value to look for.
  81. </param>
  82. <param name="value">
  83. When this method returns, contains the parsed <see cref="T:System.TimeSpan"/>, if the parsing succeeded, or
  84. null if the parsing failed. The conversion fails if the <paramref name="targetValue"/> was not
  85. found or could not be parsed as a <see cref="T:System.TimeSpan"/>. This parameter is passed uninitialized;
  86. any value originally supplied in result will be overwritten.
  87. </param>
  88. <returns>
  89. <code>true</code> if <paramref name="targetValue"/> is found and successfully parsed; otherwise,
  90. <code>false</code>.
  91. </returns>
  92. </member>
  93. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.ContainsCacheDirective(Microsoft.Extensions.Primitives.StringValues,System.String)">
  94. <summary>
  95. Check if a target directive exists among the set of given cache control directives.
  96. </summary>
  97. <param name="cacheControlDirectives">
  98. The <see cref="T:Microsoft.Extensions.Primitives.StringValues"/> containing the set of cache control directives.
  99. </param>
  100. <param name="targetDirectives">
  101. The target cache control directives to look for.
  102. </param>
  103. <returns>
  104. <code>true</code> if <paramref name="targetDirectives"/> is contained in <paramref name="cacheControlDirectives"/>;
  105. otherwise, <code>false</code>.
  106. </returns>
  107. </member>
  108. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.TryParseNonNegativeInt32(Microsoft.Extensions.Primitives.StringSegment,System.Int32@)">
  109. <summary>
  110. Try to convert a string representation of a positive number to its 64-bit signed integer equivalent.
  111. A return value indicates whether the conversion succeeded or failed.
  112. </summary>
  113. <param name="value">
  114. A string containing a number to convert.
  115. </param>
  116. <param name="result">
  117. When this method returns, contains the 64-bit signed integer value equivalent of the number contained
  118. in the string, if the conversion succeeded, or zero if the conversion failed. The conversion fails if
  119. the string is null or String.Empty, is not of the correct format, is negative, or represents a number
  120. greater than Int64.MaxValue. This parameter is passed uninitialized; any value originally supplied in
  121. result will be overwritten.
  122. </param>
  123. <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
  124. </member>
  125. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.TryParseNonNegativeInt64(Microsoft.Extensions.Primitives.StringSegment,System.Int64@)">
  126. <summary>
  127. Try to convert a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> representation of a positive number to its 64-bit signed
  128. integer equivalent. A return value indicates whether the conversion succeeded or failed.
  129. </summary>
  130. <param name="value">
  131. A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> containing a number to convert.
  132. </param>
  133. <param name="result">
  134. When this method returns, contains the 64-bit signed integer value equivalent of the number contained
  135. in the string, if the conversion succeeded, or zero if the conversion failed. The conversion fails if
  136. the <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> is null or String.Empty, is not of the correct format, is negative, or
  137. represents a number greater than Int64.MaxValue. This parameter is passed uninitialized; any value
  138. originally supplied in result will be overwritten.
  139. </param>
  140. <returns><code>true</code> if parsing succeeded; otherwise, <code>false</code>.</returns>
  141. </member>
  142. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.FormatNonNegativeInt64(System.Int64)">
  143. <summary>
  144. Converts the non-negative 64-bit numeric value to its equivalent string representation.
  145. </summary>
  146. <param name="value">
  147. The number to convert.
  148. </param>
  149. <returns>
  150. The string representation of the value of this instance, consisting of a sequence of digits ranging from 0 to 9 with no leading zeroes.
  151. </returns>
  152. </member>
  153. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.UnescapeAsQuotedString(Microsoft.Extensions.Primitives.StringSegment)">
  154. <summary>
  155. Given a quoted-string as defined by <see href="https://tools.ietf.org/html/rfc7230#section-3.2.6">the RFC specification</see>,
  156. removes quotes and unescapes backslashes and quotes. This assumes that the input is a valid quoted-string.
  157. </summary>
  158. <param name="input">The quoted-string to be unescaped.</param>
  159. <returns>An unescaped version of the quoted-string.</returns>
  160. </member>
  161. <member name="M:Microsoft.Net.Http.Headers.HeaderUtilities.EscapeAsQuotedString(Microsoft.Extensions.Primitives.StringSegment)">
  162. <summary>
  163. Escapes a <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> as a quoted-string, which is defined by
  164. <see href="https://tools.ietf.org/html/rfc7230#section-3.2.6">the RFC specification</see>.
  165. </summary>
  166. <remarks>
  167. This will add a backslash before each backslash and quote and add quotes
  168. around the input. Assumes that the input does not have quotes around it,
  169. as this method will add them. Throws if the input contains any invalid escape characters,
  170. as defined by rfc7230.
  171. </remarks>
  172. <param name="input">The input to be escaped.</param>
  173. <returns>An escaped version of the quoted-string.</returns>
  174. </member>
  175. <member name="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue">
  176. <summary>
  177. Representation of the media type header. See <see href="https://tools.ietf.org/html/rfc6838"/>.
  178. </summary>
  179. </member>
  180. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.#ctor(Microsoft.Extensions.Primitives.StringSegment)">
  181. <summary>
  182. Initializes a <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> instance.
  183. </summary>
  184. <param name="mediaType">A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> representation of a media type.
  185. The text provided must be a single media type without parameters. </param>
  186. </member>
  187. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.#ctor(Microsoft.Extensions.Primitives.StringSegment,System.Double)">
  188. <summary>
  189. Initializes a <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> instance.
  190. </summary>
  191. <param name="mediaType">A <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> representation of a media type.
  192. The text provided must be a single media type without parameters. </param>
  193. <param name="quality">The <see cref="T:System.Double"/> with the quality of the media type.</param>
  194. </member>
  195. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Charset">
  196. <summary>
  197. Gets or sets the value of the charset parameter. Returns <see cref="F:Microsoft.Extensions.Primitives.StringSegment.Empty"/>
  198. if there is no charset.
  199. </summary>
  200. </member>
  201. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Encoding">
  202. <summary>
  203. Gets or sets the value of the Encoding parameter. Setting the Encoding will set
  204. the <see cref="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Charset"/> to <see cref="P:System.Text.Encoding.WebName"/>.
  205. </summary>
  206. </member>
  207. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Boundary">
  208. <summary>
  209. Gets or sets the value of the boundary parameter. Returns <see cref="F:Microsoft.Extensions.Primitives.StringSegment.Empty"/>
  210. if there is no boundary.
  211. </summary>
  212. </member>
  213. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Parameters">
  214. <summary>
  215. Gets or sets the media type's parameters. Returns an empty <see cref="T:System.Collections.Generic.IList`1"/>
  216. if there are no parameters.
  217. </summary>
  218. </member>
  219. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Quality">
  220. <summary>
  221. Gets or sets the value of the quality parameter. Returns null
  222. if there is no quality.
  223. </summary>
  224. </member>
  225. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.MediaType">
  226. <summary>
  227. Gets or sets the value of the media type. Returns <see cref="F:Microsoft.Extensions.Primitives.StringSegment.Empty"/>
  228. if there is no media type.
  229. </summary>
  230. <example>
  231. For the media type <c>"application/json"</c>, the property gives the value
  232. <c>"application/json"</c>.
  233. </example>
  234. </member>
  235. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Type">
  236. <summary>
  237. Gets the type of the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.
  238. </summary>
  239. <example>
  240. For the media type <c>"application/json"</c>, the property gives the value <c>"application"</c>.
  241. </example>
  242. <remarks>See <see href="https://tools.ietf.org/html/rfc6838#section-4.2"/> for more details on the type.</remarks>
  243. </member>
  244. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.SubType">
  245. <summary>
  246. Gets the subtype of the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.
  247. </summary>
  248. <example>
  249. For the media type <c>"application/vnd.example+json"</c>, the property gives the value
  250. <c>"vnd.example+json"</c>.
  251. </example>
  252. <remarks>See <see href="https://tools.ietf.org/html/rfc6838#section-4.2"/> for more details on the subtype.</remarks>
  253. </member>
  254. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.SubTypeWithoutSuffix">
  255. <summary>
  256. Gets subtype of the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>, excluding any structured syntax suffix. Returns <see cref="F:Microsoft.Extensions.Primitives.StringSegment.Empty"/>
  257. if there is no subtype without suffix.
  258. </summary>
  259. <example>
  260. For the media type <c>"application/vnd.example+json"</c>, the property gives the value
  261. <c>"vnd.example"</c>.
  262. </example>
  263. </member>
  264. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Suffix">
  265. <summary>
  266. Gets the structured syntax suffix of the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> if it has one.
  267. See <see href="https://tools.ietf.org/html/rfc6838#section-4.8">The RFC documentation on structured syntaxes.</see>
  268. </summary>
  269. <example>
  270. For the media type <c>"application/vnd.example+json"</c>, the property gives the value
  271. <c>"json"</c>.
  272. </example>
  273. </member>
  274. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Facets">
  275. <summary>
  276. Get a <see cref="T:System.Collections.Generic.IList`1"/> of facets of the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>. Facets are a
  277. period separated list of StringSegments in the <see cref="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.SubTypeWithoutSuffix"/>.
  278. See <see href="https://tools.ietf.org/html/rfc6838#section-3">The RFC documentation on facets.</see>
  279. </summary>
  280. <example>
  281. For the media type <c>"application/vnd.example+json"</c>, the property gives the value:
  282. <c>{"vnd", "example"}</c>
  283. </example>
  284. </member>
  285. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.MatchesAllTypes">
  286. <summary>
  287. Gets whether this <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> matches all types.
  288. </summary>
  289. </member>
  290. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.MatchesAllSubTypes">
  291. <summary>
  292. Gets whether this <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> matches all subtypes.
  293. </summary>
  294. <example>
  295. For the media type <c>"application/*"</c>, this property is <c>true</c>.
  296. </example>
  297. <example>
  298. For the media type <c>"application/json"</c>, this property is <c>false</c>.
  299. </example>
  300. </member>
  301. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.MatchesAllSubTypesWithoutSuffix">
  302. <summary>
  303. Gets whether this <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> matches all subtypes, ignoring any structured syntax suffix.
  304. </summary>
  305. <example>
  306. For the media type <c>"application/*+json"</c>, this property is <c>true</c>.
  307. </example>
  308. <example>
  309. For the media type <c>"application/vnd.example+json"</c>, this property is <c>false</c>.
  310. </example>
  311. </member>
  312. <member name="P:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.IsReadOnly">
  313. <summary>
  314. Gets whether the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> is readonly.
  315. </summary>
  316. </member>
  317. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.IsSubsetOf(Microsoft.Net.Http.Headers.MediaTypeHeaderValue)">
  318. <summary>
  319. Gets a value indicating whether this <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> is a subset of
  320. <paramref name="otherMediaType"/>. A "subset" is defined as the same or a more specific media type
  321. according to the precedence described in https://www.ietf.org/rfc/rfc2068.txt section 14.1, Accept.
  322. </summary>
  323. <param name="otherMediaType">The <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> to compare.</param>
  324. <returns>
  325. A value indicating whether this <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> is a subset of
  326. <paramref name="otherMediaType"/>.
  327. </returns>
  328. <remarks>
  329. For example "multipart/mixed; boundary=1234" is a subset of "multipart/mixed; boundary=1234",
  330. "multipart/mixed", "multipart/*", and "*/*" but not "multipart/mixed; boundary=2345" or
  331. "multipart/message; boundary=1234".
  332. </remarks>
  333. </member>
  334. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Copy">
  335. <summary>
  336. Performs a deep copy of this object and all of it's NameValueHeaderValue sub components,
  337. while avoiding the cost of re-validating the components.
  338. </summary>
  339. <returns>A deep copy.</returns>
  340. </member>
  341. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.CopyAsReadOnly">
  342. <summary>
  343. Performs a deep copy of this object and all of it's NameValueHeaderValue sub components,
  344. while avoiding the cost of re-validating the components. This copy is read-only.
  345. </summary>
  346. <returns>A deep, read-only, copy.</returns>
  347. </member>
  348. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.Parse(Microsoft.Extensions.Primitives.StringSegment)">
  349. <summary>
  350. Takes a media type and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue" /> and its associated parameters.
  351. </summary>
  352. <param name="input">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> with the media type.</param>
  353. <returns>The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.</returns>
  354. </member>
  355. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.TryParse(Microsoft.Extensions.Primitives.StringSegment,Microsoft.Net.Http.Headers.MediaTypeHeaderValue@)">
  356. <summary>
  357. Takes a media type, which can include parameters, and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue" /> and its associated parameters.
  358. </summary>
  359. <param name="input">The <see cref="T:Microsoft.Extensions.Primitives.StringSegment"/> with the media type. The media type constructed here must not have an y</param>
  360. <param name="parsedValue">The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/></param>
  361. <returns>True if the value was successfully parsed.</returns>
  362. </member>
  363. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.ParseList(System.Collections.Generic.IList{System.String})">
  364. <summary>
  365. Takes an <see cref="T:System.Collections.Generic.IList`1"/> of <see cref="T:System.String"/> and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"></see> and its associated parameters.
  366. </summary>
  367. <param name="inputs">A list of media types</param>
  368. <returns>The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.</returns>
  369. </member>
  370. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.ParseStrictList(System.Collections.Generic.IList{System.String})">
  371. <summary>
  372. Takes an <see cref="T:System.Collections.Generic.IList`1"/> of <see cref="T:System.String"/> and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"></see> and its associated parameters.
  373. Throws if there is invalid data in a string.
  374. </summary>
  375. <param name="inputs">A list of media types</param>
  376. <returns>The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.</returns>
  377. </member>
  378. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.TryParseList(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{Microsoft.Net.Http.Headers.MediaTypeHeaderValue}@)">
  379. <summary>
  380. Takes an <see cref="T:System.Collections.Generic.IList`1"/> of <see cref="T:System.String"/> and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"></see> and its associated parameters.
  381. </summary>
  382. <param name="inputs">A list of media types</param>
  383. <param name="parsedValues">The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.</param>
  384. <returns>True if the value was successfully parsed.</returns>
  385. </member>
  386. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValue.TryParseStrictList(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{Microsoft.Net.Http.Headers.MediaTypeHeaderValue}@)">
  387. <summary>
  388. Takes an <see cref="T:System.Collections.Generic.IList`1"/> of <see cref="T:System.String"/> and parses it into the <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"></see> and its associated parameters.
  389. </summary>
  390. <param name="inputs">A list of media types</param>
  391. <param name="parsedValues">The parsed <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/>.</param>
  392. <returns>True if the value was successfully parsed.</returns>
  393. </member>
  394. <member name="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValueComparer">
  395. <summary>
  396. Implementation of <see cref="T:System.Collections.Generic.IComparer`1"/> that can compare accept media type header fields
  397. based on their quality values (a.k.a q-values).
  398. </summary>
  399. </member>
  400. <member name="M:Microsoft.Net.Http.Headers.MediaTypeHeaderValueComparer.Compare(Microsoft.Net.Http.Headers.MediaTypeHeaderValue,Microsoft.Net.Http.Headers.MediaTypeHeaderValue)">
  401. <inheritdoc />
  402. <remarks>
  403. Performs comparisons based on the arguments' quality values
  404. (aka their "q-value"). Values with identical q-values are considered equal (i.e. the result is 0)
  405. with the exception that suffixed subtype wildcards are considered less than subtype wildcards, subtype wildcards
  406. are considered less than specific media types and full wildcards are considered less than
  407. subtype wildcards. This allows callers to sort a sequence of <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValue"/> following
  408. their q-values in the order of specific media types, subtype wildcards, and last any full wildcards.
  409. </remarks>
  410. <example>
  411. If we had a list of media types (comma separated): { text/*;q=0.8, text/*+json;q=0.8, */*;q=1, */*;q=0.8, text/plain;q=0.8 }
  412. Sorting them using Compare would return: { */*;q=0.8, text/*;q=0.8, text/*+json;q=0.8, text/plain;q=0.8, */*;q=1 }
  413. </example>
  414. </member>
  415. <member name="M:Microsoft.Net.Http.Headers.NameValueHeaderValue.Copy">
  416. <summary>
  417. Provides a copy of this object without the cost of re-validating the values.
  418. </summary>
  419. <returns>A copy.</returns>
  420. </member>
  421. <member name="M:Microsoft.Net.Http.Headers.SetCookieHeaderValue.AppendToStringBuilder(System.Text.StringBuilder)">
  422. <summary>
  423. Append string representation of this <see cref="T:Microsoft.Net.Http.Headers.SetCookieHeaderValue"/> to given
  424. <paramref name="builder"/>.
  425. </summary>
  426. <param name="builder">
  427. The <see cref="T:System.Text.StringBuilder"/> to receive the string representation of this
  428. <see cref="T:Microsoft.Net.Http.Headers.SetCookieHeaderValue"/>.
  429. </param>
  430. </member>
  431. <member name="T:Microsoft.Net.Http.Headers.StringWithQualityHeaderValueComparer">
  432. <summary>
  433. Implementation of <see cref="T:System.Collections.Generic.IComparer`1"/> that can compare content negotiation header fields
  434. based on their quality values (a.k.a q-values). This applies to values used in accept-charset,
  435. accept-encoding, accept-language and related header fields with similar syntax rules. See
  436. <see cref="T:Microsoft.Net.Http.Headers.MediaTypeHeaderValueComparer"/> for a comparer for media type
  437. q-values.
  438. </summary>
  439. </member>
  440. <member name="M:Microsoft.Net.Http.Headers.StringWithQualityHeaderValueComparer.Compare(Microsoft.Net.Http.Headers.StringWithQualityHeaderValue,Microsoft.Net.Http.Headers.StringWithQualityHeaderValue)">
  441. <summary>
  442. Compares two <see cref="T:Microsoft.Net.Http.Headers.StringWithQualityHeaderValue"/> based on their quality value
  443. (a.k.a their "q-value").
  444. Values with identical q-values are considered equal (i.e the result is 0) with the exception of wild-card
  445. values (i.e. a value of "*") which are considered less than non-wild-card values. This allows to sort
  446. a sequence of <see cref="T:Microsoft.Net.Http.Headers.StringWithQualityHeaderValue"/> following their q-values ending up with any
  447. wild-cards at the end.
  448. </summary>
  449. <param name="stringWithQuality1">The first value to compare.</param>
  450. <param name="stringWithQuality2">The second value to compare</param>
  451. <returns>The result of the comparison.</returns>
  452. </member>
  453. </members>
  454. </doc>