You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3726 lines
170 KiB

1 year ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>RestSharp.WindowsPhone</name>
  5. </assembly>
  6. <members>
  7. <member name="T:RestSharp.Authenticators.OAuth1Authenticator">
  8. <seealso href="http://tools.ietf.org/html/rfc5849"/>
  9. </member>
  10. <member name="T:RestSharp.OAuth2Authenticator">
  11. <summary>
  12. Base class for OAuth 2 Authenticators.
  13. </summary>
  14. <remarks>
  15. Since there are many ways to authenticate in OAuth2,
  16. this is used as a base class to differentiate between
  17. other authenticators.
  18. Any other OAuth2 authenticators must derive from this
  19. abstract class.
  20. </remarks>
  21. </member>
  22. <member name="F:RestSharp.OAuth2Authenticator._accessToken">
  23. <summary>
  24. Access token to be used when authenticating.
  25. </summary>
  26. </member>
  27. <member name="M:RestSharp.OAuth2Authenticator.#ctor(System.String)">
  28. <summary>
  29. Initializes a new instance of the <see cref="T:RestSharp.OAuth2Authenticator"/> class.
  30. </summary>
  31. <param name="accessToken">
  32. The access token.
  33. </param>
  34. </member>
  35. <member name="P:RestSharp.OAuth2Authenticator.AccessToken">
  36. <summary>
  37. Gets the access token.
  38. </summary>
  39. </member>
  40. <member name="T:RestSharp.OAuth2UriQueryParameterAuthenticator">
  41. <summary>
  42. The OAuth 2 authenticator using URI query parameter.
  43. </summary>
  44. <remarks>
  45. Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2
  46. </remarks>
  47. </member>
  48. <member name="M:RestSharp.OAuth2UriQueryParameterAuthenticator.#ctor(System.String)">
  49. <summary>
  50. Initializes a new instance of the <see cref="T:RestSharp.OAuth2UriQueryParameterAuthenticator"/> class.
  51. </summary>
  52. <param name="accessToken">
  53. The access token.
  54. </param>
  55. </member>
  56. <member name="T:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator">
  57. <summary>
  58. The OAuth 2 authenticator using the authorization request header field.
  59. </summary>
  60. <remarks>
  61. Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1
  62. </remarks>
  63. </member>
  64. <member name="F:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator._authorizationValue">
  65. <summary>
  66. Stores the Authorization header value as "[tokenType] accessToken". used for performance.
  67. </summary>
  68. </member>
  69. <member name="M:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String)">
  70. <summary>
  71. Initializes a new instance of the <see cref="T:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator"/> class.
  72. </summary>
  73. <param name="accessToken">
  74. The access token.
  75. </param>
  76. </member>
  77. <member name="M:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String,System.String)">
  78. <summary>
  79. Initializes a new instance of the <see cref="T:RestSharp.OAuth2AuthorizationRequestHeaderAuthenticator"/> class.
  80. </summary>
  81. <param name="accessToken">
  82. The access token.
  83. </param>
  84. <param name="tokenType">
  85. The token type.
  86. </param>
  87. </member>
  88. <member name="F:RestSharp.Authenticators.OAuth.OAuthTools._encoding">
  89. <summary>
  90. All text parameters are UTF-8 encoded (per section 5.1).
  91. </summary>
  92. <seealso cref="!:http://www.hueniverse.com/hueniverse/2008/10/beginners-gui-1.html"/>
  93. </member>
  94. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetNonce">
  95. <summary>
  96. Generates a random 16-byte lowercase alphanumeric string.
  97. </summary>
  98. <seealso cref="!:http://oauth.net/core/1.0#nonce"/>
  99. <returns></returns>
  100. </member>
  101. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp">
  102. <summary>
  103. Generates a timestamp based on the current elapsed seconds since '01/01/1970 0000 GMT"
  104. </summary>
  105. <seealso cref="!:http://oauth.net/core/1.0#nonce"/>
  106. <returns></returns>
  107. </member>
  108. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp(System.DateTime)">
  109. <summary>
  110. Generates a timestamp based on the elapsed seconds of a given time since '01/01/1970 0000 GMT"
  111. </summary>
  112. <seealso cref="!:http://oauth.net/core/1.0#nonce"/>
  113. <param name="dateTime">A specified point in time.</param>
  114. <returns></returns>
  115. </member>
  116. <member name="F:RestSharp.Authenticators.OAuth.OAuthTools.UriRfc3986CharsToEscape">
  117. <summary>
  118. The set of characters that are unreserved in RFC 2396 but are NOT unreserved in RFC 3986.
  119. </summary>
  120. <seealso cref="!:http://stackoverflow.com/questions/846487/how-to-get-uri-escapedatastring-to-comply-with-rfc-3986"/>
  121. </member>
  122. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeRelaxed(System.String)">
  123. <summary>
  124. URL encodes a string based on section 5.1 of the OAuth spec.
  125. Namely, percent encoding with [RFC3986], avoiding unreserved characters,
  126. upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs.
  127. </summary>
  128. <param name="value">The value to escape.</param>
  129. <returns>The escaped value.</returns>
  130. <remarks>
  131. The <see cref="M:System.Uri.EscapeDataString(System.String)"/> method is <i>supposed</i> to take on
  132. RFC 3986 behavior if certain elements are present in a .config file. Even if this
  133. actually worked (which in my experiments it <i>doesn't</i>), we can't rely on every
  134. host actually having this configuration element present.
  135. </remarks>
  136. <seealso cref="!:http://oauth.net/core/1.0#encoding_parameters"/>
  137. <seealso cref="!:http://stackoverflow.com/questions/846487/how-to-get-uri-escapedatastring-to-comply-with-rfc-3986"/>
  138. </member>
  139. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeStrict(System.String)">
  140. <summary>
  141. URL encodes a string based on section 5.1 of the OAuth spec.
  142. Namely, percent encoding with [RFC3986], avoiding unreserved characters,
  143. upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs.
  144. </summary>
  145. <param name="value"></param>
  146. <seealso cref="!:http://oauth.net/core/1.0#encoding_parameters"/>
  147. </member>
  148. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.NormalizeRequestParameters(RestSharp.Authenticators.OAuth.WebParameterCollection)">
  149. <summary>
  150. Sorts a collection of key-value pairs by name, and then value if equal,
  151. concatenating them into a single string. This string should be encoded
  152. prior to, or after normalization is run.
  153. </summary>
  154. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.1"/>
  155. <param name="parameters"></param>
  156. <returns></returns>
  157. </member>
  158. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.SortParametersExcludingSignature(RestSharp.Authenticators.OAuth.WebParameterCollection)">
  159. <summary>
  160. Sorts a <see cref="T:RestSharp.Authenticators.OAuth.WebParameterCollection"/> by name, and then value if equal.
  161. </summary>
  162. <param name="parameters">A collection of parameters to sort</param>
  163. <returns>A sorted parameter collection</returns>
  164. </member>
  165. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConstructRequestUrl(System.Uri)">
  166. <summary>
  167. Creates a request URL suitable for making OAuth requests.
  168. Resulting URLs must exclude port 80 or port 443 when accompanied by HTTP and HTTPS, respectively.
  169. Resulting URLs must be lower case.
  170. </summary>
  171. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.2"/>
  172. <param name="url">The original request URL</param>
  173. <returns></returns>
  174. </member>
  175. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConcatenateRequestElements(System.String,System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)">
  176. <summary>
  177. Creates a request elements concatentation value to send with a request.
  178. This is also known as the signature base.
  179. </summary>
  180. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.3"/>
  181. <seealso cref="!:http://oauth.net/core/1.0#sig_base_example"/>
  182. <param name="method">The request's HTTP method type</param>
  183. <param name="url">The request URL</param>
  184. <param name="parameters">The request's parameters</param>
  185. <returns>A signature base string</returns>
  186. </member>
  187. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,System.String,System.String)">
  188. <summary>
  189. Creates a signature value given a signature base and the consumer secret.
  190. This method is used when the token secret is currently unknown.
  191. </summary>
  192. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/>
  193. <param name="signatureMethod">The hashing method</param>
  194. <param name="signatureBase">The signature base</param>
  195. <param name="consumerSecret">The consumer key</param>
  196. <returns></returns>
  197. </member>
  198. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String)">
  199. <summary>
  200. Creates a signature value given a signature base and the consumer secret.
  201. This method is used when the token secret is currently unknown.
  202. </summary>
  203. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/>
  204. <param name="signatureMethod">The hashing method</param>
  205. <param name="signatureTreatment">The treatment to use on a signature value</param>
  206. <param name="signatureBase">The signature base</param>
  207. <param name="consumerSecret">The consumer key</param>
  208. <returns></returns>
  209. </member>
  210. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,System.String,System.String,System.String)">
  211. <summary>
  212. Creates a signature value given a signature base and the consumer secret and a known token secret.
  213. </summary>
  214. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/>
  215. <param name="signatureMethod">The hashing method</param>
  216. <param name="signatureBase">The signature base</param>
  217. <param name="consumerSecret">The consumer secret</param>
  218. <param name="tokenSecret">The token secret</param>
  219. <returns></returns>
  220. </member>
  221. <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String,System.String)">
  222. <summary>
  223. Creates a signature value given a signature base and the consumer secret and a known token secret.
  224. </summary>
  225. <seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/>
  226. <param name="signatureMethod">The hashing method</param>
  227. <param name="signatureTreatment">The treatment to use on a signature value</param>
  228. <param name="signatureBase">The signature base</param>
  229. <param name="consumerSecret">The consumer secret</param>
  230. <param name="tokenSecret">The token secret</param>
  231. <returns></returns>
  232. </member>
  233. <member name="T:RestSharp.Authenticators.OAuth.OAuthWorkflow">
  234. <summary>
  235. A class to encapsulate OAuth authentication flow.
  236. <seealso cref="!:http://oauth.net/core/1.0#anchor9"/>
  237. </summary>
  238. </member>
  239. <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildRequestTokenInfo(System.String)">
  240. <summary>
  241. Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an
  242. <see cref="T:RestSharp.IAuthenticator"/> for the purpose of requesting an
  243. unauthorized request token.
  244. </summary>
  245. <param name="method">The HTTP method for the intended request</param>
  246. <seealso cref="!:http://oauth.net/core/1.0#anchor9"/>
  247. <returns></returns>
  248. </member>
  249. <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildRequestTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)">
  250. <summary>
  251. Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an
  252. <see cref="T:RestSharp.IAuthenticator"/> for the purpose of requesting an
  253. unauthorized request token.
  254. </summary>
  255. <param name="method">The HTTP method for the intended request</param>
  256. <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param>
  257. <seealso cref="!:http://oauth.net/core/1.0#anchor9"/>
  258. <returns></returns>
  259. </member>
  260. <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildAccessTokenInfo(System.String)">
  261. <summary>
  262. Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an
  263. <see cref="T:RestSharp.IAuthenticator"/> for the purpose of exchanging a request token
  264. for an access token authorized by the user at the Service Provider site.
  265. </summary>
  266. <param name="method">The HTTP method for the intended request</param>
  267. <seealso cref="!:http://oauth.net/core/1.0#anchor9"/>
  268. </member>
  269. <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildAccessTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)">
  270. <summary>
  271. Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an
  272. <see cref="T:RestSharp.IAuthenticator"/> for the purpose of exchanging a request token
  273. for an access token authorized by the user at the Service Provider site.
  274. </summary>
  275. <param name="method">The HTTP method for the intended request</param>
  276. <seealso cref="!:http://oauth.net/core/1.0#anchor9"/>
  277. <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param>
  278. </member>
  279. <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildClientAuthAccessTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)">
  280. <summary>
  281. Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an
  282. <see cref="T:RestSharp.IAuthenticator"/> for the purpose of exchanging user credentials
  283. for an access token authorized by the user at the Service Provider site.
  284. </summary>
  285. <param name="method">The HTTP method for the intended request</param>
  286. <seealso cref="!:http://tools.ietf.org/html/draft-dehora-farrell-oauth-accesstoken-creds-00#section-4"/>
  287. <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param>
  288. </member>
  289. <member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.RequestTokenUrl">
  290. <seealso cref="!:http://oauth.net/core/1.0#request_urls"/>
  291. </member>
  292. <member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.AccessTokenUrl">
  293. <seealso cref="!:http://oauth.net/core/1.0#request_urls"/>
  294. </member>
  295. <member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.AuthorizationUrl">
  296. <seealso cref="!:http://oauth.net/core/1.0#request_urls"/>
  297. </member>
  298. <member name="T:RestSharp.Compression.ZLib.CRC32">
  299. <summary>
  300. Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the same polynomial
  301. used by Zip. This type is used internally by DotNetZip; it is generally not used
  302. directly by applications wishing to create, read, or manipulate zip archive
  303. files.
  304. </summary>
  305. </member>
  306. <member name="M:RestSharp.Compression.ZLib.CRC32.GetCrc32(System.IO.Stream)">
  307. <summary>
  308. Returns the CRC32 for the specified stream.
  309. </summary>
  310. <param name="input">The stream over which to calculate the CRC32</param>
  311. <returns>the CRC32 calculation</returns>
  312. </member>
  313. <member name="M:RestSharp.Compression.ZLib.CRC32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)">
  314. <summary>
  315. Returns the CRC32 for the specified stream, and writes the input into the
  316. output stream.
  317. </summary>
  318. <param name="input">The stream over which to calculate the CRC32</param>
  319. <param name="output">The stream into which to deflate the input</param>
  320. <returns>the CRC32 calculation</returns>
  321. </member>
  322. <member name="M:RestSharp.Compression.ZLib.CRC32.ComputeCrc32(System.Int32,System.Byte)">
  323. <summary>
  324. Get the CRC32 for the given (word,byte) combo. This is a computation
  325. defined by PKzip.
  326. </summary>
  327. <param name="W">The word to start with.</param>
  328. <param name="B">The byte to combine it with.</param>
  329. <returns>The CRC-ized result.</returns>
  330. </member>
  331. <member name="M:RestSharp.Compression.ZLib.CRC32.SlurpBlock(System.Byte[],System.Int32,System.Int32)">
  332. <summary>
  333. Update the value for the running CRC32 using the given block of bytes.
  334. This is useful when using the CRC32() class in a Stream.
  335. </summary>
  336. <param name="block">block of bytes to slurp</param>
  337. <param name="offset">starting point in the block</param>
  338. <param name="count">how many bytes within the block to slurp</param>
  339. </member>
  340. <member name="P:RestSharp.Compression.ZLib.CRC32.TotalBytesRead">
  341. <summary>
  342. indicates the total number of bytes read on the CRC stream.
  343. This is used when writing the ZipDirEntry when compressing files.
  344. </summary>
  345. </member>
  346. <member name="P:RestSharp.Compression.ZLib.CRC32.Crc32Result">
  347. <summary>
  348. Indicates the current CRC for all blocks slurped in.
  349. </summary>
  350. </member>
  351. <member name="T:RestSharp.Compression.ZLib.CrcCalculatorStream">
  352. <summary>
  353. A Stream that calculates a CRC32 (a checksum) on all bytes read,
  354. or on all bytes written.
  355. </summary>
  356. <remarks>
  357. <para>
  358. This class can be used to verify the CRC of a ZipEntry when
  359. reading from a stream, or to calculate a CRC when writing to a
  360. stream. The stream should be used to either read, or write, but
  361. not both. If you intermix reads and writes, the results are not
  362. defined.
  363. </para>
  364. <para>
  365. This class is intended primarily for use internally by the
  366. DotNetZip library.
  367. </para>
  368. </remarks>
  369. </member>
  370. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream)">
  371. <summary>
  372. The default constructor.
  373. </summary>
  374. <remarks>
  375. Instances returned from this constructor will leave the underlying stream
  376. open upon Close().
  377. </remarks>
  378. <param name="stream">The underlying stream</param>
  379. </member>
  380. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Boolean)">
  381. <summary>
  382. The constructor allows the caller to specify how to handle the underlying
  383. stream at close.
  384. </summary>
  385. <param name="stream">The underlying stream</param>
  386. <param name="leaveOpen">true to leave the underlying stream
  387. open upon close of the CrcCalculatorStream.; false otherwise.</param>
  388. </member>
  389. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)">
  390. <summary>
  391. A constructor allowing the specification of the length of the stream to read.
  392. </summary>
  393. <remarks>
  394. Instances returned from this constructor will leave the underlying stream open
  395. upon Close().
  396. </remarks>
  397. <param name="stream">The underlying stream</param>
  398. <param name="length">The length of the stream to slurp</param>
  399. </member>
  400. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean)">
  401. <summary>
  402. A constructor allowing the specification of the length of the stream to
  403. read, as well as whether to keep the underlying stream open upon Close().
  404. </summary>
  405. <param name="stream">The underlying stream</param>
  406. <param name="length">The length of the stream to slurp</param>
  407. <param name="leaveOpen">true to leave the underlying stream
  408. open upon close of the CrcCalculatorStream.; false otherwise.</param>
  409. </member>
  410. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)">
  411. <summary>
  412. Read from the stream
  413. </summary>
  414. <param name="buffer">the buffer to read</param>
  415. <param name="offset">the offset at which to start</param>
  416. <param name="count">the number of bytes to read</param>
  417. <returns>the number of bytes actually read</returns>
  418. </member>
  419. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)">
  420. <summary>
  421. Write to the stream.
  422. </summary>
  423. <param name="buffer">the buffer from which to write</param>
  424. <param name="offset">the offset at which to start writing</param>
  425. <param name="count">the number of bytes to write</param>
  426. </member>
  427. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Flush">
  428. <summary>
  429. Flush the stream.
  430. </summary>
  431. </member>
  432. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)">
  433. <summary>
  434. Not implemented.
  435. </summary>
  436. <param name="offset">N/A</param>
  437. <param name="origin">N/A</param>
  438. <returns>N/A</returns>
  439. </member>
  440. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.SetLength(System.Int64)">
  441. <summary>
  442. Not implemented.
  443. </summary>
  444. <param name="value">N/A</param>
  445. </member>
  446. <member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Close">
  447. <summary>
  448. Closes the stream.
  449. </summary>
  450. </member>
  451. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.TotalBytesSlurped">
  452. <summary>
  453. Gets the total number of bytes run through the CRC32 calculator.
  454. </summary>
  455. <remarks>
  456. This is either the total number of bytes read, or the total number of bytes
  457. written, depending on the direction of this stream.
  458. </remarks>
  459. </member>
  460. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Crc">
  461. <summary>
  462. Provides the current CRC for all blocks slurped in.
  463. </summary>
  464. </member>
  465. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.LeaveOpen">
  466. <summary>
  467. Indicates whether the underlying stream will be left open when the
  468. CrcCalculatorStream is Closed.
  469. </summary>
  470. </member>
  471. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanRead">
  472. <summary>
  473. Indicates whether the stream supports reading.
  474. </summary>
  475. </member>
  476. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanSeek">
  477. <summary>
  478. Indicates whether the stream supports seeking.
  479. </summary>
  480. </member>
  481. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanWrite">
  482. <summary>
  483. Indicates whether the stream supports writing.
  484. </summary>
  485. </member>
  486. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Length">
  487. <summary>
  488. Not implemented.
  489. </summary>
  490. </member>
  491. <member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Position">
  492. <summary>
  493. Not implemented.
  494. </summary>
  495. </member>
  496. <member name="T:RestSharp.Compression.ZLib.FlushType">
  497. <summary>
  498. Describes how to flush the current deflate operation.
  499. </summary>
  500. <remarks>
  501. The different FlushType values are useful when using a Deflate in a streaming application.
  502. </remarks>
  503. </member>
  504. <member name="F:RestSharp.Compression.ZLib.FlushType.None">
  505. <summary>No flush at all.</summary>
  506. </member>
  507. <member name="F:RestSharp.Compression.ZLib.FlushType.Partial">
  508. <summary>Closes the current block, but doesn't flush it to
  509. the output. Used internally only in hypothetical
  510. scenarios. This was supposed to be removed by Zlib, but it is
  511. still in use in some edge cases.
  512. </summary>
  513. </member>
  514. <member name="F:RestSharp.Compression.ZLib.FlushType.Sync">
  515. <summary>
  516. Use this during compression to specify that all pending output should be
  517. flushed to the output buffer and the output should be aligned on a byte
  518. boundary. You might use this in a streaming communication scenario, so that
  519. the decompressor can get all input data available so far. When using this
  520. with a ZlibCodec, <c>AvailableBytesIn</c> will be zero after the call if
  521. enough output space has been provided before the call. Flushing will
  522. degrade compression and so it should be used only when necessary.
  523. </summary>
  524. </member>
  525. <member name="F:RestSharp.Compression.ZLib.FlushType.Full">
  526. <summary>
  527. Use this during compression to specify that all output should be flushed, as
  528. with <c>FlushType.Sync</c>, but also, the compression state should be reset
  529. so that decompression can restart from this point if previous compressed
  530. data has been damaged or if random access is desired. Using
  531. <c>FlushType.Full</c> too often can significantly degrade the compression.
  532. </summary>
  533. </member>
  534. <member name="F:RestSharp.Compression.ZLib.FlushType.Finish">
  535. <summary>Signals the end of the compression/decompression stream.</summary>
  536. </member>
  537. <member name="T:RestSharp.Compression.ZLib.GZipStream">
  538. <summary>
  539. A class for compressing and decompressing GZIP streams.
  540. </summary>
  541. <remarks>
  542. <para>
  543. The GZipStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds GZIP compression or decompression to any stream.
  544. </para>
  545. <para> Like the <c>Compression.GZipStream</c> in the .NET Base
  546. Class Library, the Ionic.Zlib.GZipStream can compress while writing, or decompress
  547. while reading, but not vice versa. The compression method used is GZIP, which is
  548. documented in <see href="http://www.ietf.org/rfc/rfc1952.txt">IETF RFC 1952</see>,
  549. "GZIP file format specification version 4.3".</para>
  550. <para> A GZipStream can be used to decompress data (through Read()) or to compress
  551. data (through Write()), but not both. </para>
  552. <para> If you wish to use the GZipStream to compress data, you must wrap it around a
  553. write-able stream. As you call Write() on the GZipStream, the data will be
  554. compressed into the GZIP format. If you want to decompress data, you must wrap the
  555. GZipStream around a readable stream that contains an IETF RFC 1952-compliant stream.
  556. The data will be decompressed as you call Read() on the GZipStream. </para>
  557. <para> Though the GZIP format allows data from multiple files to be concatenated
  558. together, this stream handles only a single segment of GZIP format, typically
  559. representing a single file. </para>
  560. <para>
  561. This class is similar to <see cref="T:RestSharp.Compression.ZLib.ZlibStream"/> and <see cref="!:DeflateStream"/>.
  562. <c>ZlibStream</c> handles RFC1950-compliant streams. <see cref="!:DeflateStream"/>
  563. handles RFC1951-compliant streams. This class handles RFC1952-compliant streams.
  564. </para>
  565. </remarks>
  566. <seealso cref="!:DeflateStream"/>
  567. <seealso cref="T:RestSharp.Compression.ZLib.ZlibStream"/>
  568. </member>
  569. <member name="F:RestSharp.Compression.ZLib.GZipStream.LastModified">
  570. <summary>
  571. The last modified time for the GZIP stream.
  572. </summary>
  573. <remarks> GZIP allows the storage of a last modified time with each GZIP entry.
  574. When compressing data, you can set this before the first call to Write(). When
  575. decompressing, you can retrieve this value any time after the first call to
  576. Read(). </remarks>
  577. </member>
  578. <member name="M:RestSharp.Compression.ZLib.GZipStream.#ctor(System.IO.Stream)">
  579. <summary>
  580. Create a GZipStream using the specified CompressionMode and the specified CompressionLevel,
  581. and explicitly specify whether the stream should be left open after Deflation or Inflation.
  582. </summary>
  583. <remarks>
  584. <para>
  585. This constructor allows the application to request that the captive stream remain open after
  586. the deflation or inflation occurs. By default, after Close() is called on the stream, the
  587. captive stream is also closed. In some cases this is not desired, for example if the stream
  588. is a memory stream that will be re-read after compressed data has been written to it. Specify true for the
  589. leaveOpen parameter to leave the stream open.
  590. </para>
  591. <para>
  592. As noted in the class documentation,
  593. the CompressionMode (Compress or Decompress) also establishes the "direction" of the stream.
  594. A GZipStream with CompressionMode.Compress works only through Write(). A GZipStream with
  595. CompressionMode.Decompress works only through Read().
  596. </para>
  597. </remarks>
  598. <example>
  599. This example shows how to use a DeflateStream to compress data.
  600. <code>
  601. using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress))
  602. {
  603. using (var raw = System.IO.File.Create(outputFile))
  604. {
  605. using (Stream compressor = new GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, true))
  606. {
  607. byte[] buffer = new byte[WORKING_BUFFER_SIZE];
  608. int n;
  609. while ((n= input.Read(buffer, 0, buffer.Length)) != 0)
  610. {
  611. compressor.Write(buffer, 0, n);
  612. }
  613. }
  614. }
  615. }
  616. </code>
  617. <code lang="VB">
  618. Dim outputFile As String = (fileToCompress &amp; ".compressed")
  619. Using input As Stream = File.OpenRead(fileToCompress)
  620. Using raw As FileStream = File.Create(outputFile)
  621. Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, True)
  622. Dim buffer As Byte() = New Byte(4096) {}
  623. Dim n As Integer = -1
  624. Do While (n &lt;&gt; 0)
  625. If (n &gt; 0) Then
  626. compressor.Write(buffer, 0, n)
  627. End If
  628. n = input.Read(buffer, 0, buffer.Length)
  629. Loop
  630. End Using
  631. End Using
  632. End Using
  633. </code>
  634. </example>
  635. <param name="stream">The stream which will be read or written.</param>
  636. <param name="mode">Indicates whether the GZipStream will compress or decompress.</param>
  637. <param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param>
  638. <param name="level">A tuning knob to trade speed for effectiveness.</param>
  639. </member>
  640. <member name="M:RestSharp.Compression.ZLib.GZipStream.Dispose(System.Boolean)">
  641. <summary>
  642. Dispose the stream.
  643. </summary>
  644. <remarks>
  645. This may or may not result in a Close() call on the captive stream.
  646. See the ctor's with leaveOpen parameters for more information.
  647. </remarks>
  648. </member>
  649. <member name="M:RestSharp.Compression.ZLib.GZipStream.Flush">
  650. <summary>
  651. Flush the stream.
  652. </summary>
  653. </member>
  654. <member name="M:RestSharp.Compression.ZLib.GZipStream.Read(System.Byte[],System.Int32,System.Int32)">
  655. <summary>
  656. Read and decompress data from the source stream.
  657. </summary>
  658. <remarks>
  659. With a GZipStream, decompression is done through reading.
  660. </remarks>
  661. <example>
  662. <code>
  663. byte[] working = new byte[WORKING_BUFFER_SIZE];
  664. using (System.IO.Stream input = System.IO.File.OpenRead(_CompressedFile))
  665. {
  666. using (Stream decompressor= new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, true))
  667. {
  668. using (var output = System.IO.File.Create(_DecompressedFile))
  669. {
  670. int n;
  671. while ((n= decompressor.Read(working, 0, working.Length)) !=0)
  672. {
  673. output.Write(working, 0, n);
  674. }
  675. }
  676. }
  677. }
  678. </code>
  679. </example>
  680. <param name="buffer">The buffer into which the decompressed data should be placed.</param>
  681. <param name="offset">the offset within that data array to put the first byte read.</param>
  682. <param name="count">the number of bytes to read.</param>
  683. <returns>the number of bytes actually read</returns>
  684. </member>
  685. <member name="M:RestSharp.Compression.ZLib.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)">
  686. <summary>
  687. Calling this method always throws a <see cref="T:System.NotImplementedException"/>.
  688. </summary>
  689. <param name="offset">irrelevant; it will always throw!</param>
  690. <param name="origin">irrelevant; it will always throw!</param>
  691. <returns>irrelevant!</returns>
  692. </member>
  693. <member name="M:RestSharp.Compression.ZLib.GZipStream.SetLength(System.Int64)">
  694. <summary>
  695. Calling this method always throws a NotImplementedException.
  696. </summary>
  697. <param name="value">irrelevant; this method will always throw!</param>
  698. </member>
  699. <member name="P:RestSharp.Compression.ZLib.GZipStream.Comment">
  700. <summary>
  701. The Comment on the GZIP stream.
  702. </summary>
  703. <remarks>
  704. <para>
  705. The GZIP format allows for each file to optionally have an associated comment stored with the
  706. file. The comment is encoded with the ISO-8859-1 code page. To include a comment in
  707. a GZIP stream you create, set this property before calling Write() for the first time
  708. on the GZipStream.
  709. </para>
  710. <para>
  711. When using GZipStream to decompress, you can retrieve this property after the first
  712. call to Read(). If no comment has been set in the GZIP bytestream, the Comment
  713. property will return null (Nothing in VB).
  714. </para>
  715. </remarks>
  716. </member>
  717. <member name="P:RestSharp.Compression.ZLib.GZipStream.FileName">
  718. <summary>
  719. The FileName for the GZIP stream.
  720. </summary>
  721. <remarks>
  722. <para>
  723. The GZIP format optionally allows each file to have an associated filename. When
  724. compressing data (through Write()), set this FileName before calling Write() the first
  725. time on the GZipStream. The actual filename is encoded into the GZIP bytestream with
  726. the ISO-8859-1 code page, according to RFC 1952. It is the application's responsibility to
  727. insure that the FileName can be encoded and decoded correctly with this code page.
  728. </para>
  729. <para>
  730. When decompressing (through Read()), you can retrieve this value any time after the
  731. first Read(). In the case where there was no filename encoded into the GZIP
  732. bytestream, the property will return null (Nothing in VB).
  733. </para>
  734. </remarks>
  735. </member>
  736. <member name="P:RestSharp.Compression.ZLib.GZipStream.Crc32">
  737. <summary>
  738. The CRC on the GZIP stream.
  739. </summary>
  740. <remarks>
  741. This is used for internal error checking. You probably don't need to look at this property.
  742. </remarks>
  743. </member>
  744. <member name="P:RestSharp.Compression.ZLib.GZipStream.FlushMode">
  745. <summary>
  746. This property sets the flush behavior on the stream.
  747. </summary>
  748. </member>
  749. <member name="P:RestSharp.Compression.ZLib.GZipStream.BufferSize">
  750. <summary>
  751. The size of the working buffer for the compression codec.
  752. </summary>
  753. <remarks>
  754. <para>
  755. The working buffer is used for all stream operations. The default size is 1024 bytes.
  756. The minimum size is 128 bytes. You may get better performance with a larger buffer.
  757. Then again, you might not. You would have to test it.
  758. </para>
  759. <para>
  760. Set this before the first call to Read() or Write() on the stream. If you try to set it
  761. afterwards, it will throw.
  762. </para>
  763. </remarks>
  764. </member>
  765. <member name="P:RestSharp.Compression.ZLib.GZipStream.TotalIn">
  766. <summary> Returns the total number of bytes input so far.</summary>
  767. </member>
  768. <member name="P:RestSharp.Compression.ZLib.GZipStream.TotalOut">
  769. <summary> Returns the total number of bytes output so far.</summary>
  770. </member>
  771. <member name="P:RestSharp.Compression.ZLib.GZipStream.CanRead">
  772. <summary>
  773. Indicates whether the stream can be read.
  774. </summary>
  775. <remarks>
  776. The return value depends on whether the captive stream supports reading.
  777. </remarks>
  778. </member>
  779. <member name="P:RestSharp.Compression.ZLib.GZipStream.CanSeek">
  780. <summary>
  781. Indicates whether the stream supports Seek operations.
  782. </summary>
  783. <remarks>
  784. Always returns false.
  785. </remarks>
  786. </member>
  787. <member name="P:RestSharp.Compression.ZLib.GZipStream.CanWrite">
  788. <summary>
  789. Indicates whether the stream can be written.
  790. </summary>
  791. <remarks>
  792. The return value depends on whether the captive stream supports writing.
  793. </remarks>
  794. </member>
  795. <member name="P:RestSharp.Compression.ZLib.GZipStream.Length">
  796. <summary>
  797. Reading this property always throws a NotImplementedException.
  798. </summary>
  799. </member>
  800. <member name="P:RestSharp.Compression.ZLib.GZipStream.Position">
  801. <summary>
  802. The position of the stream pointer.
  803. </summary>
  804. <remarks>
  805. Writing this property always throws a NotImplementedException. Reading will
  806. return the total bytes written out, if used in writing, or the total bytes
  807. read in, if used in reading. The count may refer to compressed bytes or
  808. uncompressed bytes, depending on how you've used the stream.
  809. </remarks>
  810. </member>
  811. <member name="T:RestSharp.Compression.ZLib.ZlibException">
  812. <summary>
  813. A general purpose exception class for exceptions in the Zlib library.
  814. </summary>
  815. </member>
  816. <member name="M:RestSharp.Compression.ZLib.ZlibException.#ctor">
  817. <summary>
  818. The ZlibException class captures exception information generated
  819. by the Zlib library.
  820. </summary>
  821. </member>
  822. <member name="M:RestSharp.Compression.ZLib.ZlibException.#ctor(System.String)">
  823. <summary>
  824. This ctor collects a message attached to the exception.
  825. </summary>
  826. <param name="s"></param>
  827. </member>
  828. <member name="M:RestSharp.Compression.ZLib.SharedUtils.URShift(System.Int32,System.Int32)">
  829. <summary>
  830. Performs an unsigned bitwise right shift with the specified number
  831. </summary>
  832. <param name="number">Number to operate on</param>
  833. <param name="bits">Ammount of bits to shift</param>
  834. <returns>The resulting number from the shift operation</returns>
  835. </member>
  836. <member name="M:RestSharp.Compression.ZLib.SharedUtils.URShift(System.Int64,System.Int32)">
  837. <summary>
  838. Performs an unsigned bitwise right shift with the specified number
  839. </summary>
  840. <param name="number">Number to operate on</param>
  841. <param name="bits">Ammount of bits to shift</param>
  842. <returns>The resulting number from the shift operation</returns>
  843. </member>
  844. <member name="M:RestSharp.Compression.ZLib.SharedUtils.ReadInput(System.IO.TextReader,System.Byte[],System.Int32,System.Int32)">
  845. <summary>Reads a number of characters from the current source TextReader and writes the data to the target array at the specified index.</summary>
  846. <param name="sourceTextReader">The source TextReader to read from</param>
  847. <param name="target">Contains the array of characteres read from the source TextReader.</param>
  848. <param name="start">The starting index of the target array.</param>
  849. <param name="count">The maximum number of characters to read from the source TextReader.</param>
  850. <returns>The number of characters read. The number will be less than or equal to count depending on the data available in the source TextReader. Returns -1 if the end of the stream is reached.</returns>
  851. </member>
  852. <member name="T:RestSharp.Compression.ZLib.Adler">
  853. <summary>
  854. Computes an Adler-32 checksum.
  855. </summary>
  856. <remarks>
  857. The Adler checksum is similar to a CRC checksum, but faster to compute, though less
  858. reliable. It is used in producing RFC1950 compressed streams. The Adler checksum
  859. is a required part of the "ZLIB" standard. Applications will almost never need to
  860. use this class directly.
  861. </remarks>
  862. </member>
  863. <member name="T:RestSharp.Compression.ZLib.ZlibCodec">
  864. <summary>
  865. Encoder and Decoder for ZLIB and DEFLATE (IETF RFC1950 and RFC1951).
  866. </summary>
  867. <remarks>
  868. This class compresses and decompresses data according to the Deflate algorithm
  869. and optionally, the ZLIB format, as documented in <see
  870. href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950 - ZLIB</see> and <see
  871. href="http://www.ietf.org/rfc/rfc1951.txt">RFC 1951 - DEFLATE</see>.
  872. </remarks>
  873. </member>
  874. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.InputBuffer">
  875. <summary>
  876. The buffer from which data is taken.
  877. </summary>
  878. </member>
  879. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.NextIn">
  880. <summary>
  881. An index into the InputBuffer array, indicating where to start reading.
  882. </summary>
  883. </member>
  884. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.AvailableBytesIn">
  885. <summary>
  886. The number of bytes available in the InputBuffer, starting at NextIn.
  887. </summary>
  888. <remarks>
  889. Generally you should set this to InputBuffer.Length before the first Inflate() or Deflate() call.
  890. The class will update this number as calls to Inflate/Deflate are made.
  891. </remarks>
  892. </member>
  893. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.TotalBytesIn">
  894. <summary>
  895. Total number of bytes read so far, through all calls to Inflate()/Deflate().
  896. </summary>
  897. </member>
  898. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.OutputBuffer">
  899. <summary>
  900. Buffer to store output data.
  901. </summary>
  902. </member>
  903. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.NextOut">
  904. <summary>
  905. An index into the OutputBuffer array, indicating where to start writing.
  906. </summary>
  907. </member>
  908. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.AvailableBytesOut">
  909. <summary>
  910. The number of bytes available in the OutputBuffer, starting at NextOut.
  911. </summary>
  912. <remarks>
  913. Generally you should set this to OutputBuffer.Length before the first Inflate() or Deflate() call.
  914. The class will update this number as calls to Inflate/Deflate are made.
  915. </remarks>
  916. </member>
  917. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.TotalBytesOut">
  918. <summary>
  919. Total number of bytes written to the output so far, through all calls to Inflate()/Deflate().
  920. </summary>
  921. </member>
  922. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.Message">
  923. <summary>
  924. used for diagnostics, when something goes wrong!
  925. </summary>
  926. </member>
  927. <member name="F:RestSharp.Compression.ZLib.ZlibCodec.WindowBits">
  928. <summary>
  929. The number of Window Bits to use.
  930. </summary>
  931. <remarks>
  932. This gauges the size of the sliding window, and hence the
  933. compression effectiveness as well as memory consumption. It's best to just leave this
  934. setting alone if you don't know what it is. The maximum value is 15 bits, which implies
  935. a 32k window.
  936. </remarks>
  937. </member>
  938. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.#ctor">
  939. <summary>
  940. Create a ZlibCodec that decompresses.
  941. </summary>
  942. </member>
  943. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate">
  944. <summary>
  945. Initialize the inflation state.
  946. </summary>
  947. <remarks>
  948. It is not necessary to call this before using the ZlibCodec to inflate data;
  949. It is implicitly called when you call the constructor.
  950. </remarks>
  951. <returns>Z_OK if everything goes well.</returns>
  952. </member>
  953. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Boolean)">
  954. <summary>
  955. Initialize the inflation state with an explicit flag to
  956. govern the handling of RFC1950 header bytes.
  957. </summary>
  958. <remarks>
  959. By default, the ZLIB header defined in <see
  960. href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950</see> is expected. If
  961. you want to read a zlib stream you should specify true for
  962. expectRfc1950Header. If you have a deflate stream, you will want to specify
  963. false. It is only necessary to invoke this initializer explicitly if you
  964. want to specify false.
  965. </remarks>
  966. <param name="expectRfc1950Header">whether to expect an RFC1950 header byte
  967. pair when reading the stream of data to be inflated.</param>
  968. <returns>Z_OK if everything goes well.</returns>
  969. </member>
  970. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Int32)">
  971. <summary>
  972. Initialize the ZlibCodec for inflation, with the specified number of window bits.
  973. </summary>
  974. <param name="windowBits">The number of window bits to use. If you need to ask what that is,
  975. then you shouldn't be calling this initializer.</param>
  976. <returns>Z_OK if all goes well.</returns>
  977. </member>
  978. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Int32,System.Boolean)">
  979. <summary>
  980. Initialize the inflation state with an explicit flag to govern the handling of
  981. RFC1950 header bytes.
  982. </summary>
  983. <remarks>
  984. If you want to read a zlib stream you should specify true for
  985. expectRfc1950Header. In this case, the library will expect to find a ZLIB
  986. header, as defined in <see href="http://www.ietf.org/rfc/rfc1950.txt">RFC
  987. 1950</see>, in the compressed stream. If you will be reading a DEFLATE or
  988. GZIP stream, which does not have such a header, you will want to specify
  989. false.
  990. </remarks>
  991. <param name="expectRfc1950Header">whether to expect an RFC1950 header byte pair when reading
  992. the stream of data to be inflated.</param>
  993. <param name="windowBits">The number of window bits to use. If you need to ask what that is,
  994. then you shouldn't be calling this initializer.</param>
  995. <returns>Z_OK if everything goes well.</returns>
  996. </member>
  997. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.Inflate(RestSharp.Compression.ZLib.FlushType)">
  998. <summary>
  999. Inflate the data in the InputBuffer, placing the result in the OutputBuffer.
  1000. </summary>
  1001. <remarks>
  1002. You must have set InputBuffer and OutputBuffer, NextIn and NextOut, and AvailableBytesIn and
  1003. AvailableBytesOut before calling this method.
  1004. </remarks>
  1005. <example>
  1006. <code>
  1007. private void InflateBuffer()
  1008. {
  1009. int bufferSize = 1024;
  1010. byte[] buffer = new byte[bufferSize];
  1011. ZlibCodec decompressor = new ZlibCodec();
  1012. Console.WriteLine("\n============================================");
  1013. Console.WriteLine("Size of Buffer to Inflate: {0} bytes.", CompressedBytes.Length);
  1014. MemoryStream ms = new MemoryStream(DecompressedBytes);
  1015. int rc = decompressor.InitializeInflate();
  1016. decompressor.InputBuffer = CompressedBytes;
  1017. decompressor.NextIn = 0;
  1018. decompressor.AvailableBytesIn = CompressedBytes.Length;
  1019. decompressor.OutputBuffer = buffer;
  1020. // pass 1: inflate
  1021. do
  1022. {
  1023. decompressor.NextOut = 0;
  1024. decompressor.AvailableBytesOut = buffer.Length;
  1025. rc = decompressor.Inflate(ZlibConstants.Z_NO_FLUSH);
  1026. if (rc != ZlibConstants.Z_OK &amp;&amp; rc != ZlibConstants.Z_STREAM_END)
  1027. throw new Exception("inflating: " + decompressor.Message);
  1028. ms.Write(decompressor.OutputBuffer, 0, buffer.Length - decompressor.AvailableBytesOut);
  1029. }
  1030. while (decompressor.AvailableBytesIn &gt; 0 || decompressor.AvailableBytesOut == 0);
  1031. // pass 2: finish and flush
  1032. do
  1033. {
  1034. decompressor.NextOut = 0;
  1035. decompressor.AvailableBytesOut = buffer.Length;
  1036. rc = decompressor.Inflate(ZlibConstants.Z_FINISH);
  1037. if (rc != ZlibConstants.Z_STREAM_END &amp;&amp; rc != ZlibConstants.Z_OK)
  1038. throw new Exception("inflating: " + decompressor.Message);
  1039. if (buffer.Length - decompressor.AvailableBytesOut &gt; 0)
  1040. ms.Write(buffer, 0, buffer.Length - decompressor.AvailableBytesOut);
  1041. }
  1042. while (decompressor.AvailableBytesIn &gt; 0 || decompressor.AvailableBytesOut == 0);
  1043. decompressor.EndInflate();
  1044. }
  1045. </code>
  1046. </example>
  1047. <param name="flush">The flush to use when inflating.</param>
  1048. <returns>Z_OK if everything goes well.</returns>
  1049. </member>
  1050. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.EndInflate">
  1051. <summary>
  1052. Ends an inflation session.
  1053. </summary>
  1054. <remarks>
  1055. Call this after successively calling Inflate(). This will cause all buffers to be flushed.
  1056. After calling this you cannot call Inflate() without a intervening call to one of the
  1057. InitializeInflate() overloads.
  1058. </remarks>
  1059. <returns>Z_OK if everything goes well.</returns>
  1060. </member>
  1061. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.SyncInflate">
  1062. <summary>
  1063. I don't know what this does!
  1064. </summary>
  1065. <returns>Z_OK if everything goes well.</returns>
  1066. </member>
  1067. <member name="M:RestSharp.Compression.ZLib.ZlibCodec.SetDictionary(System.Byte[])">
  1068. <summary>
  1069. Set the dictionary to be used for either Inflation or Deflation.
  1070. </summary>
  1071. <param name="dictionary">The dictionary bytes to use.</param>
  1072. <returns>Z_OK if all goes well.</returns>
  1073. </member>
  1074. <member name="P:RestSharp.Compression.ZLib.ZlibCodec.Adler32">
  1075. <summary>
  1076. The Adler32 checksum on the data transferred through the codec so far. You probably don't need to look at this.
  1077. </summary>
  1078. </member>
  1079. <member name="T:RestSharp.Compression.ZLib.ZlibConstants">
  1080. <summary>
  1081. A bunch of constants used in the Zlib interface.
  1082. </summary>
  1083. </member>
  1084. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.WindowBitsMax">
  1085. <summary>
  1086. The maximum number of window bits for the Deflate algorithm.
  1087. </summary>
  1088. </member>
  1089. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.WindowBitsDefault">
  1090. <summary>
  1091. The default number of window bits for the Deflate algorithm.
  1092. </summary>
  1093. </member>
  1094. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_OK">
  1095. <summary>
  1096. indicates everything is A-OK
  1097. </summary>
  1098. </member>
  1099. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_STREAM_END">
  1100. <summary>
  1101. Indicates that the last operation reached the end of the stream.
  1102. </summary>
  1103. </member>
  1104. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_NEED_DICT">
  1105. <summary>
  1106. The operation ended in need of a dictionary.
  1107. </summary>
  1108. </member>
  1109. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_STREAM_ERROR">
  1110. <summary>
  1111. There was an error with the stream - not enough data, not open and readable, etc.
  1112. </summary>
  1113. </member>
  1114. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_DATA_ERROR">
  1115. <summary>
  1116. There was an error with the data - not enough data, bad data, etc.
  1117. </summary>
  1118. </member>
  1119. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_BUF_ERROR">
  1120. <summary>
  1121. There was an error with the working buffer.
  1122. </summary>
  1123. </member>
  1124. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.WorkingBufferSizeDefault">
  1125. <summary>
  1126. The size of the working buffer used in the ZlibCodec class. Defaults to 8192 bytes.
  1127. </summary>
  1128. </member>
  1129. <member name="F:RestSharp.Compression.ZLib.ZlibConstants.WorkingBufferSizeMin">
  1130. <summary>
  1131. The minimum size of the working buffer used in the ZlibCodec class. Currently it is 128 bytes.
  1132. </summary>
  1133. </member>
  1134. <member name="T:RestSharp.Compression.ZLib.ZlibStream">
  1135. <summary>
  1136. Represents a Zlib stream for compression or decompression.
  1137. </summary>
  1138. <remarks>
  1139. <para>
  1140. The ZlibStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds ZLIB compression or decompression to any
  1141. stream.
  1142. </para>
  1143. <para> Using this stream, applications can compress or decompress data via
  1144. stream <c>Read</c> and <c>Write</c> operations. Either compresssion or
  1145. decompression can occur through either reading or writing. The compression
  1146. format used is ZLIB, which is documented in <see href="http://www.ietf.org/rfc/rfc1950.txt">IETF RFC 1950</see>, "ZLIB Compressed
  1147. Data Format Specification version 3.3". This implementation of ZLIB always uses
  1148. DEFLATE as the compression method. (see <see href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC 1951</see>, "DEFLATE
  1149. Compressed Data Format Specification version 1.3.") </para>
  1150. <para>
  1151. The ZLIB format allows for varying compression methods, window sizes, and dictionaries.
  1152. This implementation always uses the DEFLATE compression method, a preset dictionary,
  1153. and 15 window bits by default.
  1154. </para>
  1155. <para>
  1156. This class is similar to <see cref="!:DeflateStream"/>, except that it adds the
  1157. RFC1950 header and trailer bytes to a compressed stream when compressing, or expects
  1158. the RFC1950 header and trailer bytes when decompressing. It is also similar to the
  1159. <see cref="T:RestSharp.Compression.ZLib.GZipStream"/>.
  1160. </para>
  1161. </remarks>
  1162. <seealso cref="!:DeflateStream"/>
  1163. <seealso cref="T:RestSharp.Compression.ZLib.GZipStream"/>
  1164. </member>
  1165. <member name="M:RestSharp.Compression.ZLib.ZlibStream.Dispose(System.Boolean)">
  1166. <summary>
  1167. Dispose the stream.
  1168. </summary>
  1169. <remarks>
  1170. This may or may not result in a Close() call on the captive stream.
  1171. See the constructors that have a leaveOpen parameter for more information.
  1172. </remarks>
  1173. </member>
  1174. <member name="M:RestSharp.Compression.ZLib.ZlibStream.Flush">
  1175. <summary>
  1176. Flush the stream.
  1177. </summary>
  1178. </member>
  1179. <member name="M:RestSharp.Compression.ZLib.ZlibStream.Read(System.Byte[],System.Int32,System.Int32)">
  1180. <summary>
  1181. Read data from the stream.
  1182. </summary>
  1183. <remarks>
  1184. <para>
  1185. If you wish to use the ZlibStream to compress data while reading, you can create a
  1186. ZlibStream with CompressionMode.Compress, providing an uncompressed data stream. Then
  1187. call Read() on that ZlibStream, and the data read will be compressed. If you wish to
  1188. use the ZlibStream to decompress data while reading, you can create a ZlibStream with
  1189. CompressionMode.Decompress, providing a readable compressed data stream. Then call
  1190. Read() on that ZlibStream, and the data will be decompressed as it is read.
  1191. </para>
  1192. <para>
  1193. A ZlibStream can be used for Read() or Write(), but not both.
  1194. </para>
  1195. </remarks>
  1196. <param name="buffer">The buffer into which the read data should be placed.</param>
  1197. <param name="offset">the offset within that data array to put the first byte read.</param>
  1198. <param name="count">the number of bytes to read.</param>
  1199. </member>
  1200. <member name="M:RestSharp.Compression.ZLib.ZlibStream.Seek(System.Int64,System.IO.SeekOrigin)">
  1201. <summary>
  1202. Calling this method always throws a NotImplementedException.
  1203. </summary>
  1204. </member>
  1205. <member name="M:RestSharp.Compression.ZLib.ZlibStream.SetLength(System.Int64)">
  1206. <summary>
  1207. Calling this method always throws a NotImplementedException.
  1208. </summary>
  1209. </member>
  1210. <member name="M:RestSharp.Compression.ZLib.ZlibStream.Write(System.Byte[],System.Int32,System.Int32)">
  1211. <summary>
  1212. Write data to the stream.
  1213. </summary>
  1214. <remarks>
  1215. <para>
  1216. If you wish to use the ZlibStream to compress data while writing, you can create a
  1217. ZlibStream with CompressionMode.Compress, and a writable output stream. Then call
  1218. Write() on that ZlibStream, providing uncompressed data as input. The data sent to
  1219. the output stream will be the compressed form of the data written. If you wish to use
  1220. the ZlibStream to decompress data while writing, you can create a ZlibStream with
  1221. CompressionMode.Decompress, and a writable output stream. Then call Write() on that
  1222. stream, providing previously compressed data. The data sent to the output stream will
  1223. be the decompressed form of the data written.
  1224. </para>
  1225. <para>
  1226. A ZlibStream can be used for Read() or Write(), but not both.
  1227. </para>
  1228. </remarks>
  1229. <param name="buffer">The buffer holding data to write to the stream.</param>
  1230. <param name="offset">the offset within that data array to find the first byte to write.</param>
  1231. <param name="count">the number of bytes to write.</param>
  1232. </member>
  1233. <member name="M:RestSharp.Compression.ZLib.ZlibStream.UncompressString(System.Byte[])">
  1234. <summary>
  1235. Uncompress a byte array into a single string.
  1236. </summary>
  1237. <seealso cref="!:ZlibStream.CompressString(String)"/>
  1238. <param name="compressed">
  1239. A buffer containing ZLIB-compressed data.
  1240. </param>
  1241. </member>
  1242. <member name="M:RestSharp.Compression.ZLib.ZlibStream.UncompressBuffer(System.Byte[])">
  1243. <summary>
  1244. Uncompress a byte array into a byte array.
  1245. </summary>
  1246. <seealso cref="!:ZlibStream.CompressBuffer(byte[])"/>
  1247. <seealso cref="M:RestSharp.Compression.ZLib.ZlibStream.UncompressString(System.Byte[])"/>
  1248. <param name="compressed">
  1249. A buffer containing ZLIB-compressed data.
  1250. </param>
  1251. </member>
  1252. <member name="P:RestSharp.Compression.ZLib.ZlibStream.FlushMode">
  1253. <summary>
  1254. This property sets the flush behavior on the stream.
  1255. Sorry, though, not sure exactly how to describe all the various settings.
  1256. </summary>
  1257. </member>
  1258. <member name="P:RestSharp.Compression.ZLib.ZlibStream.BufferSize">
  1259. <summary>
  1260. The size of the working buffer for the compression codec.
  1261. </summary>
  1262. <remarks>
  1263. <para>
  1264. The working buffer is used for all stream operations. The default size is 1024 bytes.
  1265. The minimum size is 128 bytes. You may get better performance with a larger buffer.
  1266. Then again, you might not. You would have to test it.
  1267. </para>
  1268. <para>
  1269. Set this before the first call to Read() or Write() on the stream. If you try to set it
  1270. afterwards, it will throw.
  1271. </para>
  1272. </remarks>
  1273. </member>
  1274. <member name="P:RestSharp.Compression.ZLib.ZlibStream.TotalIn">
  1275. <summary> Returns the total number of bytes input so far.</summary>
  1276. </member>
  1277. <member name="P:RestSharp.Compression.ZLib.ZlibStream.TotalOut">
  1278. <summary> Returns the total number of bytes output so far.</summary>
  1279. </member>
  1280. <member name="P:RestSharp.Compression.ZLib.ZlibStream.CanRead">
  1281. <summary>
  1282. Indicates whether the stream can be read.
  1283. </summary>
  1284. <remarks>
  1285. The return value depends on whether the captive stream supports reading.
  1286. </remarks>
  1287. </member>
  1288. <member name="P:RestSharp.Compression.ZLib.ZlibStream.CanSeek">
  1289. <summary>
  1290. Indicates whether the stream supports Seek operations.
  1291. </summary>
  1292. <remarks>
  1293. Always returns false.
  1294. </remarks>
  1295. </member>
  1296. <member name="P:RestSharp.Compression.ZLib.ZlibStream.CanWrite">
  1297. <summary>
  1298. Indicates whether the stream can be written.
  1299. </summary>
  1300. <remarks>
  1301. The return value depends on whether the captive stream supports writing.
  1302. </remarks>
  1303. </member>
  1304. <member name="P:RestSharp.Compression.ZLib.ZlibStream.Length">
  1305. <summary>
  1306. Reading this property always throws a NotImplementedException.
  1307. </summary>
  1308. </member>
  1309. <member name="P:RestSharp.Compression.ZLib.ZlibStream.Position">
  1310. <summary>
  1311. The position of the stream pointer.
  1312. </summary>
  1313. <remarks>
  1314. Writing this property always throws a NotImplementedException. Reading will
  1315. return the total bytes written out, if used in writing, or the total bytes
  1316. read in, if used in reading. The count may refer to compressed bytes or
  1317. uncompressed bytes, depending on how you've used the stream.
  1318. </remarks>
  1319. </member>
  1320. <member name="T:RestSharp.Deserializers.DeserializeAsAttribute">
  1321. <summary>
  1322. Allows control how class and property names and values are deserialized by XmlAttributeDeserializer
  1323. </summary>
  1324. </member>
  1325. <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Name">
  1326. <summary>
  1327. The name to use for the serialized element
  1328. </summary>
  1329. </member>
  1330. <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Attribute">
  1331. <summary>
  1332. Sets if the property to Deserialize is an Attribute or Element (Default: false)
  1333. </summary>
  1334. </member>
  1335. <member name="T:RestSharp.Deserializers.DotNetXmlDeserializer">
  1336. <summary>
  1337. Wrapper for System.Xml.Serialization.XmlSerializer.
  1338. </summary>
  1339. </member>
  1340. <member name="T:RestSharp.ParameterType">
  1341. <summary>
  1342. Types of parameters that can be added to requests
  1343. </summary>
  1344. </member>
  1345. <member name="T:RestSharp.DataFormat">
  1346. <summary>
  1347. Data formats
  1348. </summary>
  1349. </member>
  1350. <member name="T:RestSharp.Method">
  1351. <summary>
  1352. HTTP method to use when making requests
  1353. </summary>
  1354. </member>
  1355. <member name="T:RestSharp.DateFormat">
  1356. <summary>
  1357. Format strings for commonly-used date formats
  1358. </summary>
  1359. </member>
  1360. <member name="F:RestSharp.DateFormat.Iso8601">
  1361. <summary>
  1362. .NET format string for ISO 8601 date format
  1363. </summary>
  1364. </member>
  1365. <member name="F:RestSharp.DateFormat.RoundTrip">
  1366. <summary>
  1367. .NET format string for roundtrip date format
  1368. </summary>
  1369. </member>
  1370. <member name="T:RestSharp.ResponseStatus">
  1371. <summary>
  1372. Status for responses (surprised?)
  1373. </summary>
  1374. </member>
  1375. <member name="T:RestSharp.Extensions.MiscExtensions">
  1376. <summary>
  1377. Extension method overload!
  1378. </summary>
  1379. </member>
  1380. <member name="M:RestSharp.Extensions.MiscExtensions.ReadAsBytes(System.IO.Stream)">
  1381. <summary>
  1382. Read a stream into a byte array
  1383. </summary>
  1384. <param name="input">Stream to read</param>
  1385. <returns>byte[]</returns>
  1386. </member>
  1387. <member name="M:RestSharp.Extensions.MiscExtensions.CopyTo(System.IO.Stream,System.IO.Stream)">
  1388. <summary>
  1389. Copies bytes from one stream to another
  1390. </summary>
  1391. <param name="input">The input stream.</param>
  1392. <param name="output">The output stream.</param>
  1393. </member>
  1394. <member name="M:RestSharp.Extensions.MiscExtensions.AsString(System.Byte[])">
  1395. <summary>
  1396. Converts a byte array to a string, using its byte order mark to convert it to the right encoding.
  1397. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx
  1398. </summary>
  1399. <param name="buffer">An array of bytes to convert</param>
  1400. <returns>The byte as a string.</returns>
  1401. </member>
  1402. <member name="T:RestSharp.Extensions.ReflectionExtensions">
  1403. <summary>
  1404. Reflection extensions
  1405. </summary>
  1406. </member>
  1407. <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Reflection.MemberInfo)">
  1408. <summary>
  1409. Retrieve an attribute from a member (property)
  1410. </summary>
  1411. <typeparam name="T">Type of attribute to retrieve</typeparam>
  1412. <param name="prop">Member to retrieve attribute from</param>
  1413. <returns></returns>
  1414. </member>
  1415. <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Type)">
  1416. <summary>
  1417. Retrieve an attribute from a type
  1418. </summary>
  1419. <typeparam name="T">Type of attribute to retrieve</typeparam>
  1420. <param name="type">Type to retrieve attribute from</param>
  1421. <returns></returns>
  1422. </member>
  1423. <member name="M:RestSharp.Extensions.ReflectionExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)">
  1424. <summary>
  1425. Checks a type to see if it derives from a raw generic (e.g. List[[]])
  1426. </summary>
  1427. <param name="toCheck"></param>
  1428. <param name="generic"></param>
  1429. <returns></returns>
  1430. </member>
  1431. <member name="M:RestSharp.Extensions.ReflectionExtensions.FindEnumValue(System.Type,System.String,System.Globalization.CultureInfo)">
  1432. <summary>
  1433. Find a value from a System.Enum by trying several possible variants
  1434. of the string value of the enum.
  1435. </summary>
  1436. <param name="type">Type of enum</param>
  1437. <param name="value">Value for which to search</param>
  1438. <param name="culture">The culture used to calculate the name variants</param>
  1439. <returns></returns>
  1440. </member>
  1441. <member name="M:RestSharp.Extensions.StringExtensions.UrlEncode(System.String)">
  1442. <summary>
  1443. Uses Uri.EscapeDataString() based on recommendations on MSDN
  1444. http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx
  1445. </summary>
  1446. </member>
  1447. <member name="M:RestSharp.Extensions.StringExtensions.HasValue(System.String)">
  1448. <summary>
  1449. Check that a string is not null or empty
  1450. </summary>
  1451. <param name="input">String to check</param>
  1452. <returns>bool</returns>
  1453. </member>
  1454. <member name="M:RestSharp.Extensions.StringExtensions.RemoveUnderscoresAndDashes(System.String)">
  1455. <summary>
  1456. Remove underscores from a string
  1457. </summary>
  1458. <param name="input">String to process</param>
  1459. <returns>string</returns>
  1460. </member>
  1461. <member name="M:RestSharp.Extensions.StringExtensions.ParseJsonDate(System.String,System.Globalization.CultureInfo)">
  1462. <summary>
  1463. Parses most common JSON date formats
  1464. </summary>
  1465. <param name="input">JSON value to parse</param>
  1466. <param name="culture"></param>
  1467. <returns>DateTime</returns>
  1468. </member>
  1469. <member name="M:RestSharp.Extensions.StringExtensions.RemoveSurroundingQuotes(System.String)">
  1470. <summary>
  1471. Remove leading and trailing " from a string
  1472. </summary>
  1473. <param name="input">String to parse</param>
  1474. <returns>String</returns>
  1475. </member>
  1476. <member name="M:RestSharp.Extensions.StringExtensions.Matches(System.String,System.String)">
  1477. <summary>
  1478. Checks a string to see if it matches a regex
  1479. </summary>
  1480. <param name="input">String to check</param>
  1481. <param name="pattern">Pattern to match</param>
  1482. <returns>bool</returns>
  1483. </member>
  1484. <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Globalization.CultureInfo)">
  1485. <summary>
  1486. Converts a string to pascal case
  1487. </summary>
  1488. <param name="lowercaseAndUnderscoredWord">String to convert</param>
  1489. <param name="culture"></param>
  1490. <returns>string</returns>
  1491. </member>
  1492. <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Boolean,System.Globalization.CultureInfo)">
  1493. <summary>
  1494. Converts a string to pascal case with the option to remove underscores
  1495. </summary>
  1496. <param name="text">String to convert</param>
  1497. <param name="removeUnderscores">Option to remove underscores</param>
  1498. <param name="culture"></param>
  1499. <returns></returns>
  1500. </member>
  1501. <member name="M:RestSharp.Extensions.StringExtensions.ToCamelCase(System.String,System.Globalization.CultureInfo)">
  1502. <summary>
  1503. Converts a string to camel case
  1504. </summary>
  1505. <param name="lowercaseAndUnderscoredWord">String to convert</param>
  1506. <param name="culture"></param>
  1507. <returns>String</returns>
  1508. </member>
  1509. <member name="M:RestSharp.Extensions.StringExtensions.MakeInitialLowerCase(System.String)">
  1510. <summary>
  1511. Convert the first letter of a string to lower case
  1512. </summary>
  1513. <param name="word">String to convert</param>
  1514. <returns>string</returns>
  1515. </member>
  1516. <member name="M:RestSharp.Extensions.StringExtensions.IsUpperCase(System.String)">
  1517. <summary>
  1518. Checks to see if a string is all uppper case
  1519. </summary>
  1520. <param name="inputString">String to check</param>
  1521. <returns>bool</returns>
  1522. </member>
  1523. <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscores(System.String)">
  1524. <summary>
  1525. Add underscores to a pascal-cased string
  1526. </summary>
  1527. <param name="pascalCasedWord">String to convert</param>
  1528. <returns>string</returns>
  1529. </member>
  1530. <member name="M:RestSharp.Extensions.StringExtensions.AddDashes(System.String)">
  1531. <summary>
  1532. Add dashes to a pascal-cased string
  1533. </summary>
  1534. <param name="pascalCasedWord">String to convert</param>
  1535. <returns>string</returns>
  1536. </member>
  1537. <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscorePrefix(System.String)">
  1538. <summary>
  1539. Add an undescore prefix to a pascasl-cased string
  1540. </summary>
  1541. <param name="pascalCasedWord"></param>
  1542. <returns></returns>
  1543. </member>
  1544. <member name="M:RestSharp.Extensions.StringExtensions.AddSpaces(System.String)">
  1545. <summary>
  1546. Add spaces to a pascal-cased string
  1547. </summary>
  1548. <param name="pascalCasedWord">String to convert</param>
  1549. <returns>string</returns>
  1550. </member>
  1551. <member name="M:RestSharp.Extensions.StringExtensions.GetNameVariants(System.String,System.Globalization.CultureInfo)">
  1552. <summary>
  1553. Return possible variants of a name for name matching.
  1554. </summary>
  1555. <param name="name">String to convert</param>
  1556. <param name="culture">The culture to use for conversion</param>
  1557. <returns>IEnumerable&lt;string&gt;</returns>
  1558. </member>
  1559. <member name="T:RestSharp.Extensions.XmlExtensions">
  1560. <summary>
  1561. XML Extension Methods
  1562. </summary>
  1563. </member>
  1564. <member name="M:RestSharp.Extensions.XmlExtensions.AsNamespaced(System.String,System.String)">
  1565. <summary>
  1566. Returns the name of an element with the namespace if specified
  1567. </summary>
  1568. <param name="name">Element name</param>
  1569. <param name="namespace">XML Namespace</param>
  1570. <returns></returns>
  1571. </member>
  1572. <member name="T:RestSharp.FileParameter">
  1573. <summary>
  1574. Container for files to be uploaded with requests
  1575. </summary>
  1576. </member>
  1577. <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String,System.String)">
  1578. <summary>
  1579. Creates a file parameter from an array of bytes.
  1580. </summary>
  1581. <param name="name">The parameter name to use in the request.</param>
  1582. <param name="data">The data to use as the file's contents.</param>
  1583. <param name="filename">The filename to use in the request.</param>
  1584. <param name="contentType">The content type to use in the request.</param>
  1585. <returns>The <see cref="T:RestSharp.FileParameter"/></returns>
  1586. </member>
  1587. <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String)">
  1588. <summary>
  1589. Creates a file parameter from an array of bytes.
  1590. </summary>
  1591. <param name="name">The parameter name to use in the request.</param>
  1592. <param name="data">The data to use as the file's contents.</param>
  1593. <param name="filename">The filename to use in the request.</param>
  1594. <returns>The <see cref="T:RestSharp.FileParameter"/> using the default content type.</returns>
  1595. </member>
  1596. <member name="P:RestSharp.FileParameter.ContentLength">
  1597. <summary>
  1598. The length of data to be sent
  1599. </summary>
  1600. </member>
  1601. <member name="P:RestSharp.FileParameter.Writer">
  1602. <summary>
  1603. Provides raw data for file
  1604. </summary>
  1605. </member>
  1606. <member name="P:RestSharp.FileParameter.FileName">
  1607. <summary>
  1608. Name of the file to use when uploading
  1609. </summary>
  1610. </member>
  1611. <member name="P:RestSharp.FileParameter.ContentType">
  1612. <summary>
  1613. MIME content type of file
  1614. </summary>
  1615. </member>
  1616. <member name="P:RestSharp.FileParameter.Name">
  1617. <summary>
  1618. Name of the parameter
  1619. </summary>
  1620. </member>
  1621. <member name="T:RestSharp.Http">
  1622. <summary>
  1623. HttpWebRequest wrapper (async methods)
  1624. </summary>
  1625. <summary>
  1626. HttpWebRequest wrapper
  1627. </summary>
  1628. </member>
  1629. <member name="P:RestSharp.IHttp.AlwaysMultipartFormData">
  1630. <summary>
  1631. Always send a multipart/form-data request - even when no Files are present.
  1632. </summary>
  1633. </member>
  1634. <member name="P:RestSharp.IHttp.RequestBodyBytes">
  1635. <summary>
  1636. An alternative to RequestBody, for when the caller already has the byte array.
  1637. </summary>
  1638. </member>
  1639. <member name="M:RestSharp.Http.AsPostAsync(System.Action{RestSharp.HttpResponse},System.String)">
  1640. <summary>
  1641. Execute an async POST-style request with the specified HTTP Method.
  1642. </summary>
  1643. <param name="action"></param>
  1644. <param name="httpMethod">The HTTP method to execute.</param>
  1645. <returns></returns>
  1646. </member>
  1647. <member name="M:RestSharp.Http.AsGetAsync(System.Action{RestSharp.HttpResponse},System.String)">
  1648. <summary>
  1649. Execute an async GET-style request with the specified HTTP Method.
  1650. </summary>
  1651. <param name="action"></param>
  1652. <param name="httpMethod">The HTTP method to execute.</param>
  1653. <returns></returns>
  1654. </member>
  1655. <member name="M:RestSharp.Http.Create">
  1656. <summary>
  1657. Creates an IHttp
  1658. </summary>
  1659. <returns></returns>
  1660. </member>
  1661. <member name="M:RestSharp.Http.#ctor">
  1662. <summary>
  1663. Default constructor
  1664. </summary>
  1665. </member>
  1666. <member name="P:RestSharp.Http.HasParameters">
  1667. <summary>
  1668. True if this HTTP request has any HTTP parameters
  1669. </summary>
  1670. </member>
  1671. <member name="P:RestSharp.Http.HasCookies">
  1672. <summary>
  1673. True if this HTTP request has any HTTP cookies
  1674. </summary>
  1675. </member>
  1676. <member name="P:RestSharp.Http.HasBody">
  1677. <summary>
  1678. True if a request body has been specified
  1679. </summary>
  1680. </member>
  1681. <member name="P:RestSharp.Http.HasFiles">
  1682. <summary>
  1683. True if files have been set to be uploaded
  1684. </summary>
  1685. </member>
  1686. <member name="P:RestSharp.Http.AlwaysMultipartFormData">
  1687. <summary>
  1688. Always send a multipart/form-data request - even when no Files are present.
  1689. </summary>
  1690. </member>
  1691. <member name="P:RestSharp.Http.UserAgent">
  1692. <summary>
  1693. UserAgent to be sent with request
  1694. </summary>
  1695. </member>
  1696. <member name="P:RestSharp.Http.Timeout">
  1697. <summary>
  1698. Timeout in milliseconds to be used for the request
  1699. </summary>
  1700. </member>
  1701. <member name="P:RestSharp.Http.ReadWriteTimeout">
  1702. <summary>
  1703. The number of milliseconds before the writing or reading times out.
  1704. </summary>
  1705. </member>
  1706. <member name="P:RestSharp.Http.Credentials">
  1707. <summary>
  1708. System.Net.ICredentials to be sent with request
  1709. </summary>
  1710. </member>
  1711. <member name="P:RestSharp.Http.CookieContainer">
  1712. <summary>
  1713. The System.Net.CookieContainer to be used for the request
  1714. </summary>
  1715. </member>
  1716. <member name="P:RestSharp.Http.ResponseWriter">
  1717. <summary>
  1718. The method to use to write the response instead of reading into RawBytes
  1719. </summary>
  1720. </member>
  1721. <member name="P:RestSharp.Http.Files">
  1722. <summary>
  1723. Collection of files to be sent with request
  1724. </summary>
  1725. </member>
  1726. <member name="P:RestSharp.Http.FollowRedirects">
  1727. <summary>
  1728. Whether or not HTTP 3xx response redirects should be automatically followed
  1729. </summary>
  1730. </member>
  1731. <member name="P:RestSharp.Http.UseDefaultCredentials">
  1732. <summary>
  1733. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  1734. will be sent along to the server.
  1735. </summary>
  1736. </member>
  1737. <member name="P:RestSharp.Http.Headers">
  1738. <summary>
  1739. HTTP headers to be sent with request
  1740. </summary>
  1741. </member>
  1742. <member name="P:RestSharp.Http.Parameters">
  1743. <summary>
  1744. HTTP parameters (QueryString or Form values) to be sent with request
  1745. </summary>
  1746. </member>
  1747. <member name="P:RestSharp.Http.Cookies">
  1748. <summary>
  1749. HTTP cookies to be sent with request
  1750. </summary>
  1751. </member>
  1752. <member name="P:RestSharp.Http.RequestBody">
  1753. <summary>
  1754. Request body to be sent with request
  1755. </summary>
  1756. </member>
  1757. <member name="P:RestSharp.Http.RequestContentType">
  1758. <summary>
  1759. Content type of the request body.
  1760. </summary>
  1761. </member>
  1762. <member name="P:RestSharp.Http.RequestBodyBytes">
  1763. <summary>
  1764. An alternative to RequestBody, for when the caller already has the byte array.
  1765. </summary>
  1766. </member>
  1767. <member name="P:RestSharp.Http.Url">
  1768. <summary>
  1769. URL to call for this request
  1770. </summary>
  1771. </member>
  1772. <member name="P:RestSharp.Http.PreAuthenticate">
  1773. <summary>
  1774. Flag to send authorisation header with the HttpWebRequest
  1775. </summary>
  1776. </member>
  1777. <member name="T:RestSharp.HttpCookie">
  1778. <summary>
  1779. Representation of an HTTP cookie
  1780. </summary>
  1781. </member>
  1782. <member name="P:RestSharp.HttpCookie.Comment">
  1783. <summary>
  1784. Comment of the cookie
  1785. </summary>
  1786. </member>
  1787. <member name="P:RestSharp.HttpCookie.CommentUri">
  1788. <summary>
  1789. Comment of the cookie
  1790. </summary>
  1791. </member>
  1792. <member name="P:RestSharp.HttpCookie.Discard">
  1793. <summary>
  1794. Indicates whether the cookie should be discarded at the end of the session
  1795. </summary>
  1796. </member>
  1797. <member name="P:RestSharp.HttpCookie.Domain">
  1798. <summary>
  1799. Domain of the cookie
  1800. </summary>
  1801. </member>
  1802. <member name="P:RestSharp.HttpCookie.Expired">
  1803. <summary>
  1804. Indicates whether the cookie is expired
  1805. </summary>
  1806. </member>
  1807. <member name="P:RestSharp.HttpCookie.Expires">
  1808. <summary>
  1809. Date and time that the cookie expires
  1810. </summary>
  1811. </member>
  1812. <member name="P:RestSharp.HttpCookie.HttpOnly">
  1813. <summary>
  1814. Indicates that this cookie should only be accessed by the server
  1815. </summary>
  1816. </member>
  1817. <member name="P:RestSharp.HttpCookie.Name">
  1818. <summary>
  1819. Name of the cookie
  1820. </summary>
  1821. </member>
  1822. <member name="P:RestSharp.HttpCookie.Path">
  1823. <summary>
  1824. Path of the cookie
  1825. </summary>
  1826. </member>
  1827. <member name="P:RestSharp.HttpCookie.Port">
  1828. <summary>
  1829. Port of the cookie
  1830. </summary>
  1831. </member>
  1832. <member name="P:RestSharp.HttpCookie.Secure">
  1833. <summary>
  1834. Indicates that the cookie should only be sent over secure channels
  1835. </summary>
  1836. </member>
  1837. <member name="P:RestSharp.HttpCookie.TimeStamp">
  1838. <summary>
  1839. Date and time the cookie was created
  1840. </summary>
  1841. </member>
  1842. <member name="P:RestSharp.HttpCookie.Value">
  1843. <summary>
  1844. Value of the cookie
  1845. </summary>
  1846. </member>
  1847. <member name="P:RestSharp.HttpCookie.Version">
  1848. <summary>
  1849. Version of the cookie
  1850. </summary>
  1851. </member>
  1852. <member name="T:RestSharp.HttpFile">
  1853. <summary>
  1854. Container for HTTP file
  1855. </summary>
  1856. </member>
  1857. <member name="P:RestSharp.HttpFile.ContentLength">
  1858. <summary>
  1859. The length of data to be sent
  1860. </summary>
  1861. </member>
  1862. <member name="P:RestSharp.HttpFile.Writer">
  1863. <summary>
  1864. Provides raw data for file
  1865. </summary>
  1866. </member>
  1867. <member name="P:RestSharp.HttpFile.FileName">
  1868. <summary>
  1869. Name of the file to use when uploading
  1870. </summary>
  1871. </member>
  1872. <member name="P:RestSharp.HttpFile.ContentType">
  1873. <summary>
  1874. MIME content type of file
  1875. </summary>
  1876. </member>
  1877. <member name="P:RestSharp.HttpFile.Name">
  1878. <summary>
  1879. Name of the parameter
  1880. </summary>
  1881. </member>
  1882. <member name="T:RestSharp.HttpHeader">
  1883. <summary>
  1884. Representation of an HTTP header
  1885. </summary>
  1886. </member>
  1887. <member name="P:RestSharp.HttpHeader.Name">
  1888. <summary>
  1889. Name of the header
  1890. </summary>
  1891. </member>
  1892. <member name="P:RestSharp.HttpHeader.Value">
  1893. <summary>
  1894. Value of the header
  1895. </summary>
  1896. </member>
  1897. <member name="T:RestSharp.HttpParameter">
  1898. <summary>
  1899. Representation of an HTTP parameter (QueryString or Form value)
  1900. </summary>
  1901. </member>
  1902. <member name="P:RestSharp.HttpParameter.Name">
  1903. <summary>
  1904. Name of the parameter
  1905. </summary>
  1906. </member>
  1907. <member name="P:RestSharp.HttpParameter.Value">
  1908. <summary>
  1909. Value of the parameter
  1910. </summary>
  1911. </member>
  1912. <member name="T:RestSharp.HttpResponse">
  1913. <summary>
  1914. HTTP response data
  1915. </summary>
  1916. </member>
  1917. <member name="T:RestSharp.IHttpResponse">
  1918. <summary>
  1919. HTTP response data
  1920. </summary>
  1921. </member>
  1922. <member name="P:RestSharp.IHttpResponse.ContentType">
  1923. <summary>
  1924. MIME content type of response
  1925. </summary>
  1926. </member>
  1927. <member name="P:RestSharp.IHttpResponse.ContentLength">
  1928. <summary>
  1929. Length in bytes of the response content
  1930. </summary>
  1931. </member>
  1932. <member name="P:RestSharp.IHttpResponse.ContentEncoding">
  1933. <summary>
  1934. Encoding of the response content
  1935. </summary>
  1936. </member>
  1937. <member name="P:RestSharp.IHttpResponse.Content">
  1938. <summary>
  1939. String representation of response content
  1940. </summary>
  1941. </member>
  1942. <member name="P:RestSharp.IHttpResponse.StatusCode">
  1943. <summary>
  1944. HTTP response status code
  1945. </summary>
  1946. </member>
  1947. <member name="P:RestSharp.IHttpResponse.StatusDescription">
  1948. <summary>
  1949. Description of HTTP status returned
  1950. </summary>
  1951. </member>
  1952. <member name="P:RestSharp.IHttpResponse.RawBytes">
  1953. <summary>
  1954. Response content
  1955. </summary>
  1956. </member>
  1957. <member name="P:RestSharp.IHttpResponse.ResponseUri">
  1958. <summary>
  1959. The URL that actually responded to the content (different from request if redirected)
  1960. </summary>
  1961. </member>
  1962. <member name="P:RestSharp.IHttpResponse.Server">
  1963. <summary>
  1964. HttpWebResponse.Server
  1965. </summary>
  1966. </member>
  1967. <member name="P:RestSharp.IHttpResponse.Headers">
  1968. <summary>
  1969. Headers returned by server with the response
  1970. </summary>
  1971. </member>
  1972. <member name="P:RestSharp.IHttpResponse.Cookies">
  1973. <summary>
  1974. Cookies returned by server with the response
  1975. </summary>
  1976. </member>
  1977. <member name="P:RestSharp.IHttpResponse.ResponseStatus">
  1978. <summary>
  1979. Status of the request. Will return Error for transport errors.
  1980. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  1981. </summary>
  1982. </member>
  1983. <member name="P:RestSharp.IHttpResponse.ErrorMessage">
  1984. <summary>
  1985. Transport or other non-HTTP error generated while attempting request
  1986. </summary>
  1987. </member>
  1988. <member name="P:RestSharp.IHttpResponse.ErrorException">
  1989. <summary>
  1990. Exception thrown when error is encountered.
  1991. </summary>
  1992. </member>
  1993. <member name="M:RestSharp.HttpResponse.#ctor">
  1994. <summary>
  1995. Default constructor
  1996. </summary>
  1997. </member>
  1998. <member name="P:RestSharp.HttpResponse.ContentType">
  1999. <summary>
  2000. MIME content type of response
  2001. </summary>
  2002. </member>
  2003. <member name="P:RestSharp.HttpResponse.ContentLength">
  2004. <summary>
  2005. Length in bytes of the response content
  2006. </summary>
  2007. </member>
  2008. <member name="P:RestSharp.HttpResponse.ContentEncoding">
  2009. <summary>
  2010. Encoding of the response content
  2011. </summary>
  2012. </member>
  2013. <member name="P:RestSharp.HttpResponse.Content">
  2014. <summary>
  2015. Lazy-loaded string representation of response content
  2016. </summary>
  2017. </member>
  2018. <member name="P:RestSharp.HttpResponse.StatusCode">
  2019. <summary>
  2020. HTTP response status code
  2021. </summary>
  2022. </member>
  2023. <member name="P:RestSharp.HttpResponse.StatusDescription">
  2024. <summary>
  2025. Description of HTTP status returned
  2026. </summary>
  2027. </member>
  2028. <member name="P:RestSharp.HttpResponse.RawBytes">
  2029. <summary>
  2030. Response content
  2031. </summary>
  2032. </member>
  2033. <member name="P:RestSharp.HttpResponse.ResponseUri">
  2034. <summary>
  2035. The URL that actually responded to the content (different from request if redirected)
  2036. </summary>
  2037. </member>
  2038. <member name="P:RestSharp.HttpResponse.Server">
  2039. <summary>
  2040. HttpWebResponse.Server
  2041. </summary>
  2042. </member>
  2043. <member name="P:RestSharp.HttpResponse.Headers">
  2044. <summary>
  2045. Headers returned by server with the response
  2046. </summary>
  2047. </member>
  2048. <member name="P:RestSharp.HttpResponse.Cookies">
  2049. <summary>
  2050. Cookies returned by server with the response
  2051. </summary>
  2052. </member>
  2053. <member name="P:RestSharp.HttpResponse.ResponseStatus">
  2054. <summary>
  2055. Status of the request. Will return Error for transport errors.
  2056. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  2057. </summary>
  2058. </member>
  2059. <member name="P:RestSharp.HttpResponse.ErrorMessage">
  2060. <summary>
  2061. Transport or other non-HTTP error generated while attempting request
  2062. </summary>
  2063. </member>
  2064. <member name="P:RestSharp.HttpResponse.ErrorException">
  2065. <summary>
  2066. Exception thrown when error is encountered.
  2067. </summary>
  2068. </member>
  2069. <member name="T:RestSharp.IRestClient">
  2070. <summary>
  2071. </summary>
  2072. </member>
  2073. <member name="M:RestSharp.IRestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})">
  2074. <summary>
  2075. </summary>
  2076. <param name="request"></param>
  2077. <param name="callback"></param>
  2078. </member>
  2079. <member name="M:RestSharp.IRestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})">
  2080. <summary>
  2081. </summary>
  2082. <param name="request"></param>
  2083. <param name="callback"></param>
  2084. </member>
  2085. <member name="M:RestSharp.IRestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  2086. <summary>
  2087. Executes a GET-style request and callback asynchronously, authenticating if needed
  2088. </summary>
  2089. <param name="request">Request to be executed</param>
  2090. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  2091. <param name="httpMethod">The HTTP method to execute</param>
  2092. </member>
  2093. <member name="M:RestSharp.IRestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  2094. <summary>
  2095. Executes a POST-style request and callback asynchronously, authenticating if needed
  2096. </summary>
  2097. <param name="request">Request to be executed</param>
  2098. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  2099. <param name="httpMethod">The HTTP method to execute</param>
  2100. </member>
  2101. <member name="M:RestSharp.IRestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  2102. <summary>
  2103. Executes a GET-style request and callback asynchronously, authenticating if needed
  2104. </summary>
  2105. <typeparam name="T">Target deserialization type</typeparam>
  2106. <param name="request">Request to be executed</param>
  2107. <param name="callback">Callback function to be executed upon completion</param>
  2108. <param name="httpMethod">The HTTP method to execute</param>
  2109. </member>
  2110. <member name="M:RestSharp.IRestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  2111. <summary>
  2112. Executes a GET-style request and callback asynchronously, authenticating if needed
  2113. </summary>
  2114. <typeparam name="T">Target deserialization type</typeparam>
  2115. <param name="request">Request to be executed</param>
  2116. <param name="callback">Callback function to be executed upon completion</param>
  2117. <param name="httpMethod">The HTTP method to execute</param>
  2118. </member>
  2119. <member name="P:RestSharp.IRestClient.CookieContainer">
  2120. <summary>
  2121. </summary>
  2122. </member>
  2123. <member name="P:RestSharp.IRestClient.UserAgent">
  2124. <summary>
  2125. </summary>
  2126. </member>
  2127. <member name="P:RestSharp.IRestClient.Timeout">
  2128. <summary>
  2129. </summary>
  2130. </member>
  2131. <member name="P:RestSharp.IRestClient.ReadWriteTimeout">
  2132. <summary>
  2133. </summary>
  2134. </member>
  2135. <member name="P:RestSharp.IRestClient.UseSynchronizationContext">
  2136. <summary>
  2137. </summary>
  2138. </member>
  2139. <member name="P:RestSharp.IRestClient.Authenticator">
  2140. <summary>
  2141. </summary>
  2142. </member>
  2143. <member name="P:RestSharp.IRestClient.BaseUrl">
  2144. <summary>
  2145. </summary>
  2146. </member>
  2147. <member name="P:RestSharp.IRestClient.PreAuthenticate">
  2148. <summary>
  2149. </summary>
  2150. </member>
  2151. <member name="P:RestSharp.IRestClient.DefaultParameters">
  2152. <summary>
  2153. </summary>
  2154. </member>
  2155. <member name="M:RestSharp.IRestRequest.AddBody(System.Object,System.String)">
  2156. <summary>
  2157. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  2158. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  2159. </summary>
  2160. <param name="obj">The object to serialize</param>
  2161. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  2162. <returns>This request</returns>
  2163. </member>
  2164. <member name="M:RestSharp.IRestRequest.AddBody(System.Object)">
  2165. <summary>
  2166. Serializes obj to data format specified by RequestFormat and adds it to the request body.
  2167. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  2168. </summary>
  2169. <param name="obj">The object to serialize</param>
  2170. <returns>This request</returns>
  2171. </member>
  2172. <member name="M:RestSharp.IRestRequest.AddJsonBody(System.Object)">
  2173. <summary>
  2174. Serializes obj to JSON format and adds it to the request body.
  2175. </summary>
  2176. <param name="obj">The object to serialize</param>
  2177. <returns>This request</returns>
  2178. </member>
  2179. <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object)">
  2180. <summary>
  2181. Serializes obj to XML format and adds it to the request body.
  2182. </summary>
  2183. <param name="obj">The object to serialize</param>
  2184. <returns>This request</returns>
  2185. </member>
  2186. <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object,System.String)">
  2187. <summary>
  2188. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  2189. Serializes obj to XML format and passes xmlNamespace then adds it to the request body.
  2190. </summary>
  2191. <param name="obj">The object to serialize</param>
  2192. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  2193. <returns>This request</returns>
  2194. </member>
  2195. <member name="M:RestSharp.IRestRequest.AddObject(System.Object,System.String[])">
  2196. <summary>
  2197. Calls AddParameter() for all public, readable properties specified in the includedProperties list
  2198. </summary>
  2199. <example>
  2200. request.AddObject(product, "ProductId", "Price", ...);
  2201. </example>
  2202. <param name="obj">The object with properties to add as parameters</param>
  2203. <param name="includedProperties">The names of the properties to include</param>
  2204. <returns>This request</returns>
  2205. </member>
  2206. <member name="M:RestSharp.IRestRequest.AddObject(System.Object)">
  2207. <summary>
  2208. Calls AddParameter() for all public, readable properties of obj
  2209. </summary>
  2210. <param name="obj">The object with properties to add as parameters</param>
  2211. <returns>This request</returns>
  2212. </member>
  2213. <member name="M:RestSharp.IRestRequest.AddParameter(RestSharp.Parameter)">
  2214. <summary>
  2215. Add the parameter to the request
  2216. </summary>
  2217. <param name="p">Parameter to add</param>
  2218. <returns></returns>
  2219. </member>
  2220. <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object)">
  2221. <summary>
  2222. Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  2223. </summary>
  2224. <param name="name">Name of the parameter</param>
  2225. <param name="value">Value of the parameter</param>
  2226. <returns>This request</returns>
  2227. </member>
  2228. <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)">
  2229. <summary>
  2230. Adds a parameter to the request. There are five types of parameters:
  2231. - GetOrPost: Either a QueryString value or encoded form value based on method
  2232. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  2233. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  2234. - Cookie: Adds the name/value pair to the HTTP request's Cookies collection
  2235. - RequestBody: Used by AddBody() (not recommended to use directly)
  2236. </summary>
  2237. <param name="name">Name of the parameter</param>
  2238. <param name="value">Value of the parameter</param>
  2239. <param name="type">The type of parameter to add</param>
  2240. <returns>This request</returns>
  2241. </member>
  2242. <member name="M:RestSharp.IRestRequest.AddHeader(System.String,System.String)">
  2243. <summary>
  2244. Shortcut to AddParameter(name, value, HttpHeader) overload
  2245. </summary>
  2246. <param name="name">Name of the header to add</param>
  2247. <param name="value">Value of the header to add</param>
  2248. <returns></returns>
  2249. </member>
  2250. <member name="M:RestSharp.IRestRequest.AddCookie(System.String,System.String)">
  2251. <summary>
  2252. Shortcut to AddParameter(name, value, Cookie) overload
  2253. </summary>
  2254. <param name="name">Name of the cookie to add</param>
  2255. <param name="value">Value of the cookie to add</param>
  2256. <returns></returns>
  2257. </member>
  2258. <member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.String)">
  2259. <summary>
  2260. Shortcut to AddParameter(name, value, UrlSegment) overload
  2261. </summary>
  2262. <param name="name">Name of the segment to add</param>
  2263. <param name="value">Value of the segment to add</param>
  2264. <returns></returns>
  2265. </member>
  2266. <member name="M:RestSharp.IRestRequest.AddQueryParameter(System.String,System.String)">
  2267. <summary>
  2268. Shortcut to AddParameter(name, value, QueryString) overload
  2269. </summary>
  2270. <param name="name">Name of the parameter to add</param>
  2271. <param name="value">Value of the parameter to add</param>
  2272. <returns></returns>
  2273. </member>
  2274. <member name="P:RestSharp.IRestRequest.AlwaysMultipartFormData">
  2275. <summary>
  2276. Always send a multipart/form-data request - even when no Files are present.
  2277. </summary>
  2278. </member>
  2279. <member name="P:RestSharp.IRestRequest.JsonSerializer">
  2280. <summary>
  2281. Serializer to use when writing JSON request bodies. Used if RequestFormat is Json.
  2282. By default the included JsonSerializer is used (currently using JSON.NET default serialization).
  2283. </summary>
  2284. </member>
  2285. <member name="P:RestSharp.IRestRequest.XmlSerializer">
  2286. <summary>
  2287. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  2288. By default the included XmlSerializer is used.
  2289. </summary>
  2290. </member>
  2291. <member name="P:RestSharp.IRestRequest.ResponseWriter">
  2292. <summary>
  2293. Set this to write response to Stream rather than reading into memory.
  2294. </summary>
  2295. </member>
  2296. <member name="P:RestSharp.IRestRequest.Parameters">
  2297. <summary>
  2298. Container of all HTTP parameters to be passed with the request.
  2299. See AddParameter() for explanation of the types of parameters that can be passed
  2300. </summary>
  2301. </member>
  2302. <member name="P:RestSharp.IRestRequest.Files">
  2303. <summary>
  2304. Container of all the files to be uploaded with the request.
  2305. </summary>
  2306. </member>
  2307. <member name="P:RestSharp.IRestRequest.Method">
  2308. <summary>
  2309. Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS
  2310. Default is GET
  2311. </summary>
  2312. </member>
  2313. <member name="P:RestSharp.IRestRequest.Resource">
  2314. <summary>
  2315. The Resource URL to make the request against.
  2316. Tokens are substituted with UrlSegment parameters and match by name.
  2317. Should not include the scheme or domain. Do not include leading slash.
  2318. Combined with RestClient.BaseUrl to assemble final URL:
  2319. {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com)
  2320. </summary>
  2321. <example>
  2322. // example for url token replacement
  2323. request.Resource = "Products/{ProductId}";
  2324. request.AddParameter("ProductId", 123, ParameterType.UrlSegment);
  2325. </example>
  2326. </member>
  2327. <member name="P:RestSharp.IRestRequest.RequestFormat">
  2328. <summary>
  2329. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  2330. By default XmlSerializer is used.
  2331. </summary>
  2332. </member>
  2333. <member name="P:RestSharp.IRestRequest.RootElement">
  2334. <summary>
  2335. Used by the default deserializers to determine where to start deserializing from.
  2336. Can be used to skip container or root elements that do not have corresponding deserialzation targets.
  2337. </summary>
  2338. </member>
  2339. <member name="P:RestSharp.IRestRequest.DateFormat">
  2340. <summary>
  2341. Used by the default deserializers to explicitly set which date format string to use when parsing dates.
  2342. </summary>
  2343. </member>
  2344. <member name="P:RestSharp.IRestRequest.XmlNamespace">
  2345. <summary>
  2346. Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names.
  2347. </summary>
  2348. </member>
  2349. <member name="P:RestSharp.IRestRequest.Credentials">
  2350. <summary>
  2351. In general you would not need to set this directly. Used by the NtlmAuthenticator.
  2352. </summary>
  2353. </member>
  2354. <member name="P:RestSharp.IRestRequest.Timeout">
  2355. <summary>
  2356. Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient.
  2357. </summary>
  2358. </member>
  2359. <member name="P:RestSharp.IRestRequest.ReadWriteTimeout">
  2360. <summary>
  2361. The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient.
  2362. </summary>
  2363. </member>
  2364. <member name="P:RestSharp.IRestRequest.Attempts">
  2365. <summary>
  2366. How many attempts were made to send this Request?
  2367. </summary>
  2368. <remarks>
  2369. This Number is incremented each time the RestClient sends the request.
  2370. Useful when using Asynchronous Execution with Callbacks
  2371. </remarks>
  2372. </member>
  2373. <member name="P:RestSharp.IRestRequest.UseDefaultCredentials">
  2374. <summary>
  2375. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  2376. will be sent along to the server. The default is false.
  2377. </summary>
  2378. </member>
  2379. <member name="T:RestSharp.IRestResponse">
  2380. <summary>
  2381. Container for data sent back from API
  2382. </summary>
  2383. </member>
  2384. <member name="P:RestSharp.IRestResponse.Request">
  2385. <summary>
  2386. The RestRequest that was made to get this RestResponse
  2387. </summary>
  2388. <remarks>
  2389. Mainly for debugging if ResponseStatus is not OK
  2390. </remarks>
  2391. </member>
  2392. <member name="P:RestSharp.IRestResponse.ContentType">
  2393. <summary>
  2394. MIME content type of response
  2395. </summary>
  2396. </member>
  2397. <member name="P:RestSharp.IRestResponse.ContentLength">
  2398. <summary>
  2399. Length in bytes of the response content
  2400. </summary>
  2401. </member>
  2402. <member name="P:RestSharp.IRestResponse.ContentEncoding">
  2403. <summary>
  2404. Encoding of the response content
  2405. </summary>
  2406. </member>
  2407. <member name="P:RestSharp.IRestResponse.Content">
  2408. <summary>
  2409. String representation of response content
  2410. </summary>
  2411. </member>
  2412. <member name="P:RestSharp.IRestResponse.StatusCode">
  2413. <summary>
  2414. HTTP response status code
  2415. </summary>
  2416. </member>
  2417. <member name="P:RestSharp.IRestResponse.StatusDescription">
  2418. <summary>
  2419. Description of HTTP status returned
  2420. </summary>
  2421. </member>
  2422. <member name="P:RestSharp.IRestResponse.RawBytes">
  2423. <summary>
  2424. Response content
  2425. </summary>
  2426. </member>
  2427. <member name="P:RestSharp.IRestResponse.ResponseUri">
  2428. <summary>
  2429. The URL that actually responded to the content (different from request if redirected)
  2430. </summary>
  2431. </member>
  2432. <member name="P:RestSharp.IRestResponse.Server">
  2433. <summary>
  2434. HttpWebResponse.Server
  2435. </summary>
  2436. </member>
  2437. <member name="P:RestSharp.IRestResponse.Cookies">
  2438. <summary>
  2439. Cookies returned by server with the response
  2440. </summary>
  2441. </member>
  2442. <member name="P:RestSharp.IRestResponse.Headers">
  2443. <summary>
  2444. Headers returned by server with the response
  2445. </summary>
  2446. </member>
  2447. <member name="P:RestSharp.IRestResponse.ResponseStatus">
  2448. <summary>
  2449. Status of the request. Will return Error for transport errors.
  2450. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  2451. </summary>
  2452. </member>
  2453. <member name="P:RestSharp.IRestResponse.ErrorMessage">
  2454. <summary>
  2455. Transport or other non-HTTP error generated while attempting request
  2456. </summary>
  2457. </member>
  2458. <member name="P:RestSharp.IRestResponse.ErrorException">
  2459. <summary>
  2460. Exceptions thrown during the request, if any.
  2461. </summary>
  2462. <remarks>Will contain only network transport or framework exceptions thrown during the request.
  2463. HTTP protocol errors are handled by RestSharp and will not appear here.</remarks>
  2464. </member>
  2465. <member name="T:RestSharp.IRestResponse`1">
  2466. <summary>
  2467. Container for data sent back from API including deserialized data
  2468. </summary>
  2469. <typeparam name="T">Type of data to deserialize to</typeparam>
  2470. </member>
  2471. <member name="P:RestSharp.IRestResponse`1.Data">
  2472. <summary>
  2473. Deserialized entity data
  2474. </summary>
  2475. </member>
  2476. <member name="T:RestSharp.Parameter">
  2477. <summary>
  2478. Parameter container for REST requests
  2479. </summary>
  2480. </member>
  2481. <member name="M:RestSharp.Parameter.ToString">
  2482. <summary>
  2483. Return a human-readable representation of this parameter
  2484. </summary>
  2485. <returns>String</returns>
  2486. </member>
  2487. <member name="P:RestSharp.Parameter.Name">
  2488. <summary>
  2489. Name of the parameter
  2490. </summary>
  2491. </member>
  2492. <member name="P:RestSharp.Parameter.Value">
  2493. <summary>
  2494. Value of the parameter
  2495. </summary>
  2496. </member>
  2497. <member name="P:RestSharp.Parameter.Type">
  2498. <summary>
  2499. Type of the parameter
  2500. </summary>
  2501. </member>
  2502. <member name="T:RestSharp.RestClient">
  2503. <summary>
  2504. Client to translate RestRequests into Http requests and process response result
  2505. </summary>
  2506. </member>
  2507. <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})">
  2508. <summary>
  2509. Executes the request and callback asynchronously, authenticating if needed
  2510. </summary>
  2511. <param name="request">Request to be executed</param>
  2512. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  2513. </member>
  2514. <member name="M:RestSharp.RestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  2515. <summary>
  2516. Executes a GET-style request and callback asynchronously, authenticating if needed
  2517. </summary>
  2518. <param name="request">Request to be executed</param>
  2519. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  2520. <param name="httpMethod">The HTTP method to execute</param>
  2521. </member>
  2522. <member name="M:RestSharp.RestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  2523. <summary>
  2524. Executes a POST-style request and callback asynchronously, authenticating if needed
  2525. </summary>
  2526. <param name="request">Request to be executed</param>
  2527. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  2528. <param name="httpMethod">The HTTP method to execute</param>
  2529. </member>
  2530. <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})">
  2531. <summary>
  2532. Executes the request and callback asynchronously, authenticating if needed
  2533. </summary>
  2534. <typeparam name="T">Target deserialization type</typeparam>
  2535. <param name="request">Request to be executed</param>
  2536. <param name="callback">Callback function to be executed upon completion</param>
  2537. </member>
  2538. <member name="M:RestSharp.RestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  2539. <summary>
  2540. Executes a GET-style request and callback asynchronously, authenticating if needed
  2541. </summary>
  2542. <typeparam name="T">Target deserialization type</typeparam>
  2543. <param name="request">Request to be executed</param>
  2544. <param name="callback">Callback function to be executed upon completion</param>
  2545. <param name="httpMethod">The HTTP method to execute</param>
  2546. </member>
  2547. <member name="M:RestSharp.RestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  2548. <summary>
  2549. Executes a POST-style request and callback asynchronously, authenticating if needed
  2550. </summary>
  2551. <typeparam name="T">Target deserialization type</typeparam>
  2552. <param name="request">Request to be executed</param>
  2553. <param name="callback">Callback function to be executed upon completion</param>
  2554. <param name="httpMethod">The HTTP method to execute</param>
  2555. </member>
  2556. <member name="M:RestSharp.RestClient.#ctor">
  2557. <summary>
  2558. Default constructor that registers default content handlers
  2559. </summary>
  2560. </member>
  2561. <member name="M:RestSharp.RestClient.#ctor(System.Uri)">
  2562. <summary>
  2563. Sets the BaseUrl property for requests made by this client instance
  2564. </summary>
  2565. <param name="baseUrl"></param>
  2566. </member>
  2567. <member name="M:RestSharp.RestClient.#ctor(System.String)">
  2568. <summary>
  2569. Sets the BaseUrl property for requests made by this client instance
  2570. </summary>
  2571. <param name="baseUrl"></param>
  2572. </member>
  2573. <member name="M:RestSharp.RestClient.AddHandler(System.String,RestSharp.Deserializers.IDeserializer)">
  2574. <summary>
  2575. Registers a content handler to process response content
  2576. </summary>
  2577. <param name="contentType">MIME content type of the response content</param>
  2578. <param name="deserializer">Deserializer to use to process content</param>
  2579. </member>
  2580. <member name="M:RestSharp.RestClient.RemoveHandler(System.String)">
  2581. <summary>
  2582. Remove a content handler for the specified MIME content type
  2583. </summary>
  2584. <param name="contentType">MIME content type to remove</param>
  2585. </member>
  2586. <member name="M:RestSharp.RestClient.ClearHandlers">
  2587. <summary>
  2588. Remove all content handlers
  2589. </summary>
  2590. </member>
  2591. <member name="M:RestSharp.RestClient.GetHandler(System.String)">
  2592. <summary>
  2593. Retrieve the handler for the specified MIME content type
  2594. </summary>
  2595. <param name="contentType">MIME content type to retrieve</param>
  2596. <returns>IDeserializer instance</returns>
  2597. </member>
  2598. <member name="M:RestSharp.RestClient.BuildUri(RestSharp.IRestRequest)">
  2599. <summary>
  2600. Assembles URL to call based on parameters, method and resource
  2601. </summary>
  2602. <param name="request">RestRequest to execute</param>
  2603. <returns>Assembled System.Uri</returns>
  2604. </member>
  2605. <member name="P:RestSharp.RestClient.DefaultParameters">
  2606. <summary>
  2607. Parameters included with every request made with this instance of RestClient
  2608. If specified in both client and request, the request wins
  2609. </summary>
  2610. </member>
  2611. <member name="P:RestSharp.RestClient.MaxRedirects">
  2612. <summary>
  2613. Maximum number of redirects to follow if FollowRedirects is true
  2614. </summary>
  2615. </member>
  2616. <member name="P:RestSharp.RestClient.FollowRedirects">
  2617. <summary>
  2618. Default is true. Determine whether or not requests that result in
  2619. HTTP status codes of 3xx should follow returned redirect
  2620. </summary>
  2621. </member>
  2622. <member name="P:RestSharp.RestClient.CookieContainer">
  2623. <summary>
  2624. The CookieContainer used for requests made by this client instance
  2625. </summary>
  2626. </member>
  2627. <member name="P:RestSharp.RestClient.UserAgent">
  2628. <summary>
  2629. UserAgent to use for requests made by this client instance
  2630. </summary>
  2631. </member>
  2632. <member name="P:RestSharp.RestClient.Timeout">
  2633. <summary>
  2634. Timeout in milliseconds to use for requests made by this client instance
  2635. </summary>
  2636. </member>
  2637. <member name="P:RestSharp.RestClient.ReadWriteTimeout">
  2638. <summary>
  2639. The number of milliseconds before the writing or reading times out.
  2640. </summary>
  2641. </member>
  2642. <member name="P:RestSharp.RestClient.UseSynchronizationContext">
  2643. <summary>
  2644. Whether to invoke async callbacks using the SynchronizationContext.Current captured when invoked
  2645. </summary>
  2646. </member>
  2647. <member name="P:RestSharp.RestClient.Authenticator">
  2648. <summary>
  2649. Authenticator to use for requests made by this client instance
  2650. </summary>
  2651. </member>
  2652. <member name="P:RestSharp.RestClient.BaseUrl">
  2653. <summary>
  2654. Combined with Request.Resource to construct URL for request
  2655. Should include scheme and domain without trailing slash.
  2656. </summary>
  2657. <example>
  2658. client.BaseUrl = new Uri("http://example.com");
  2659. </example>
  2660. </member>
  2661. <member name="M:RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse})">
  2662. <summary>
  2663. Executes the request and callback asynchronously, authenticating if needed
  2664. </summary>
  2665. <param name="client">The IRestClient this method extends</param>
  2666. <param name="request">Request to be executed</param>
  2667. <param name="callback">Callback function to be executed upon completion</param>
  2668. </member>
  2669. <member name="M:RestSharp.RestClientExtensions.ExecuteAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0}})">
  2670. <summary>
  2671. Executes the request and callback asynchronously, authenticating if needed
  2672. </summary>
  2673. <param name="client">The IRestClient this method extends</param>
  2674. <typeparam name="T">Target deserialization type</typeparam>
  2675. <param name="request">Request to be executed</param>
  2676. <param name="callback">Callback function to be executed upon completion providing access to the async handle</param>
  2677. </member>
  2678. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,RestSharp.Parameter)">
  2679. <summary>
  2680. Add a parameter to use on every request made with this client instance
  2681. </summary>
  2682. <param name="restClient">The IRestClient instance</param>
  2683. <param name="p">Parameter to add</param>
  2684. <returns></returns>
  2685. </member>
  2686. <member name="M:RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient,System.String)">
  2687. <summary>
  2688. Removes a parameter from the default parameters that are used on every request made with this client instance
  2689. </summary>
  2690. <param name="restClient">The IRestClient instance</param>
  2691. <param name="name">The name of the parameter that needs to be removed</param>
  2692. <returns></returns>
  2693. </member>
  2694. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object)">
  2695. <summary>
  2696. Adds a HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  2697. Used on every request made by this client instance
  2698. </summary>
  2699. <param name="restClient">The IRestClient instance</param>
  2700. <param name="name">Name of the parameter</param>
  2701. <param name="value">Value of the parameter</param>
  2702. <returns>This request</returns>
  2703. </member>
  2704. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object,RestSharp.ParameterType)">
  2705. <summary>
  2706. Adds a parameter to the request. There are four types of parameters:
  2707. - GetOrPost: Either a QueryString value or encoded form value based on method
  2708. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  2709. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  2710. - RequestBody: Used by AddBody() (not recommended to use directly)
  2711. </summary>
  2712. <param name="restClient">The IRestClient instance</param>
  2713. <param name="name">Name of the parameter</param>
  2714. <param name="value">Value of the parameter</param>
  2715. <param name="type">The type of parameter to add</param>
  2716. <returns>This request</returns>
  2717. </member>
  2718. <member name="M:RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient,System.String,System.String)">
  2719. <summary>
  2720. Shortcut to AddDefaultParameter(name, value, HttpHeader) overload
  2721. </summary>
  2722. <param name="restClient">The IRestClient instance</param>
  2723. <param name="name">Name of the header to add</param>
  2724. <param name="value">Value of the header to add</param>
  2725. <returns></returns>
  2726. </member>
  2727. <member name="M:RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient,System.String,System.String)">
  2728. <summary>
  2729. Shortcut to AddDefaultParameter(name, value, UrlSegment) overload
  2730. </summary>
  2731. <param name="restClient">The IRestClient instance</param>
  2732. <param name="name">Name of the segment to add</param>
  2733. <param name="value">Value of the segment to add</param>
  2734. <returns></returns>
  2735. </member>
  2736. <member name="T:RestSharp.RestRequest">
  2737. <summary>
  2738. Container for data used to make requests
  2739. </summary>
  2740. </member>
  2741. <member name="M:RestSharp.RestRequest.#ctor">
  2742. <summary>
  2743. Default constructor
  2744. </summary>
  2745. </member>
  2746. <member name="M:RestSharp.RestRequest.#ctor(RestSharp.Method)">
  2747. <summary>
  2748. Sets Method property to value of method
  2749. </summary>
  2750. <param name="method">Method to use for this request</param>
  2751. </member>
  2752. <member name="M:RestSharp.RestRequest.#ctor(System.String)">
  2753. <summary>
  2754. Sets Resource property
  2755. </summary>
  2756. <param name="resource">Resource to use for this request</param>
  2757. </member>
  2758. <member name="M:RestSharp.RestRequest.#ctor(System.String,RestSharp.Method)">
  2759. <summary>
  2760. Sets Resource and Method properties
  2761. </summary>
  2762. <param name="resource">Resource to use for this request</param>
  2763. <param name="method">Method to use for this request</param>
  2764. </member>
  2765. <member name="M:RestSharp.RestRequest.#ctor(System.Uri)">
  2766. <summary>
  2767. Sets Resource property
  2768. </summary>
  2769. <param name="resource">Resource to use for this request</param>
  2770. </member>
  2771. <member name="M:RestSharp.RestRequest.#ctor(System.Uri,RestSharp.Method)">
  2772. <summary>
  2773. Sets Resource and Method properties
  2774. </summary>
  2775. <param name="resource">Resource to use for this request</param>
  2776. <param name="method">Method to use for this request</param>
  2777. </member>
  2778. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.String)">
  2779. <summary>
  2780. Adds a file to the Files collection to be included with a POST or PUT request
  2781. (other methods do not support file uploads).
  2782. </summary>
  2783. <param name="name">The parameter name to use in the request</param>
  2784. <param name="path">Full path to file to upload</param>
  2785. <returns>This request</returns>
  2786. </member>
  2787. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String)">
  2788. <summary>
  2789. Adds the bytes to the Files collection with the specified file name
  2790. </summary>
  2791. <param name="name">The parameter name to use in the request</param>
  2792. <param name="bytes">The file data</param>
  2793. <param name="fileName">The file name to use for the uploaded file</param>
  2794. <returns>This request</returns>
  2795. </member>
  2796. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String,System.String)">
  2797. <summary>
  2798. Adds the bytes to the Files collection with the specified file name and content type
  2799. </summary>
  2800. <param name="name">The parameter name to use in the request</param>
  2801. <param name="bytes">The file data</param>
  2802. <param name="fileName">The file name to use for the uploaded file</param>
  2803. <param name="contentType">The MIME type of the file to upload</param>
  2804. <returns>This request</returns>
  2805. </member>
  2806. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String)">
  2807. <summary>
  2808. Adds the bytes to the Files collection with the specified file name and content type
  2809. </summary>
  2810. <param name="name">The parameter name to use in the request</param>
  2811. <param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param>
  2812. <param name="fileName">The file name to use for the uploaded file</param>
  2813. <returns>This request</returns>
  2814. </member>
  2815. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String,System.String)">
  2816. <summary>
  2817. Adds the bytes to the Files collection with the specified file name and content type
  2818. </summary>
  2819. <param name="name">The parameter name to use in the request</param>
  2820. <param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param>
  2821. <param name="fileName">The file name to use for the uploaded file</param>
  2822. <param name="contentType">The MIME type of the file to upload</param>
  2823. <returns>This request</returns>
  2824. </member>
  2825. <member name="M:RestSharp.RestRequest.AddBody(System.Object,System.String)">
  2826. <summary>
  2827. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  2828. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  2829. </summary>
  2830. <param name="obj">The object to serialize</param>
  2831. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  2832. <returns>This request</returns>
  2833. </member>
  2834. <member name="M:RestSharp.RestRequest.AddBody(System.Object)">
  2835. <summary>
  2836. Serializes obj to data format specified by RequestFormat and adds it to the request body.
  2837. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  2838. </summary>
  2839. <param name="obj">The object to serialize</param>
  2840. <returns>This request</returns>
  2841. </member>
  2842. <member name="M:RestSharp.RestRequest.AddJsonBody(System.Object)">
  2843. <summary>
  2844. Serializes obj to JSON format and adds it to the request body.
  2845. </summary>
  2846. <param name="obj">The object to serialize</param>
  2847. <returns>This request</returns>
  2848. </member>
  2849. <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object)">
  2850. <summary>
  2851. Serializes obj to XML format and adds it to the request body.
  2852. </summary>
  2853. <param name="obj">The object to serialize</param>
  2854. <returns>This request</returns>
  2855. </member>
  2856. <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object,System.String)">
  2857. <summary>
  2858. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  2859. Serializes obj to XML format and passes xmlNamespace then adds it to the request body.
  2860. </summary>
  2861. <param name="obj">The object to serialize</param>
  2862. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  2863. <returns>This request</returns>
  2864. </member>
  2865. <member name="M:RestSharp.RestRequest.AddObject(System.Object,System.String[])">
  2866. <summary>
  2867. Calls AddParameter() for all public, readable properties specified in the includedProperties list
  2868. </summary>
  2869. <example>
  2870. request.AddObject(product, "ProductId", "Price", ...);
  2871. </example>
  2872. <param name="obj">The object with properties to add as parameters</param>
  2873. <param name="includedProperties">The names of the properties to include</param>
  2874. <returns>This request</returns>
  2875. </member>
  2876. <member name="M:RestSharp.RestRequest.AddObject(System.Object)">
  2877. <summary>
  2878. Calls AddParameter() for all public, readable properties of obj
  2879. </summary>
  2880. <param name="obj">The object with properties to add as parameters</param>
  2881. <returns>This request</returns>
  2882. </member>
  2883. <member name="M:RestSharp.RestRequest.AddParameter(RestSharp.Parameter)">
  2884. <summary>
  2885. Add the parameter to the request
  2886. </summary>
  2887. <param name="p">Parameter to add</param>
  2888. <returns></returns>
  2889. </member>
  2890. <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object)">
  2891. <summary>
  2892. Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  2893. </summary>
  2894. <param name="name">Name of the parameter</param>
  2895. <param name="value">Value of the parameter</param>
  2896. <returns>This request</returns>
  2897. </member>
  2898. <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)">
  2899. <summary>
  2900. Adds a parameter to the request. There are four types of parameters:
  2901. - GetOrPost: Either a QueryString value or encoded form value based on method
  2902. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  2903. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  2904. - RequestBody: Used by AddBody() (not recommended to use directly)
  2905. </summary>
  2906. <param name="name">Name of the parameter</param>
  2907. <param name="value">Value of the parameter</param>
  2908. <param name="type">The type of parameter to add</param>
  2909. <returns>This request</returns>
  2910. </member>
  2911. <member name="M:RestSharp.RestRequest.AddHeader(System.String,System.String)">
  2912. <summary>
  2913. Shortcut to AddParameter(name, value, HttpHeader) overload
  2914. </summary>
  2915. <param name="name">Name of the header to add</param>
  2916. <param name="value">Value of the header to add</param>
  2917. <returns></returns>
  2918. </member>
  2919. <member name="M:RestSharp.RestRequest.AddCookie(System.String,System.String)">
  2920. <summary>
  2921. Shortcut to AddParameter(name, value, Cookie) overload
  2922. </summary>
  2923. <param name="name">Name of the cookie to add</param>
  2924. <param name="value">Value of the cookie to add</param>
  2925. <returns></returns>
  2926. </member>
  2927. <member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.String)">
  2928. <summary>
  2929. Shortcut to AddParameter(name, value, UrlSegment) overload
  2930. </summary>
  2931. <param name="name">Name of the segment to add</param>
  2932. <param name="value">Value of the segment to add</param>
  2933. <returns></returns>
  2934. </member>
  2935. <member name="M:RestSharp.RestRequest.AddQueryParameter(System.String,System.String)">
  2936. <summary>
  2937. Shortcut to AddParameter(name, value, QueryString) overload
  2938. </summary>
  2939. <param name="name">Name of the parameter to add</param>
  2940. <param name="value">Value of the parameter to add</param>
  2941. <returns></returns>
  2942. </member>
  2943. <member name="M:RestSharp.RestRequest.IncreaseNumAttempts">
  2944. <summary>
  2945. Internal Method so that RestClient can increase the number of attempts
  2946. </summary>
  2947. </member>
  2948. <member name="P:RestSharp.RestRequest.AlwaysMultipartFormData">
  2949. <summary>
  2950. Always send a multipart/form-data request - even when no Files are present.
  2951. </summary>
  2952. </member>
  2953. <member name="P:RestSharp.RestRequest.JsonSerializer">
  2954. <summary>
  2955. Serializer to use when writing JSON request bodies. Used if RequestFormat is Json.
  2956. By default the included JsonSerializer is used (currently using JSON.NET default serialization).
  2957. </summary>
  2958. </member>
  2959. <member name="P:RestSharp.RestRequest.XmlSerializer">
  2960. <summary>
  2961. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  2962. By default the included XmlSerializer is used.
  2963. </summary>
  2964. </member>
  2965. <member name="P:RestSharp.RestRequest.ResponseWriter">
  2966. <summary>
  2967. Set this to write response to Stream rather than reading into memory.
  2968. </summary>
  2969. </member>
  2970. <member name="P:RestSharp.RestRequest.UseDefaultCredentials">
  2971. <summary>
  2972. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  2973. will be sent along to the server. The default is false.
  2974. </summary>
  2975. </member>
  2976. <member name="P:RestSharp.RestRequest.Parameters">
  2977. <summary>
  2978. Container of all HTTP parameters to be passed with the request.
  2979. See AddParameter() for explanation of the types of parameters that can be passed
  2980. </summary>
  2981. </member>
  2982. <member name="P:RestSharp.RestRequest.Files">
  2983. <summary>
  2984. Container of all the files to be uploaded with the request.
  2985. </summary>
  2986. </member>
  2987. <member name="P:RestSharp.RestRequest.Method">
  2988. <summary>
  2989. Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS
  2990. Default is GET
  2991. </summary>
  2992. </member>
  2993. <member name="P:RestSharp.RestRequest.Resource">
  2994. <summary>
  2995. The Resource URL to make the request against.
  2996. Tokens are substituted with UrlSegment parameters and match by name.
  2997. Should not include the scheme or domain. Do not include leading slash.
  2998. Combined with RestClient.BaseUrl to assemble final URL:
  2999. {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com)
  3000. </summary>
  3001. <example>
  3002. // example for url token replacement
  3003. request.Resource = "Products/{ProductId}";
  3004. request.AddParameter("ProductId", 123, ParameterType.UrlSegment);
  3005. </example>
  3006. </member>
  3007. <member name="P:RestSharp.RestRequest.RequestFormat">
  3008. <summary>
  3009. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  3010. By default XmlSerializer is used.
  3011. </summary>
  3012. </member>
  3013. <member name="P:RestSharp.RestRequest.RootElement">
  3014. <summary>
  3015. Used by the default deserializers to determine where to start deserializing from.
  3016. Can be used to skip container or root elements that do not have corresponding deserialzation targets.
  3017. </summary>
  3018. </member>
  3019. <member name="P:RestSharp.RestRequest.OnBeforeDeserialization">
  3020. <summary>
  3021. A function to run prior to deserializing starting (e.g. change settings if error encountered)
  3022. </summary>
  3023. </member>
  3024. <member name="P:RestSharp.RestRequest.DateFormat">
  3025. <summary>
  3026. Used by the default deserializers to explicitly set which date format string to use when parsing dates.
  3027. </summary>
  3028. </member>
  3029. <member name="P:RestSharp.RestRequest.XmlNamespace">
  3030. <summary>
  3031. Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names.
  3032. </summary>
  3033. </member>
  3034. <member name="P:RestSharp.RestRequest.Credentials">
  3035. <summary>
  3036. In general you would not need to set this directly. Used by the NtlmAuthenticator.
  3037. </summary>
  3038. </member>
  3039. <member name="P:RestSharp.RestRequest.UserState">
  3040. <summary>
  3041. Gets or sets a user-defined state object that contains information about a request and which can be later
  3042. retrieved when the request completes.
  3043. </summary>
  3044. </member>
  3045. <member name="P:RestSharp.RestRequest.Timeout">
  3046. <summary>
  3047. Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient.
  3048. </summary>
  3049. </member>
  3050. <member name="P:RestSharp.RestRequest.ReadWriteTimeout">
  3051. <summary>
  3052. The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient.
  3053. </summary>
  3054. </member>
  3055. <member name="P:RestSharp.RestRequest.Attempts">
  3056. <summary>
  3057. How many attempts were made to send this Request?
  3058. </summary>
  3059. <remarks>
  3060. This Number is incremented each time the RestClient sends the request.
  3061. Useful when using Asynchronous Execution with Callbacks
  3062. </remarks>
  3063. </member>
  3064. <member name="T:RestSharp.RestResponseBase">
  3065. <summary>
  3066. Base class for common properties shared by RestResponse and RestResponse[[T]]
  3067. </summary>
  3068. </member>
  3069. <member name="M:RestSharp.RestResponseBase.#ctor">
  3070. <summary>
  3071. Default constructor
  3072. </summary>
  3073. </member>
  3074. <member name="P:RestSharp.RestResponseBase.Request">
  3075. <summary>
  3076. The RestRequest that was made to get this RestResponse
  3077. </summary>
  3078. <remarks>
  3079. Mainly for debugging if ResponseStatus is not OK
  3080. </remarks>
  3081. </member>
  3082. <member name="P:RestSharp.RestResponseBase.ContentType">
  3083. <summary>
  3084. MIME content type of response
  3085. </summary>
  3086. </member>
  3087. <member name="P:RestSharp.RestResponseBase.ContentLength">
  3088. <summary>
  3089. Length in bytes of the response content
  3090. </summary>
  3091. </member>
  3092. <member name="P:RestSharp.RestResponseBase.ContentEncoding">
  3093. <summary>
  3094. Encoding of the response content
  3095. </summary>
  3096. </member>
  3097. <member name="P:RestSharp.RestResponseBase.Content">
  3098. <summary>
  3099. String representation of response content
  3100. </summary>
  3101. </member>
  3102. <member name="P:RestSharp.RestResponseBase.StatusCode">
  3103. <summary>
  3104. HTTP response status code
  3105. </summary>
  3106. </member>
  3107. <member name="P:RestSharp.RestResponseBase.StatusDescription">
  3108. <summary>
  3109. Description of HTTP status returned
  3110. </summary>
  3111. </member>
  3112. <member name="P:RestSharp.RestResponseBase.RawBytes">
  3113. <summary>
  3114. Response content
  3115. </summary>
  3116. </member>
  3117. <member name="P:RestSharp.RestResponseBase.ResponseUri">
  3118. <summary>
  3119. The URL that actually responded to the content (different from request if redirected)
  3120. </summary>
  3121. </member>
  3122. <member name="P:RestSharp.RestResponseBase.Server">
  3123. <summary>
  3124. HttpWebResponse.Server
  3125. </summary>
  3126. </member>
  3127. <member name="P:RestSharp.RestResponseBase.Cookies">
  3128. <summary>
  3129. Cookies returned by server with the response
  3130. </summary>
  3131. </member>
  3132. <member name="P:RestSharp.RestResponseBase.Headers">
  3133. <summary>
  3134. Headers returned by server with the response
  3135. </summary>
  3136. </member>
  3137. <member name="P:RestSharp.RestResponseBase.ResponseStatus">
  3138. <summary>
  3139. Status of the request. Will return Error for transport errors.
  3140. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  3141. </summary>
  3142. </member>
  3143. <member name="P:RestSharp.RestResponseBase.ErrorMessage">
  3144. <summary>
  3145. Transport or other non-HTTP error generated while attempting request
  3146. </summary>
  3147. </member>
  3148. <member name="P:RestSharp.RestResponseBase.ErrorException">
  3149. <summary>
  3150. The exception thrown during the request, if any
  3151. </summary>
  3152. </member>
  3153. <member name="T:RestSharp.RestResponse`1">
  3154. <summary>
  3155. Container for data sent back from API including deserialized data
  3156. </summary>
  3157. <typeparam name="T">Type of data to deserialize to</typeparam>
  3158. </member>
  3159. <member name="P:RestSharp.RestResponse`1.Data">
  3160. <summary>
  3161. Deserialized entity data
  3162. </summary>
  3163. </member>
  3164. <member name="T:RestSharp.RestResponse">
  3165. <summary>
  3166. Container for data sent back from API
  3167. </summary>
  3168. </member>
  3169. <member name="T:RestSharp.Serializers.DotNetXmlSerializer">
  3170. <summary>
  3171. Wrapper for System.Xml.Serialization.XmlSerializer.
  3172. </summary>
  3173. </member>
  3174. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor">
  3175. <summary>
  3176. Default constructor, does not specify namespace
  3177. </summary>
  3178. </member>
  3179. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor(System.String)">
  3180. <summary>
  3181. Specify the namespaced to be used when serializing
  3182. </summary>
  3183. <param name="namespace">XML namespace</param>
  3184. </member>
  3185. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.Serialize(System.Object)">
  3186. <summary>
  3187. Serialize the object as XML
  3188. </summary>
  3189. <param name="obj">Object to serialize</param>
  3190. <returns>XML as string</returns>
  3191. </member>
  3192. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.RootElement">
  3193. <summary>
  3194. Name of the root element to use when serializing
  3195. </summary>
  3196. </member>
  3197. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Namespace">
  3198. <summary>
  3199. XML namespace to use when serializing
  3200. </summary>
  3201. </member>
  3202. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.DateFormat">
  3203. <summary>
  3204. Format string to use when serializing dates
  3205. </summary>
  3206. </member>
  3207. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.ContentType">
  3208. <summary>
  3209. Content type for serialized content
  3210. </summary>
  3211. </member>
  3212. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Encoding">
  3213. <summary>
  3214. Encoding for serialized content
  3215. </summary>
  3216. </member>
  3217. <member name="T:RestSharp.Serializers.DotNetXmlSerializer.EncodingStringWriter">
  3218. <summary>
  3219. Need to subclass StringWriter in order to override Encoding
  3220. </summary>
  3221. </member>
  3222. <member name="T:RestSharp.Serializers.JsonSerializer">
  3223. <summary>
  3224. Default JSON serializer for request bodies
  3225. Doesn't currently use the SerializeAs attribute, defers to Newtonsoft's attributes
  3226. </summary>
  3227. </member>
  3228. <member name="M:RestSharp.Serializers.JsonSerializer.#ctor">
  3229. <summary>
  3230. Default serializer
  3231. </summary>
  3232. </member>
  3233. <member name="M:RestSharp.Serializers.JsonSerializer.Serialize(System.Object)">
  3234. <summary>
  3235. Serialize the object as JSON
  3236. </summary>
  3237. <param name="obj">Object to serialize</param>
  3238. <returns>JSON as String</returns>
  3239. </member>
  3240. <member name="P:RestSharp.Serializers.JsonSerializer.DateFormat">
  3241. <summary>
  3242. Unused for JSON Serialization
  3243. </summary>
  3244. </member>
  3245. <member name="P:RestSharp.Serializers.JsonSerializer.RootElement">
  3246. <summary>
  3247. Unused for JSON Serialization
  3248. </summary>
  3249. </member>
  3250. <member name="P:RestSharp.Serializers.JsonSerializer.Namespace">
  3251. <summary>
  3252. Unused for JSON Serialization
  3253. </summary>
  3254. </member>
  3255. <member name="P:RestSharp.Serializers.JsonSerializer.ContentType">
  3256. <summary>
  3257. Content type for serialized content
  3258. </summary>
  3259. </member>
  3260. <member name="T:RestSharp.Serializers.SerializeAsAttribute">
  3261. <summary>
  3262. Allows control how class and property names and values are serialized by XmlSerializer
  3263. Currently not supported with the JsonSerializer
  3264. When specified at the property level the class-level specification is overridden
  3265. </summary>
  3266. </member>
  3267. <member name="M:RestSharp.Serializers.SerializeAsAttribute.TransformName(System.String)">
  3268. <summary>
  3269. Called by the attribute when NameStyle is speficied
  3270. </summary>
  3271. <param name="input">The string to transform</param>
  3272. <returns>String</returns>
  3273. </member>
  3274. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Name">
  3275. <summary>
  3276. The name to use for the serialized element
  3277. </summary>
  3278. </member>
  3279. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Attribute">
  3280. <summary>
  3281. Sets the value to be serialized as an Attribute instead of an Element
  3282. </summary>
  3283. </member>
  3284. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Culture">
  3285. <summary>
  3286. The culture to use when serializing
  3287. </summary>
  3288. </member>
  3289. <member name="P:RestSharp.Serializers.SerializeAsAttribute.NameStyle">
  3290. <summary>
  3291. Transforms the casing of the name based on the selected value.
  3292. </summary>
  3293. </member>
  3294. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Index">
  3295. <summary>
  3296. The order to serialize the element. Default is int.MaxValue.
  3297. </summary>
  3298. </member>
  3299. <member name="T:RestSharp.Serializers.NameStyle">
  3300. <summary>
  3301. Options for transforming casing of element names
  3302. </summary>
  3303. </member>
  3304. <member name="T:RestSharp.Serializers.XmlSerializer">
  3305. <summary>
  3306. Default XML Serializer
  3307. </summary>
  3308. </member>
  3309. <member name="M:RestSharp.Serializers.XmlSerializer.#ctor">
  3310. <summary>
  3311. Default constructor, does not specify namespace
  3312. </summary>
  3313. </member>
  3314. <member name="M:RestSharp.Serializers.XmlSerializer.#ctor(System.String)">
  3315. <summary>
  3316. Specify the namespaced to be used when serializing
  3317. </summary>
  3318. <param name="namespace">XML namespace</param>
  3319. </member>
  3320. <member name="M:RestSharp.Serializers.XmlSerializer.Serialize(System.Object)">
  3321. <summary>
  3322. Serialize the object as XML
  3323. </summary>
  3324. <param name="obj">Object to serialize</param>
  3325. <returns>XML as string</returns>
  3326. </member>
  3327. <member name="M:RestSharp.Serializers.XmlSerializer.IsNumeric(System.Object)">
  3328. <summary>
  3329. Determines if a given object is numeric in any way
  3330. (can be integer, double, null, etc).
  3331. </summary>
  3332. </member>
  3333. <member name="P:RestSharp.Serializers.XmlSerializer.RootElement">
  3334. <summary>
  3335. Name of the root element to use when serializing
  3336. </summary>
  3337. </member>
  3338. <member name="P:RestSharp.Serializers.XmlSerializer.Namespace">
  3339. <summary>
  3340. XML namespace to use when serializing
  3341. </summary>
  3342. </member>
  3343. <member name="P:RestSharp.Serializers.XmlSerializer.DateFormat">
  3344. <summary>
  3345. Format string to use when serializing dates
  3346. </summary>
  3347. </member>
  3348. <member name="P:RestSharp.Serializers.XmlSerializer.ContentType">
  3349. <summary>
  3350. Content type for serialized content
  3351. </summary>
  3352. </member>
  3353. <member name="T:RestSharp.JsonArray">
  3354. <summary>
  3355. Represents the json array.
  3356. </summary>
  3357. </member>
  3358. <member name="M:RestSharp.JsonArray.#ctor">
  3359. <summary>
  3360. Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class.
  3361. </summary>
  3362. </member>
  3363. <member name="M:RestSharp.JsonArray.#ctor(System.Int32)">
  3364. <summary>
  3365. Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class.
  3366. </summary>
  3367. <param name="capacity">The capacity of the json array.</param>
  3368. </member>
  3369. <member name="M:RestSharp.JsonArray.ToString">
  3370. <summary>
  3371. The json representation of the array.
  3372. </summary>
  3373. <returns>The json representation of the array.</returns>
  3374. </member>
  3375. <member name="T:RestSharp.JsonObject">
  3376. <summary>
  3377. Represents the json object.
  3378. </summary>
  3379. </member>
  3380. <member name="F:RestSharp.JsonObject._members">
  3381. <summary>
  3382. The internal member dictionary.
  3383. </summary>
  3384. </member>
  3385. <member name="M:RestSharp.JsonObject.#ctor">
  3386. <summary>
  3387. Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>.
  3388. </summary>
  3389. </member>
  3390. <member name="M:RestSharp.JsonObject.#ctor(System.Collections.Generic.IEqualityComparer{System.String})">
  3391. <summary>
  3392. Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>.
  3393. </summary>
  3394. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> implementation to use when comparing keys, or null to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1"/> for the type of the key.</param>
  3395. </member>
  3396. <member name="M:RestSharp.JsonObject.Add(System.String,System.Object)">
  3397. <summary>
  3398. Adds the specified key.
  3399. </summary>
  3400. <param name="key">The key.</param>
  3401. <param name="value">The value.</param>
  3402. </member>
  3403. <member name="M:RestSharp.JsonObject.ContainsKey(System.String)">
  3404. <summary>
  3405. Determines whether the specified key contains key.
  3406. </summary>
  3407. <param name="key">The key.</param>
  3408. <returns>
  3409. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  3410. </returns>
  3411. </member>
  3412. <member name="M:RestSharp.JsonObject.Remove(System.String)">
  3413. <summary>
  3414. Removes the specified key.
  3415. </summary>
  3416. <param name="key">The key.</param>
  3417. <returns></returns>
  3418. </member>
  3419. <member name="M:RestSharp.JsonObject.TryGetValue(System.String,System.Object@)">
  3420. <summary>
  3421. Tries the get value.
  3422. </summary>
  3423. <param name="key">The key.</param>
  3424. <param name="value">The value.</param>
  3425. <returns></returns>
  3426. </member>
  3427. <member name="M:RestSharp.JsonObject.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  3428. <summary>
  3429. Adds the specified item.
  3430. </summary>
  3431. <param name="item">The item.</param>
  3432. </member>
  3433. <member name="M:RestSharp.JsonObject.Clear">
  3434. <summary>
  3435. Clears this instance.
  3436. </summary>
  3437. </member>
  3438. <member name="M:RestSharp.JsonObject.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  3439. <summary>
  3440. Determines whether [contains] [the specified item].
  3441. </summary>
  3442. <param name="item">The item.</param>
  3443. <returns>
  3444. <c>true</c> if [contains] [the specified item]; otherwise, <c>false</c>.
  3445. </returns>
  3446. </member>
  3447. <member name="M:RestSharp.JsonObject.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
  3448. <summary>
  3449. Copies to.
  3450. </summary>
  3451. <param name="array">The array.</param>
  3452. <param name="arrayIndex">Index of the array.</param>
  3453. </member>
  3454. <member name="M:RestSharp.JsonObject.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  3455. <summary>
  3456. Removes the specified item.
  3457. </summary>
  3458. <param name="item">The item.</param>
  3459. <returns></returns>
  3460. </member>
  3461. <member name="M:RestSharp.JsonObject.GetEnumerator">
  3462. <summary>
  3463. Gets the enumerator.
  3464. </summary>
  3465. <returns></returns>
  3466. </member>
  3467. <member name="M:RestSharp.JsonObject.System#Collections#IEnumerable#GetEnumerator">
  3468. <summary>
  3469. Returns an enumerator that iterates through a collection.
  3470. </summary>
  3471. <returns>
  3472. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  3473. </returns>
  3474. </member>
  3475. <member name="M:RestSharp.JsonObject.ToString">
  3476. <summary>
  3477. Returns a json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3478. </summary>
  3479. <returns>
  3480. A json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3481. </returns>
  3482. </member>
  3483. <member name="P:RestSharp.JsonObject.Item(System.Int32)">
  3484. <summary>
  3485. Gets the <see cref="T:System.Object"/> at the specified index.
  3486. </summary>
  3487. <value></value>
  3488. </member>
  3489. <member name="P:RestSharp.JsonObject.Keys">
  3490. <summary>
  3491. Gets the keys.
  3492. </summary>
  3493. <value>The keys.</value>
  3494. </member>
  3495. <member name="P:RestSharp.JsonObject.Values">
  3496. <summary>
  3497. Gets the values.
  3498. </summary>
  3499. <value>The values.</value>
  3500. </member>
  3501. <member name="P:RestSharp.JsonObject.Item(System.String)">
  3502. <summary>
  3503. Gets or sets the <see cref="T:System.Object"/> with the specified key.
  3504. </summary>
  3505. <value></value>
  3506. </member>
  3507. <member name="P:RestSharp.JsonObject.Count">
  3508. <summary>
  3509. Gets the count.
  3510. </summary>
  3511. <value>The count.</value>
  3512. </member>
  3513. <member name="P:RestSharp.JsonObject.IsReadOnly">
  3514. <summary>
  3515. Gets a value indicating whether this instance is read only.
  3516. </summary>
  3517. <value>
  3518. <c>true</c> if this instance is read only; otherwise, <c>false</c>.
  3519. </value>
  3520. </member>
  3521. <member name="T:RestSharp.SimpleJson">
  3522. <summary>
  3523. This class encodes and decodes JSON strings.
  3524. Spec. details, see http://www.json.org/
  3525. JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList&lt;object>) and JsonObject(IDictionary&lt;string,object>).
  3526. All numbers are parsed to doubles.
  3527. </summary>
  3528. </member>
  3529. <member name="M:RestSharp.SimpleJson.DeserializeObject(System.String)">
  3530. <summary>
  3531. Parses the string json into a value
  3532. </summary>
  3533. <param name="json">A JSON string.</param>
  3534. <returns>An IList&lt;object>, a IDictionary&lt;string,object>, a double, a string, null, true, or false</returns>
  3535. </member>
  3536. <member name="M:RestSharp.SimpleJson.TryDeserializeObject(System.String,System.Object@)">
  3537. <summary>
  3538. Try parsing the json string into a value.
  3539. </summary>
  3540. <param name="json">
  3541. A JSON string.
  3542. </param>
  3543. <param name="obj">
  3544. The object.
  3545. </param>
  3546. <returns>
  3547. Returns true if successfull otherwise false.
  3548. </returns>
  3549. </member>
  3550. <member name="M:RestSharp.SimpleJson.SerializeObject(System.Object,RestSharp.IJsonSerializerStrategy)">
  3551. <summary>
  3552. Converts a IDictionary&lt;string,object> / IList&lt;object> object into a JSON string
  3553. </summary>
  3554. <param name="json">A IDictionary&lt;string,object> / IList&lt;object></param>
  3555. <param name="jsonSerializerStrategy">Serializer strategy to use</param>
  3556. <returns>A JSON encoded string, or null if object 'json' is not serializable</returns>
  3557. </member>
  3558. <member name="M:RestSharp.SimpleJson.IsNumeric(System.Object)">
  3559. <summary>
  3560. Determines if a given object is numeric in any way
  3561. (can be integer, double, null, etc).
  3562. </summary>
  3563. </member>
  3564. <member name="T:RestSharp.Validation.Require">
  3565. <summary>
  3566. Helper methods for validating required values
  3567. </summary>
  3568. </member>
  3569. <member name="M:RestSharp.Validation.Require.Argument(System.String,System.Object)">
  3570. <summary>
  3571. Require a parameter to not be null
  3572. </summary>
  3573. <param name="argumentName">Name of the parameter</param>
  3574. <param name="argumentValue">Value of the parameter</param>
  3575. </member>
  3576. <member name="T:RestSharp.Validation.Validate">
  3577. <summary>
  3578. Helper methods for validating values
  3579. </summary>
  3580. </member>
  3581. <member name="M:RestSharp.Validation.Validate.IsBetween(System.Int32,System.Int32,System.Int32)">
  3582. <summary>
  3583. Validate an integer value is between the specified values (exclusive of min/max)
  3584. </summary>
  3585. <param name="value">Value to validate</param>
  3586. <param name="min">Exclusive minimum value</param>
  3587. <param name="max">Exclusive maximum value</param>
  3588. </member>
  3589. <member name="M:RestSharp.Validation.Validate.IsValidLength(System.String,System.Int32)">
  3590. <summary>
  3591. Validate a string length
  3592. </summary>
  3593. <param name="value">String to be validated</param>
  3594. <param name="maxSize">Maximum length of the string</param>
  3595. </member>
  3596. <member name="P:RestSharp.RestResponseCookie.Comment">
  3597. <summary>
  3598. Comment of the cookie
  3599. </summary>
  3600. </member>
  3601. <member name="P:RestSharp.RestResponseCookie.CommentUri">
  3602. <summary>
  3603. Comment of the cookie
  3604. </summary>
  3605. </member>
  3606. <member name="P:RestSharp.RestResponseCookie.Discard">
  3607. <summary>
  3608. Indicates whether the cookie should be discarded at the end of the session
  3609. </summary>
  3610. </member>
  3611. <member name="P:RestSharp.RestResponseCookie.Domain">
  3612. <summary>
  3613. Domain of the cookie
  3614. </summary>
  3615. </member>
  3616. <member name="P:RestSharp.RestResponseCookie.Expired">
  3617. <summary>
  3618. Indicates whether the cookie is expired
  3619. </summary>
  3620. </member>
  3621. <member name="P:RestSharp.RestResponseCookie.Expires">
  3622. <summary>
  3623. Date and time that the cookie expires
  3624. </summary>
  3625. </member>
  3626. <member name="P:RestSharp.RestResponseCookie.HttpOnly">
  3627. <summary>
  3628. Indicates that this cookie should only be accessed by the server
  3629. </summary>
  3630. </member>
  3631. <member name="P:RestSharp.RestResponseCookie.Name">
  3632. <summary>
  3633. Name of the cookie
  3634. </summary>
  3635. </member>
  3636. <member name="P:RestSharp.RestResponseCookie.Path">
  3637. <summary>
  3638. Path of the cookie
  3639. </summary>
  3640. </member>
  3641. <member name="P:RestSharp.RestResponseCookie.Port">
  3642. <summary>
  3643. Port of the cookie
  3644. </summary>
  3645. </member>
  3646. <member name="P:RestSharp.RestResponseCookie.Secure">
  3647. <summary>
  3648. Indicates that the cookie should only be sent over secure channels
  3649. </summary>
  3650. </member>
  3651. <member name="P:RestSharp.RestResponseCookie.TimeStamp">
  3652. <summary>
  3653. Date and time the cookie was created
  3654. </summary>
  3655. </member>
  3656. <member name="P:RestSharp.RestResponseCookie.Value">
  3657. <summary>
  3658. Value of the cookie
  3659. </summary>
  3660. </member>
  3661. <member name="P:RestSharp.RestResponseCookie.Version">
  3662. <summary>
  3663. Version of the cookie
  3664. </summary>
  3665. </member>
  3666. </members>
  3667. </doc>