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.

2661 lines
118 KiB

1 year ago
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>RestSharp.Silverlight</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.Deserializers.DeserializeAsAttribute">
  299. <summary>
  300. Allows control how class and property names and values are deserialized by XmlAttributeDeserializer
  301. </summary>
  302. </member>
  303. <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Name">
  304. <summary>
  305. The name to use for the serialized element
  306. </summary>
  307. </member>
  308. <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Attribute">
  309. <summary>
  310. Sets if the property to Deserialize is an Attribute or Element (Default: false)
  311. </summary>
  312. </member>
  313. <member name="T:RestSharp.Deserializers.DotNetXmlDeserializer">
  314. <summary>
  315. Wrapper for System.Xml.Serialization.XmlSerializer.
  316. </summary>
  317. </member>
  318. <member name="T:RestSharp.ParameterType">
  319. <summary>
  320. Types of parameters that can be added to requests
  321. </summary>
  322. </member>
  323. <member name="T:RestSharp.DataFormat">
  324. <summary>
  325. Data formats
  326. </summary>
  327. </member>
  328. <member name="T:RestSharp.Method">
  329. <summary>
  330. HTTP method to use when making requests
  331. </summary>
  332. </member>
  333. <member name="T:RestSharp.DateFormat">
  334. <summary>
  335. Format strings for commonly-used date formats
  336. </summary>
  337. </member>
  338. <member name="F:RestSharp.DateFormat.Iso8601">
  339. <summary>
  340. .NET format string for ISO 8601 date format
  341. </summary>
  342. </member>
  343. <member name="F:RestSharp.DateFormat.RoundTrip">
  344. <summary>
  345. .NET format string for roundtrip date format
  346. </summary>
  347. </member>
  348. <member name="T:RestSharp.ResponseStatus">
  349. <summary>
  350. Status for responses (surprised?)
  351. </summary>
  352. </member>
  353. <member name="T:RestSharp.Extensions.MiscExtensions">
  354. <summary>
  355. Extension method overload!
  356. </summary>
  357. </member>
  358. <member name="M:RestSharp.Extensions.MiscExtensions.SaveAs(System.Byte[],System.String)">
  359. <summary>
  360. Save a byte array to a file
  361. </summary>
  362. <param name="input">Bytes to save</param>
  363. <param name="path">Full path to save file to</param>
  364. </member>
  365. <member name="M:RestSharp.Extensions.MiscExtensions.ReadAsBytes(System.IO.Stream)">
  366. <summary>
  367. Read a stream into a byte array
  368. </summary>
  369. <param name="input">Stream to read</param>
  370. <returns>byte[]</returns>
  371. </member>
  372. <member name="M:RestSharp.Extensions.MiscExtensions.CopyTo(System.IO.Stream,System.IO.Stream)">
  373. <summary>
  374. Copies bytes from one stream to another
  375. </summary>
  376. <param name="input">The input stream.</param>
  377. <param name="output">The output stream.</param>
  378. </member>
  379. <member name="M:RestSharp.Extensions.MiscExtensions.AsString(System.Byte[])">
  380. <summary>
  381. Converts a byte array to a string, using its byte order mark to convert it to the right encoding.
  382. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx
  383. </summary>
  384. <param name="buffer">An array of bytes to convert</param>
  385. <returns>The byte as a string.</returns>
  386. </member>
  387. <member name="T:RestSharp.Extensions.ReflectionExtensions">
  388. <summary>
  389. Reflection extensions
  390. </summary>
  391. </member>
  392. <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Reflection.MemberInfo)">
  393. <summary>
  394. Retrieve an attribute from a member (property)
  395. </summary>
  396. <typeparam name="T">Type of attribute to retrieve</typeparam>
  397. <param name="prop">Member to retrieve attribute from</param>
  398. <returns></returns>
  399. </member>
  400. <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Type)">
  401. <summary>
  402. Retrieve an attribute from a type
  403. </summary>
  404. <typeparam name="T">Type of attribute to retrieve</typeparam>
  405. <param name="type">Type to retrieve attribute from</param>
  406. <returns></returns>
  407. </member>
  408. <member name="M:RestSharp.Extensions.ReflectionExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)">
  409. <summary>
  410. Checks a type to see if it derives from a raw generic (e.g. List[[]])
  411. </summary>
  412. <param name="toCheck"></param>
  413. <param name="generic"></param>
  414. <returns></returns>
  415. </member>
  416. <member name="M:RestSharp.Extensions.ReflectionExtensions.FindEnumValue(System.Type,System.String,System.Globalization.CultureInfo)">
  417. <summary>
  418. Find a value from a System.Enum by trying several possible variants
  419. of the string value of the enum.
  420. </summary>
  421. <param name="type">Type of enum</param>
  422. <param name="value">Value for which to search</param>
  423. <param name="culture">The culture used to calculate the name variants</param>
  424. <returns></returns>
  425. </member>
  426. <member name="M:RestSharp.Extensions.StringExtensions.UrlEncode(System.String)">
  427. <summary>
  428. Uses Uri.EscapeDataString() based on recommendations on MSDN
  429. http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx
  430. </summary>
  431. </member>
  432. <member name="M:RestSharp.Extensions.StringExtensions.HasValue(System.String)">
  433. <summary>
  434. Check that a string is not null or empty
  435. </summary>
  436. <param name="input">String to check</param>
  437. <returns>bool</returns>
  438. </member>
  439. <member name="M:RestSharp.Extensions.StringExtensions.RemoveUnderscoresAndDashes(System.String)">
  440. <summary>
  441. Remove underscores from a string
  442. </summary>
  443. <param name="input">String to process</param>
  444. <returns>string</returns>
  445. </member>
  446. <member name="M:RestSharp.Extensions.StringExtensions.ParseJsonDate(System.String,System.Globalization.CultureInfo)">
  447. <summary>
  448. Parses most common JSON date formats
  449. </summary>
  450. <param name="input">JSON value to parse</param>
  451. <param name="culture"></param>
  452. <returns>DateTime</returns>
  453. </member>
  454. <member name="M:RestSharp.Extensions.StringExtensions.RemoveSurroundingQuotes(System.String)">
  455. <summary>
  456. Remove leading and trailing " from a string
  457. </summary>
  458. <param name="input">String to parse</param>
  459. <returns>String</returns>
  460. </member>
  461. <member name="M:RestSharp.Extensions.StringExtensions.Matches(System.String,System.String)">
  462. <summary>
  463. Checks a string to see if it matches a regex
  464. </summary>
  465. <param name="input">String to check</param>
  466. <param name="pattern">Pattern to match</param>
  467. <returns>bool</returns>
  468. </member>
  469. <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Globalization.CultureInfo)">
  470. <summary>
  471. Converts a string to pascal case
  472. </summary>
  473. <param name="lowercaseAndUnderscoredWord">String to convert</param>
  474. <param name="culture"></param>
  475. <returns>string</returns>
  476. </member>
  477. <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Boolean,System.Globalization.CultureInfo)">
  478. <summary>
  479. Converts a string to pascal case with the option to remove underscores
  480. </summary>
  481. <param name="text">String to convert</param>
  482. <param name="removeUnderscores">Option to remove underscores</param>
  483. <param name="culture"></param>
  484. <returns></returns>
  485. </member>
  486. <member name="M:RestSharp.Extensions.StringExtensions.ToCamelCase(System.String,System.Globalization.CultureInfo)">
  487. <summary>
  488. Converts a string to camel case
  489. </summary>
  490. <param name="lowercaseAndUnderscoredWord">String to convert</param>
  491. <param name="culture"></param>
  492. <returns>String</returns>
  493. </member>
  494. <member name="M:RestSharp.Extensions.StringExtensions.MakeInitialLowerCase(System.String)">
  495. <summary>
  496. Convert the first letter of a string to lower case
  497. </summary>
  498. <param name="word">String to convert</param>
  499. <returns>string</returns>
  500. </member>
  501. <member name="M:RestSharp.Extensions.StringExtensions.IsUpperCase(System.String)">
  502. <summary>
  503. Checks to see if a string is all uppper case
  504. </summary>
  505. <param name="inputString">String to check</param>
  506. <returns>bool</returns>
  507. </member>
  508. <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscores(System.String)">
  509. <summary>
  510. Add underscores to a pascal-cased string
  511. </summary>
  512. <param name="pascalCasedWord">String to convert</param>
  513. <returns>string</returns>
  514. </member>
  515. <member name="M:RestSharp.Extensions.StringExtensions.AddDashes(System.String)">
  516. <summary>
  517. Add dashes to a pascal-cased string
  518. </summary>
  519. <param name="pascalCasedWord">String to convert</param>
  520. <returns>string</returns>
  521. </member>
  522. <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscorePrefix(System.String)">
  523. <summary>
  524. Add an undescore prefix to a pascasl-cased string
  525. </summary>
  526. <param name="pascalCasedWord"></param>
  527. <returns></returns>
  528. </member>
  529. <member name="M:RestSharp.Extensions.StringExtensions.AddSpaces(System.String)">
  530. <summary>
  531. Add spaces to a pascal-cased string
  532. </summary>
  533. <param name="pascalCasedWord">String to convert</param>
  534. <returns>string</returns>
  535. </member>
  536. <member name="M:RestSharp.Extensions.StringExtensions.GetNameVariants(System.String,System.Globalization.CultureInfo)">
  537. <summary>
  538. Return possible variants of a name for name matching.
  539. </summary>
  540. <param name="name">String to convert</param>
  541. <param name="culture">The culture to use for conversion</param>
  542. <returns>IEnumerable&lt;string&gt;</returns>
  543. </member>
  544. <member name="T:RestSharp.Extensions.XmlExtensions">
  545. <summary>
  546. XML Extension Methods
  547. </summary>
  548. </member>
  549. <member name="M:RestSharp.Extensions.XmlExtensions.AsNamespaced(System.String,System.String)">
  550. <summary>
  551. Returns the name of an element with the namespace if specified
  552. </summary>
  553. <param name="name">Element name</param>
  554. <param name="namespace">XML Namespace</param>
  555. <returns></returns>
  556. </member>
  557. <member name="T:RestSharp.FileParameter">
  558. <summary>
  559. Container for files to be uploaded with requests
  560. </summary>
  561. </member>
  562. <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String,System.String)">
  563. <summary>
  564. Creates a file parameter from an array of bytes.
  565. </summary>
  566. <param name="name">The parameter name to use in the request.</param>
  567. <param name="data">The data to use as the file's contents.</param>
  568. <param name="filename">The filename to use in the request.</param>
  569. <param name="contentType">The content type to use in the request.</param>
  570. <returns>The <see cref="T:RestSharp.FileParameter"/></returns>
  571. </member>
  572. <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String)">
  573. <summary>
  574. Creates a file parameter from an array of bytes.
  575. </summary>
  576. <param name="name">The parameter name to use in the request.</param>
  577. <param name="data">The data to use as the file's contents.</param>
  578. <param name="filename">The filename to use in the request.</param>
  579. <returns>The <see cref="T:RestSharp.FileParameter"/> using the default content type.</returns>
  580. </member>
  581. <member name="P:RestSharp.FileParameter.ContentLength">
  582. <summary>
  583. The length of data to be sent
  584. </summary>
  585. </member>
  586. <member name="P:RestSharp.FileParameter.Writer">
  587. <summary>
  588. Provides raw data for file
  589. </summary>
  590. </member>
  591. <member name="P:RestSharp.FileParameter.FileName">
  592. <summary>
  593. Name of the file to use when uploading
  594. </summary>
  595. </member>
  596. <member name="P:RestSharp.FileParameter.ContentType">
  597. <summary>
  598. MIME content type of file
  599. </summary>
  600. </member>
  601. <member name="P:RestSharp.FileParameter.Name">
  602. <summary>
  603. Name of the parameter
  604. </summary>
  605. </member>
  606. <member name="T:RestSharp.Http">
  607. <summary>
  608. HttpWebRequest wrapper (async methods)
  609. </summary>
  610. <summary>
  611. HttpWebRequest wrapper
  612. </summary>
  613. </member>
  614. <member name="P:RestSharp.IHttp.AlwaysMultipartFormData">
  615. <summary>
  616. Always send a multipart/form-data request - even when no Files are present.
  617. </summary>
  618. </member>
  619. <member name="P:RestSharp.IHttp.RequestBodyBytes">
  620. <summary>
  621. An alternative to RequestBody, for when the caller already has the byte array.
  622. </summary>
  623. </member>
  624. <member name="M:RestSharp.Http.AsPostAsync(System.Action{RestSharp.HttpResponse},System.String)">
  625. <summary>
  626. Execute an async POST-style request with the specified HTTP Method.
  627. </summary>
  628. <param name="action"></param>
  629. <param name="httpMethod">The HTTP method to execute.</param>
  630. <returns></returns>
  631. </member>
  632. <member name="M:RestSharp.Http.AsGetAsync(System.Action{RestSharp.HttpResponse},System.String)">
  633. <summary>
  634. Execute an async GET-style request with the specified HTTP Method.
  635. </summary>
  636. <param name="action"></param>
  637. <param name="httpMethod">The HTTP method to execute.</param>
  638. <returns></returns>
  639. </member>
  640. <member name="M:RestSharp.Http.Create">
  641. <summary>
  642. Creates an IHttp
  643. </summary>
  644. <returns></returns>
  645. </member>
  646. <member name="M:RestSharp.Http.#ctor">
  647. <summary>
  648. Default constructor
  649. </summary>
  650. </member>
  651. <member name="P:RestSharp.Http.HasParameters">
  652. <summary>
  653. True if this HTTP request has any HTTP parameters
  654. </summary>
  655. </member>
  656. <member name="P:RestSharp.Http.HasCookies">
  657. <summary>
  658. True if this HTTP request has any HTTP cookies
  659. </summary>
  660. </member>
  661. <member name="P:RestSharp.Http.HasBody">
  662. <summary>
  663. True if a request body has been specified
  664. </summary>
  665. </member>
  666. <member name="P:RestSharp.Http.HasFiles">
  667. <summary>
  668. True if files have been set to be uploaded
  669. </summary>
  670. </member>
  671. <member name="P:RestSharp.Http.AlwaysMultipartFormData">
  672. <summary>
  673. Always send a multipart/form-data request - even when no Files are present.
  674. </summary>
  675. </member>
  676. <member name="P:RestSharp.Http.UserAgent">
  677. <summary>
  678. UserAgent to be sent with request
  679. </summary>
  680. </member>
  681. <member name="P:RestSharp.Http.Timeout">
  682. <summary>
  683. Timeout in milliseconds to be used for the request
  684. </summary>
  685. </member>
  686. <member name="P:RestSharp.Http.ReadWriteTimeout">
  687. <summary>
  688. The number of milliseconds before the writing or reading times out.
  689. </summary>
  690. </member>
  691. <member name="P:RestSharp.Http.Credentials">
  692. <summary>
  693. System.Net.ICredentials to be sent with request
  694. </summary>
  695. </member>
  696. <member name="P:RestSharp.Http.CookieContainer">
  697. <summary>
  698. The System.Net.CookieContainer to be used for the request
  699. </summary>
  700. </member>
  701. <member name="P:RestSharp.Http.ResponseWriter">
  702. <summary>
  703. The method to use to write the response instead of reading into RawBytes
  704. </summary>
  705. </member>
  706. <member name="P:RestSharp.Http.Files">
  707. <summary>
  708. Collection of files to be sent with request
  709. </summary>
  710. </member>
  711. <member name="P:RestSharp.Http.UseDefaultCredentials">
  712. <summary>
  713. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  714. will be sent along to the server.
  715. </summary>
  716. </member>
  717. <member name="P:RestSharp.Http.Headers">
  718. <summary>
  719. HTTP headers to be sent with request
  720. </summary>
  721. </member>
  722. <member name="P:RestSharp.Http.Parameters">
  723. <summary>
  724. HTTP parameters (QueryString or Form values) to be sent with request
  725. </summary>
  726. </member>
  727. <member name="P:RestSharp.Http.Cookies">
  728. <summary>
  729. HTTP cookies to be sent with request
  730. </summary>
  731. </member>
  732. <member name="P:RestSharp.Http.RequestBody">
  733. <summary>
  734. Request body to be sent with request
  735. </summary>
  736. </member>
  737. <member name="P:RestSharp.Http.RequestContentType">
  738. <summary>
  739. Content type of the request body.
  740. </summary>
  741. </member>
  742. <member name="P:RestSharp.Http.RequestBodyBytes">
  743. <summary>
  744. An alternative to RequestBody, for when the caller already has the byte array.
  745. </summary>
  746. </member>
  747. <member name="P:RestSharp.Http.Url">
  748. <summary>
  749. URL to call for this request
  750. </summary>
  751. </member>
  752. <member name="P:RestSharp.Http.PreAuthenticate">
  753. <summary>
  754. Flag to send authorisation header with the HttpWebRequest
  755. </summary>
  756. </member>
  757. <member name="T:RestSharp.HttpCookie">
  758. <summary>
  759. Representation of an HTTP cookie
  760. </summary>
  761. </member>
  762. <member name="P:RestSharp.HttpCookie.Comment">
  763. <summary>
  764. Comment of the cookie
  765. </summary>
  766. </member>
  767. <member name="P:RestSharp.HttpCookie.CommentUri">
  768. <summary>
  769. Comment of the cookie
  770. </summary>
  771. </member>
  772. <member name="P:RestSharp.HttpCookie.Discard">
  773. <summary>
  774. Indicates whether the cookie should be discarded at the end of the session
  775. </summary>
  776. </member>
  777. <member name="P:RestSharp.HttpCookie.Domain">
  778. <summary>
  779. Domain of the cookie
  780. </summary>
  781. </member>
  782. <member name="P:RestSharp.HttpCookie.Expired">
  783. <summary>
  784. Indicates whether the cookie is expired
  785. </summary>
  786. </member>
  787. <member name="P:RestSharp.HttpCookie.Expires">
  788. <summary>
  789. Date and time that the cookie expires
  790. </summary>
  791. </member>
  792. <member name="P:RestSharp.HttpCookie.HttpOnly">
  793. <summary>
  794. Indicates that this cookie should only be accessed by the server
  795. </summary>
  796. </member>
  797. <member name="P:RestSharp.HttpCookie.Name">
  798. <summary>
  799. Name of the cookie
  800. </summary>
  801. </member>
  802. <member name="P:RestSharp.HttpCookie.Path">
  803. <summary>
  804. Path of the cookie
  805. </summary>
  806. </member>
  807. <member name="P:RestSharp.HttpCookie.Port">
  808. <summary>
  809. Port of the cookie
  810. </summary>
  811. </member>
  812. <member name="P:RestSharp.HttpCookie.Secure">
  813. <summary>
  814. Indicates that the cookie should only be sent over secure channels
  815. </summary>
  816. </member>
  817. <member name="P:RestSharp.HttpCookie.TimeStamp">
  818. <summary>
  819. Date and time the cookie was created
  820. </summary>
  821. </member>
  822. <member name="P:RestSharp.HttpCookie.Value">
  823. <summary>
  824. Value of the cookie
  825. </summary>
  826. </member>
  827. <member name="P:RestSharp.HttpCookie.Version">
  828. <summary>
  829. Version of the cookie
  830. </summary>
  831. </member>
  832. <member name="T:RestSharp.HttpFile">
  833. <summary>
  834. Container for HTTP file
  835. </summary>
  836. </member>
  837. <member name="P:RestSharp.HttpFile.ContentLength">
  838. <summary>
  839. The length of data to be sent
  840. </summary>
  841. </member>
  842. <member name="P:RestSharp.HttpFile.Writer">
  843. <summary>
  844. Provides raw data for file
  845. </summary>
  846. </member>
  847. <member name="P:RestSharp.HttpFile.FileName">
  848. <summary>
  849. Name of the file to use when uploading
  850. </summary>
  851. </member>
  852. <member name="P:RestSharp.HttpFile.ContentType">
  853. <summary>
  854. MIME content type of file
  855. </summary>
  856. </member>
  857. <member name="P:RestSharp.HttpFile.Name">
  858. <summary>
  859. Name of the parameter
  860. </summary>
  861. </member>
  862. <member name="T:RestSharp.HttpHeader">
  863. <summary>
  864. Representation of an HTTP header
  865. </summary>
  866. </member>
  867. <member name="P:RestSharp.HttpHeader.Name">
  868. <summary>
  869. Name of the header
  870. </summary>
  871. </member>
  872. <member name="P:RestSharp.HttpHeader.Value">
  873. <summary>
  874. Value of the header
  875. </summary>
  876. </member>
  877. <member name="T:RestSharp.HttpParameter">
  878. <summary>
  879. Representation of an HTTP parameter (QueryString or Form value)
  880. </summary>
  881. </member>
  882. <member name="P:RestSharp.HttpParameter.Name">
  883. <summary>
  884. Name of the parameter
  885. </summary>
  886. </member>
  887. <member name="P:RestSharp.HttpParameter.Value">
  888. <summary>
  889. Value of the parameter
  890. </summary>
  891. </member>
  892. <member name="T:RestSharp.HttpResponse">
  893. <summary>
  894. HTTP response data
  895. </summary>
  896. </member>
  897. <member name="T:RestSharp.IHttpResponse">
  898. <summary>
  899. HTTP response data
  900. </summary>
  901. </member>
  902. <member name="P:RestSharp.IHttpResponse.ContentType">
  903. <summary>
  904. MIME content type of response
  905. </summary>
  906. </member>
  907. <member name="P:RestSharp.IHttpResponse.ContentLength">
  908. <summary>
  909. Length in bytes of the response content
  910. </summary>
  911. </member>
  912. <member name="P:RestSharp.IHttpResponse.ContentEncoding">
  913. <summary>
  914. Encoding of the response content
  915. </summary>
  916. </member>
  917. <member name="P:RestSharp.IHttpResponse.Content">
  918. <summary>
  919. String representation of response content
  920. </summary>
  921. </member>
  922. <member name="P:RestSharp.IHttpResponse.StatusCode">
  923. <summary>
  924. HTTP response status code
  925. </summary>
  926. </member>
  927. <member name="P:RestSharp.IHttpResponse.StatusDescription">
  928. <summary>
  929. Description of HTTP status returned
  930. </summary>
  931. </member>
  932. <member name="P:RestSharp.IHttpResponse.RawBytes">
  933. <summary>
  934. Response content
  935. </summary>
  936. </member>
  937. <member name="P:RestSharp.IHttpResponse.ResponseUri">
  938. <summary>
  939. The URL that actually responded to the content (different from request if redirected)
  940. </summary>
  941. </member>
  942. <member name="P:RestSharp.IHttpResponse.Server">
  943. <summary>
  944. HttpWebResponse.Server
  945. </summary>
  946. </member>
  947. <member name="P:RestSharp.IHttpResponse.Headers">
  948. <summary>
  949. Headers returned by server with the response
  950. </summary>
  951. </member>
  952. <member name="P:RestSharp.IHttpResponse.Cookies">
  953. <summary>
  954. Cookies returned by server with the response
  955. </summary>
  956. </member>
  957. <member name="P:RestSharp.IHttpResponse.ResponseStatus">
  958. <summary>
  959. Status of the request. Will return Error for transport errors.
  960. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  961. </summary>
  962. </member>
  963. <member name="P:RestSharp.IHttpResponse.ErrorMessage">
  964. <summary>
  965. Transport or other non-HTTP error generated while attempting request
  966. </summary>
  967. </member>
  968. <member name="P:RestSharp.IHttpResponse.ErrorException">
  969. <summary>
  970. Exception thrown when error is encountered.
  971. </summary>
  972. </member>
  973. <member name="M:RestSharp.HttpResponse.#ctor">
  974. <summary>
  975. Default constructor
  976. </summary>
  977. </member>
  978. <member name="P:RestSharp.HttpResponse.ContentType">
  979. <summary>
  980. MIME content type of response
  981. </summary>
  982. </member>
  983. <member name="P:RestSharp.HttpResponse.ContentLength">
  984. <summary>
  985. Length in bytes of the response content
  986. </summary>
  987. </member>
  988. <member name="P:RestSharp.HttpResponse.ContentEncoding">
  989. <summary>
  990. Encoding of the response content
  991. </summary>
  992. </member>
  993. <member name="P:RestSharp.HttpResponse.Content">
  994. <summary>
  995. Lazy-loaded string representation of response content
  996. </summary>
  997. </member>
  998. <member name="P:RestSharp.HttpResponse.StatusCode">
  999. <summary>
  1000. HTTP response status code
  1001. </summary>
  1002. </member>
  1003. <member name="P:RestSharp.HttpResponse.StatusDescription">
  1004. <summary>
  1005. Description of HTTP status returned
  1006. </summary>
  1007. </member>
  1008. <member name="P:RestSharp.HttpResponse.RawBytes">
  1009. <summary>
  1010. Response content
  1011. </summary>
  1012. </member>
  1013. <member name="P:RestSharp.HttpResponse.ResponseUri">
  1014. <summary>
  1015. The URL that actually responded to the content (different from request if redirected)
  1016. </summary>
  1017. </member>
  1018. <member name="P:RestSharp.HttpResponse.Server">
  1019. <summary>
  1020. HttpWebResponse.Server
  1021. </summary>
  1022. </member>
  1023. <member name="P:RestSharp.HttpResponse.Headers">
  1024. <summary>
  1025. Headers returned by server with the response
  1026. </summary>
  1027. </member>
  1028. <member name="P:RestSharp.HttpResponse.Cookies">
  1029. <summary>
  1030. Cookies returned by server with the response
  1031. </summary>
  1032. </member>
  1033. <member name="P:RestSharp.HttpResponse.ResponseStatus">
  1034. <summary>
  1035. Status of the request. Will return Error for transport errors.
  1036. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  1037. </summary>
  1038. </member>
  1039. <member name="P:RestSharp.HttpResponse.ErrorMessage">
  1040. <summary>
  1041. Transport or other non-HTTP error generated while attempting request
  1042. </summary>
  1043. </member>
  1044. <member name="P:RestSharp.HttpResponse.ErrorException">
  1045. <summary>
  1046. Exception thrown when error is encountered.
  1047. </summary>
  1048. </member>
  1049. <member name="T:RestSharp.IRestClient">
  1050. <summary>
  1051. </summary>
  1052. </member>
  1053. <member name="M:RestSharp.IRestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})">
  1054. <summary>
  1055. </summary>
  1056. <param name="request"></param>
  1057. <param name="callback"></param>
  1058. </member>
  1059. <member name="M:RestSharp.IRestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})">
  1060. <summary>
  1061. </summary>
  1062. <param name="request"></param>
  1063. <param name="callback"></param>
  1064. </member>
  1065. <member name="M:RestSharp.IRestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  1066. <summary>
  1067. Executes a GET-style request and callback asynchronously, authenticating if needed
  1068. </summary>
  1069. <param name="request">Request to be executed</param>
  1070. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  1071. <param name="httpMethod">The HTTP method to execute</param>
  1072. </member>
  1073. <member name="M:RestSharp.IRestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  1074. <summary>
  1075. Executes a POST-style request and callback asynchronously, authenticating if needed
  1076. </summary>
  1077. <param name="request">Request to be executed</param>
  1078. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  1079. <param name="httpMethod">The HTTP method to execute</param>
  1080. </member>
  1081. <member name="M:RestSharp.IRestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  1082. <summary>
  1083. Executes a GET-style request and callback asynchronously, authenticating if needed
  1084. </summary>
  1085. <typeparam name="T">Target deserialization type</typeparam>
  1086. <param name="request">Request to be executed</param>
  1087. <param name="callback">Callback function to be executed upon completion</param>
  1088. <param name="httpMethod">The HTTP method to execute</param>
  1089. </member>
  1090. <member name="M:RestSharp.IRestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  1091. <summary>
  1092. Executes a GET-style request and callback asynchronously, authenticating if needed
  1093. </summary>
  1094. <typeparam name="T">Target deserialization type</typeparam>
  1095. <param name="request">Request to be executed</param>
  1096. <param name="callback">Callback function to be executed upon completion</param>
  1097. <param name="httpMethod">The HTTP method to execute</param>
  1098. </member>
  1099. <member name="P:RestSharp.IRestClient.CookieContainer">
  1100. <summary>
  1101. </summary>
  1102. </member>
  1103. <member name="P:RestSharp.IRestClient.UserAgent">
  1104. <summary>
  1105. </summary>
  1106. </member>
  1107. <member name="P:RestSharp.IRestClient.Timeout">
  1108. <summary>
  1109. </summary>
  1110. </member>
  1111. <member name="P:RestSharp.IRestClient.ReadWriteTimeout">
  1112. <summary>
  1113. </summary>
  1114. </member>
  1115. <member name="P:RestSharp.IRestClient.UseSynchronizationContext">
  1116. <summary>
  1117. </summary>
  1118. </member>
  1119. <member name="P:RestSharp.IRestClient.Authenticator">
  1120. <summary>
  1121. </summary>
  1122. </member>
  1123. <member name="P:RestSharp.IRestClient.BaseUrl">
  1124. <summary>
  1125. </summary>
  1126. </member>
  1127. <member name="P:RestSharp.IRestClient.PreAuthenticate">
  1128. <summary>
  1129. </summary>
  1130. </member>
  1131. <member name="P:RestSharp.IRestClient.DefaultParameters">
  1132. <summary>
  1133. </summary>
  1134. </member>
  1135. <member name="M:RestSharp.IRestRequest.AddBody(System.Object,System.String)">
  1136. <summary>
  1137. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  1138. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  1139. </summary>
  1140. <param name="obj">The object to serialize</param>
  1141. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  1142. <returns>This request</returns>
  1143. </member>
  1144. <member name="M:RestSharp.IRestRequest.AddBody(System.Object)">
  1145. <summary>
  1146. Serializes obj to data format specified by RequestFormat and adds it to the request body.
  1147. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  1148. </summary>
  1149. <param name="obj">The object to serialize</param>
  1150. <returns>This request</returns>
  1151. </member>
  1152. <member name="M:RestSharp.IRestRequest.AddJsonBody(System.Object)">
  1153. <summary>
  1154. Serializes obj to JSON format and adds it to the request body.
  1155. </summary>
  1156. <param name="obj">The object to serialize</param>
  1157. <returns>This request</returns>
  1158. </member>
  1159. <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object)">
  1160. <summary>
  1161. Serializes obj to XML format and adds it to the request body.
  1162. </summary>
  1163. <param name="obj">The object to serialize</param>
  1164. <returns>This request</returns>
  1165. </member>
  1166. <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object,System.String)">
  1167. <summary>
  1168. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  1169. Serializes obj to XML format and passes xmlNamespace then adds it to the request body.
  1170. </summary>
  1171. <param name="obj">The object to serialize</param>
  1172. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  1173. <returns>This request</returns>
  1174. </member>
  1175. <member name="M:RestSharp.IRestRequest.AddObject(System.Object,System.String[])">
  1176. <summary>
  1177. Calls AddParameter() for all public, readable properties specified in the includedProperties list
  1178. </summary>
  1179. <example>
  1180. request.AddObject(product, "ProductId", "Price", ...);
  1181. </example>
  1182. <param name="obj">The object with properties to add as parameters</param>
  1183. <param name="includedProperties">The names of the properties to include</param>
  1184. <returns>This request</returns>
  1185. </member>
  1186. <member name="M:RestSharp.IRestRequest.AddObject(System.Object)">
  1187. <summary>
  1188. Calls AddParameter() for all public, readable properties of obj
  1189. </summary>
  1190. <param name="obj">The object with properties to add as parameters</param>
  1191. <returns>This request</returns>
  1192. </member>
  1193. <member name="M:RestSharp.IRestRequest.AddParameter(RestSharp.Parameter)">
  1194. <summary>
  1195. Add the parameter to the request
  1196. </summary>
  1197. <param name="p">Parameter to add</param>
  1198. <returns></returns>
  1199. </member>
  1200. <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object)">
  1201. <summary>
  1202. Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  1203. </summary>
  1204. <param name="name">Name of the parameter</param>
  1205. <param name="value">Value of the parameter</param>
  1206. <returns>This request</returns>
  1207. </member>
  1208. <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)">
  1209. <summary>
  1210. Adds a parameter to the request. There are five types of parameters:
  1211. - GetOrPost: Either a QueryString value or encoded form value based on method
  1212. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  1213. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  1214. - Cookie: Adds the name/value pair to the HTTP request's Cookies collection
  1215. - RequestBody: Used by AddBody() (not recommended to use directly)
  1216. </summary>
  1217. <param name="name">Name of the parameter</param>
  1218. <param name="value">Value of the parameter</param>
  1219. <param name="type">The type of parameter to add</param>
  1220. <returns>This request</returns>
  1221. </member>
  1222. <member name="M:RestSharp.IRestRequest.AddHeader(System.String,System.String)">
  1223. <summary>
  1224. Shortcut to AddParameter(name, value, HttpHeader) overload
  1225. </summary>
  1226. <param name="name">Name of the header to add</param>
  1227. <param name="value">Value of the header to add</param>
  1228. <returns></returns>
  1229. </member>
  1230. <member name="M:RestSharp.IRestRequest.AddCookie(System.String,System.String)">
  1231. <summary>
  1232. Shortcut to AddParameter(name, value, Cookie) overload
  1233. </summary>
  1234. <param name="name">Name of the cookie to add</param>
  1235. <param name="value">Value of the cookie to add</param>
  1236. <returns></returns>
  1237. </member>
  1238. <member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.String)">
  1239. <summary>
  1240. Shortcut to AddParameter(name, value, UrlSegment) overload
  1241. </summary>
  1242. <param name="name">Name of the segment to add</param>
  1243. <param name="value">Value of the segment to add</param>
  1244. <returns></returns>
  1245. </member>
  1246. <member name="M:RestSharp.IRestRequest.AddQueryParameter(System.String,System.String)">
  1247. <summary>
  1248. Shortcut to AddParameter(name, value, QueryString) overload
  1249. </summary>
  1250. <param name="name">Name of the parameter to add</param>
  1251. <param name="value">Value of the parameter to add</param>
  1252. <returns></returns>
  1253. </member>
  1254. <member name="P:RestSharp.IRestRequest.AlwaysMultipartFormData">
  1255. <summary>
  1256. Always send a multipart/form-data request - even when no Files are present.
  1257. </summary>
  1258. </member>
  1259. <member name="P:RestSharp.IRestRequest.JsonSerializer">
  1260. <summary>
  1261. Serializer to use when writing JSON request bodies. Used if RequestFormat is Json.
  1262. By default the included JsonSerializer is used (currently using JSON.NET default serialization).
  1263. </summary>
  1264. </member>
  1265. <member name="P:RestSharp.IRestRequest.XmlSerializer">
  1266. <summary>
  1267. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  1268. By default the included XmlSerializer is used.
  1269. </summary>
  1270. </member>
  1271. <member name="P:RestSharp.IRestRequest.ResponseWriter">
  1272. <summary>
  1273. Set this to write response to Stream rather than reading into memory.
  1274. </summary>
  1275. </member>
  1276. <member name="P:RestSharp.IRestRequest.Parameters">
  1277. <summary>
  1278. Container of all HTTP parameters to be passed with the request.
  1279. See AddParameter() for explanation of the types of parameters that can be passed
  1280. </summary>
  1281. </member>
  1282. <member name="P:RestSharp.IRestRequest.Files">
  1283. <summary>
  1284. Container of all the files to be uploaded with the request.
  1285. </summary>
  1286. </member>
  1287. <member name="P:RestSharp.IRestRequest.Method">
  1288. <summary>
  1289. Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS
  1290. Default is GET
  1291. </summary>
  1292. </member>
  1293. <member name="P:RestSharp.IRestRequest.Resource">
  1294. <summary>
  1295. The Resource URL to make the request against.
  1296. Tokens are substituted with UrlSegment parameters and match by name.
  1297. Should not include the scheme or domain. Do not include leading slash.
  1298. Combined with RestClient.BaseUrl to assemble final URL:
  1299. {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com)
  1300. </summary>
  1301. <example>
  1302. // example for url token replacement
  1303. request.Resource = "Products/{ProductId}";
  1304. request.AddParameter("ProductId", 123, ParameterType.UrlSegment);
  1305. </example>
  1306. </member>
  1307. <member name="P:RestSharp.IRestRequest.RequestFormat">
  1308. <summary>
  1309. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  1310. By default XmlSerializer is used.
  1311. </summary>
  1312. </member>
  1313. <member name="P:RestSharp.IRestRequest.RootElement">
  1314. <summary>
  1315. Used by the default deserializers to determine where to start deserializing from.
  1316. Can be used to skip container or root elements that do not have corresponding deserialzation targets.
  1317. </summary>
  1318. </member>
  1319. <member name="P:RestSharp.IRestRequest.DateFormat">
  1320. <summary>
  1321. Used by the default deserializers to explicitly set which date format string to use when parsing dates.
  1322. </summary>
  1323. </member>
  1324. <member name="P:RestSharp.IRestRequest.XmlNamespace">
  1325. <summary>
  1326. Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names.
  1327. </summary>
  1328. </member>
  1329. <member name="P:RestSharp.IRestRequest.Credentials">
  1330. <summary>
  1331. In general you would not need to set this directly. Used by the NtlmAuthenticator.
  1332. </summary>
  1333. </member>
  1334. <member name="P:RestSharp.IRestRequest.Timeout">
  1335. <summary>
  1336. Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient.
  1337. </summary>
  1338. </member>
  1339. <member name="P:RestSharp.IRestRequest.ReadWriteTimeout">
  1340. <summary>
  1341. The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient.
  1342. </summary>
  1343. </member>
  1344. <member name="P:RestSharp.IRestRequest.Attempts">
  1345. <summary>
  1346. How many attempts were made to send this Request?
  1347. </summary>
  1348. <remarks>
  1349. This Number is incremented each time the RestClient sends the request.
  1350. Useful when using Asynchronous Execution with Callbacks
  1351. </remarks>
  1352. </member>
  1353. <member name="P:RestSharp.IRestRequest.UseDefaultCredentials">
  1354. <summary>
  1355. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  1356. will be sent along to the server. The default is false.
  1357. </summary>
  1358. </member>
  1359. <member name="T:RestSharp.IRestResponse">
  1360. <summary>
  1361. Container for data sent back from API
  1362. </summary>
  1363. </member>
  1364. <member name="P:RestSharp.IRestResponse.Request">
  1365. <summary>
  1366. The RestRequest that was made to get this RestResponse
  1367. </summary>
  1368. <remarks>
  1369. Mainly for debugging if ResponseStatus is not OK
  1370. </remarks>
  1371. </member>
  1372. <member name="P:RestSharp.IRestResponse.ContentType">
  1373. <summary>
  1374. MIME content type of response
  1375. </summary>
  1376. </member>
  1377. <member name="P:RestSharp.IRestResponse.ContentLength">
  1378. <summary>
  1379. Length in bytes of the response content
  1380. </summary>
  1381. </member>
  1382. <member name="P:RestSharp.IRestResponse.ContentEncoding">
  1383. <summary>
  1384. Encoding of the response content
  1385. </summary>
  1386. </member>
  1387. <member name="P:RestSharp.IRestResponse.Content">
  1388. <summary>
  1389. String representation of response content
  1390. </summary>
  1391. </member>
  1392. <member name="P:RestSharp.IRestResponse.StatusCode">
  1393. <summary>
  1394. HTTP response status code
  1395. </summary>
  1396. </member>
  1397. <member name="P:RestSharp.IRestResponse.StatusDescription">
  1398. <summary>
  1399. Description of HTTP status returned
  1400. </summary>
  1401. </member>
  1402. <member name="P:RestSharp.IRestResponse.RawBytes">
  1403. <summary>
  1404. Response content
  1405. </summary>
  1406. </member>
  1407. <member name="P:RestSharp.IRestResponse.ResponseUri">
  1408. <summary>
  1409. The URL that actually responded to the content (different from request if redirected)
  1410. </summary>
  1411. </member>
  1412. <member name="P:RestSharp.IRestResponse.Server">
  1413. <summary>
  1414. HttpWebResponse.Server
  1415. </summary>
  1416. </member>
  1417. <member name="P:RestSharp.IRestResponse.Cookies">
  1418. <summary>
  1419. Cookies returned by server with the response
  1420. </summary>
  1421. </member>
  1422. <member name="P:RestSharp.IRestResponse.Headers">
  1423. <summary>
  1424. Headers returned by server with the response
  1425. </summary>
  1426. </member>
  1427. <member name="P:RestSharp.IRestResponse.ResponseStatus">
  1428. <summary>
  1429. Status of the request. Will return Error for transport errors.
  1430. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  1431. </summary>
  1432. </member>
  1433. <member name="P:RestSharp.IRestResponse.ErrorMessage">
  1434. <summary>
  1435. Transport or other non-HTTP error generated while attempting request
  1436. </summary>
  1437. </member>
  1438. <member name="P:RestSharp.IRestResponse.ErrorException">
  1439. <summary>
  1440. Exceptions thrown during the request, if any.
  1441. </summary>
  1442. <remarks>Will contain only network transport or framework exceptions thrown during the request.
  1443. HTTP protocol errors are handled by RestSharp and will not appear here.</remarks>
  1444. </member>
  1445. <member name="T:RestSharp.IRestResponse`1">
  1446. <summary>
  1447. Container for data sent back from API including deserialized data
  1448. </summary>
  1449. <typeparam name="T">Type of data to deserialize to</typeparam>
  1450. </member>
  1451. <member name="P:RestSharp.IRestResponse`1.Data">
  1452. <summary>
  1453. Deserialized entity data
  1454. </summary>
  1455. </member>
  1456. <member name="T:RestSharp.Parameter">
  1457. <summary>
  1458. Parameter container for REST requests
  1459. </summary>
  1460. </member>
  1461. <member name="M:RestSharp.Parameter.ToString">
  1462. <summary>
  1463. Return a human-readable representation of this parameter
  1464. </summary>
  1465. <returns>String</returns>
  1466. </member>
  1467. <member name="P:RestSharp.Parameter.Name">
  1468. <summary>
  1469. Name of the parameter
  1470. </summary>
  1471. </member>
  1472. <member name="P:RestSharp.Parameter.Value">
  1473. <summary>
  1474. Value of the parameter
  1475. </summary>
  1476. </member>
  1477. <member name="P:RestSharp.Parameter.Type">
  1478. <summary>
  1479. Type of the parameter
  1480. </summary>
  1481. </member>
  1482. <member name="T:RestSharp.RestClient">
  1483. <summary>
  1484. Client to translate RestRequests into Http requests and process response result
  1485. </summary>
  1486. </member>
  1487. <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})">
  1488. <summary>
  1489. Executes the request and callback asynchronously, authenticating if needed
  1490. </summary>
  1491. <param name="request">Request to be executed</param>
  1492. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  1493. </member>
  1494. <member name="M:RestSharp.RestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  1495. <summary>
  1496. Executes a GET-style request and callback asynchronously, authenticating if needed
  1497. </summary>
  1498. <param name="request">Request to be executed</param>
  1499. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  1500. <param name="httpMethod">The HTTP method to execute</param>
  1501. </member>
  1502. <member name="M:RestSharp.RestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)">
  1503. <summary>
  1504. Executes a POST-style request and callback asynchronously, authenticating if needed
  1505. </summary>
  1506. <param name="request">Request to be executed</param>
  1507. <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param>
  1508. <param name="httpMethod">The HTTP method to execute</param>
  1509. </member>
  1510. <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})">
  1511. <summary>
  1512. Executes the request and callback asynchronously, authenticating if needed
  1513. </summary>
  1514. <typeparam name="T">Target deserialization type</typeparam>
  1515. <param name="request">Request to be executed</param>
  1516. <param name="callback">Callback function to be executed upon completion</param>
  1517. </member>
  1518. <member name="M:RestSharp.RestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  1519. <summary>
  1520. Executes a GET-style request and callback asynchronously, authenticating if needed
  1521. </summary>
  1522. <typeparam name="T">Target deserialization type</typeparam>
  1523. <param name="request">Request to be executed</param>
  1524. <param name="callback">Callback function to be executed upon completion</param>
  1525. <param name="httpMethod">The HTTP method to execute</param>
  1526. </member>
  1527. <member name="M:RestSharp.RestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)">
  1528. <summary>
  1529. Executes a POST-style request and callback asynchronously, authenticating if needed
  1530. </summary>
  1531. <typeparam name="T">Target deserialization type</typeparam>
  1532. <param name="request">Request to be executed</param>
  1533. <param name="callback">Callback function to be executed upon completion</param>
  1534. <param name="httpMethod">The HTTP method to execute</param>
  1535. </member>
  1536. <member name="M:RestSharp.RestClient.#ctor">
  1537. <summary>
  1538. Default constructor that registers default content handlers
  1539. </summary>
  1540. </member>
  1541. <member name="M:RestSharp.RestClient.#ctor(System.Uri)">
  1542. <summary>
  1543. Sets the BaseUrl property for requests made by this client instance
  1544. </summary>
  1545. <param name="baseUrl"></param>
  1546. </member>
  1547. <member name="M:RestSharp.RestClient.#ctor(System.String)">
  1548. <summary>
  1549. Sets the BaseUrl property for requests made by this client instance
  1550. </summary>
  1551. <param name="baseUrl"></param>
  1552. </member>
  1553. <member name="M:RestSharp.RestClient.AddHandler(System.String,RestSharp.Deserializers.IDeserializer)">
  1554. <summary>
  1555. Registers a content handler to process response content
  1556. </summary>
  1557. <param name="contentType">MIME content type of the response content</param>
  1558. <param name="deserializer">Deserializer to use to process content</param>
  1559. </member>
  1560. <member name="M:RestSharp.RestClient.RemoveHandler(System.String)">
  1561. <summary>
  1562. Remove a content handler for the specified MIME content type
  1563. </summary>
  1564. <param name="contentType">MIME content type to remove</param>
  1565. </member>
  1566. <member name="M:RestSharp.RestClient.ClearHandlers">
  1567. <summary>
  1568. Remove all content handlers
  1569. </summary>
  1570. </member>
  1571. <member name="M:RestSharp.RestClient.GetHandler(System.String)">
  1572. <summary>
  1573. Retrieve the handler for the specified MIME content type
  1574. </summary>
  1575. <param name="contentType">MIME content type to retrieve</param>
  1576. <returns>IDeserializer instance</returns>
  1577. </member>
  1578. <member name="M:RestSharp.RestClient.BuildUri(RestSharp.IRestRequest)">
  1579. <summary>
  1580. Assembles URL to call based on parameters, method and resource
  1581. </summary>
  1582. <param name="request">RestRequest to execute</param>
  1583. <returns>Assembled System.Uri</returns>
  1584. </member>
  1585. <member name="P:RestSharp.RestClient.DefaultParameters">
  1586. <summary>
  1587. Parameters included with every request made with this instance of RestClient
  1588. If specified in both client and request, the request wins
  1589. </summary>
  1590. </member>
  1591. <member name="P:RestSharp.RestClient.MaxRedirects">
  1592. <summary>
  1593. Maximum number of redirects to follow if FollowRedirects is true
  1594. </summary>
  1595. </member>
  1596. <member name="P:RestSharp.RestClient.FollowRedirects">
  1597. <summary>
  1598. Default is true. Determine whether or not requests that result in
  1599. HTTP status codes of 3xx should follow returned redirect
  1600. </summary>
  1601. </member>
  1602. <member name="P:RestSharp.RestClient.CookieContainer">
  1603. <summary>
  1604. The CookieContainer used for requests made by this client instance
  1605. </summary>
  1606. </member>
  1607. <member name="P:RestSharp.RestClient.UserAgent">
  1608. <summary>
  1609. UserAgent to use for requests made by this client instance
  1610. </summary>
  1611. </member>
  1612. <member name="P:RestSharp.RestClient.Timeout">
  1613. <summary>
  1614. Timeout in milliseconds to use for requests made by this client instance
  1615. </summary>
  1616. </member>
  1617. <member name="P:RestSharp.RestClient.ReadWriteTimeout">
  1618. <summary>
  1619. The number of milliseconds before the writing or reading times out.
  1620. </summary>
  1621. </member>
  1622. <member name="P:RestSharp.RestClient.UseSynchronizationContext">
  1623. <summary>
  1624. Whether to invoke async callbacks using the SynchronizationContext.Current captured when invoked
  1625. </summary>
  1626. </member>
  1627. <member name="P:RestSharp.RestClient.Authenticator">
  1628. <summary>
  1629. Authenticator to use for requests made by this client instance
  1630. </summary>
  1631. </member>
  1632. <member name="P:RestSharp.RestClient.BaseUrl">
  1633. <summary>
  1634. Combined with Request.Resource to construct URL for request
  1635. Should include scheme and domain without trailing slash.
  1636. </summary>
  1637. <example>
  1638. client.BaseUrl = new Uri("http://example.com");
  1639. </example>
  1640. </member>
  1641. <member name="M:RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse})">
  1642. <summary>
  1643. Executes the request and callback asynchronously, authenticating if needed
  1644. </summary>
  1645. <param name="client">The IRestClient this method extends</param>
  1646. <param name="request">Request to be executed</param>
  1647. <param name="callback">Callback function to be executed upon completion</param>
  1648. </member>
  1649. <member name="M:RestSharp.RestClientExtensions.ExecuteAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0}})">
  1650. <summary>
  1651. Executes the request and callback asynchronously, authenticating if needed
  1652. </summary>
  1653. <param name="client">The IRestClient this method extends</param>
  1654. <typeparam name="T">Target deserialization type</typeparam>
  1655. <param name="request">Request to be executed</param>
  1656. <param name="callback">Callback function to be executed upon completion providing access to the async handle</param>
  1657. </member>
  1658. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,RestSharp.Parameter)">
  1659. <summary>
  1660. Add a parameter to use on every request made with this client instance
  1661. </summary>
  1662. <param name="restClient">The IRestClient instance</param>
  1663. <param name="p">Parameter to add</param>
  1664. <returns></returns>
  1665. </member>
  1666. <member name="M:RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient,System.String)">
  1667. <summary>
  1668. Removes a parameter from the default parameters that are used on every request made with this client instance
  1669. </summary>
  1670. <param name="restClient">The IRestClient instance</param>
  1671. <param name="name">The name of the parameter that needs to be removed</param>
  1672. <returns></returns>
  1673. </member>
  1674. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object)">
  1675. <summary>
  1676. Adds a HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  1677. Used on every request made by this client instance
  1678. </summary>
  1679. <param name="restClient">The IRestClient instance</param>
  1680. <param name="name">Name of the parameter</param>
  1681. <param name="value">Value of the parameter</param>
  1682. <returns>This request</returns>
  1683. </member>
  1684. <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object,RestSharp.ParameterType)">
  1685. <summary>
  1686. Adds a parameter to the request. There are four types of parameters:
  1687. - GetOrPost: Either a QueryString value or encoded form value based on method
  1688. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  1689. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  1690. - RequestBody: Used by AddBody() (not recommended to use directly)
  1691. </summary>
  1692. <param name="restClient">The IRestClient instance</param>
  1693. <param name="name">Name of the parameter</param>
  1694. <param name="value">Value of the parameter</param>
  1695. <param name="type">The type of parameter to add</param>
  1696. <returns>This request</returns>
  1697. </member>
  1698. <member name="M:RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient,System.String,System.String)">
  1699. <summary>
  1700. Shortcut to AddDefaultParameter(name, value, HttpHeader) overload
  1701. </summary>
  1702. <param name="restClient">The IRestClient instance</param>
  1703. <param name="name">Name of the header to add</param>
  1704. <param name="value">Value of the header to add</param>
  1705. <returns></returns>
  1706. </member>
  1707. <member name="M:RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient,System.String,System.String)">
  1708. <summary>
  1709. Shortcut to AddDefaultParameter(name, value, UrlSegment) overload
  1710. </summary>
  1711. <param name="restClient">The IRestClient instance</param>
  1712. <param name="name">Name of the segment to add</param>
  1713. <param name="value">Value of the segment to add</param>
  1714. <returns></returns>
  1715. </member>
  1716. <member name="T:RestSharp.RestRequest">
  1717. <summary>
  1718. Container for data used to make requests
  1719. </summary>
  1720. </member>
  1721. <member name="M:RestSharp.RestRequest.#ctor">
  1722. <summary>
  1723. Default constructor
  1724. </summary>
  1725. </member>
  1726. <member name="M:RestSharp.RestRequest.#ctor(RestSharp.Method)">
  1727. <summary>
  1728. Sets Method property to value of method
  1729. </summary>
  1730. <param name="method">Method to use for this request</param>
  1731. </member>
  1732. <member name="M:RestSharp.RestRequest.#ctor(System.String)">
  1733. <summary>
  1734. Sets Resource property
  1735. </summary>
  1736. <param name="resource">Resource to use for this request</param>
  1737. </member>
  1738. <member name="M:RestSharp.RestRequest.#ctor(System.String,RestSharp.Method)">
  1739. <summary>
  1740. Sets Resource and Method properties
  1741. </summary>
  1742. <param name="resource">Resource to use for this request</param>
  1743. <param name="method">Method to use for this request</param>
  1744. </member>
  1745. <member name="M:RestSharp.RestRequest.#ctor(System.Uri)">
  1746. <summary>
  1747. Sets Resource property
  1748. </summary>
  1749. <param name="resource">Resource to use for this request</param>
  1750. </member>
  1751. <member name="M:RestSharp.RestRequest.#ctor(System.Uri,RestSharp.Method)">
  1752. <summary>
  1753. Sets Resource and Method properties
  1754. </summary>
  1755. <param name="resource">Resource to use for this request</param>
  1756. <param name="method">Method to use for this request</param>
  1757. </member>
  1758. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.String)">
  1759. <summary>
  1760. Adds a file to the Files collection to be included with a POST or PUT request
  1761. (other methods do not support file uploads).
  1762. </summary>
  1763. <param name="name">The parameter name to use in the request</param>
  1764. <param name="path">Full path to file to upload</param>
  1765. <returns>This request</returns>
  1766. </member>
  1767. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String)">
  1768. <summary>
  1769. Adds the bytes to the Files collection with the specified file name
  1770. </summary>
  1771. <param name="name">The parameter name to use in the request</param>
  1772. <param name="bytes">The file data</param>
  1773. <param name="fileName">The file name to use for the uploaded file</param>
  1774. <returns>This request</returns>
  1775. </member>
  1776. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String,System.String)">
  1777. <summary>
  1778. Adds the bytes to the Files collection with the specified file name and content type
  1779. </summary>
  1780. <param name="name">The parameter name to use in the request</param>
  1781. <param name="bytes">The file data</param>
  1782. <param name="fileName">The file name to use for the uploaded file</param>
  1783. <param name="contentType">The MIME type of the file to upload</param>
  1784. <returns>This request</returns>
  1785. </member>
  1786. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String)">
  1787. <summary>
  1788. Adds the bytes to the Files collection with the specified file name and content type
  1789. </summary>
  1790. <param name="name">The parameter name to use in the request</param>
  1791. <param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param>
  1792. <param name="fileName">The file name to use for the uploaded file</param>
  1793. <returns>This request</returns>
  1794. </member>
  1795. <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String,System.String)">
  1796. <summary>
  1797. Adds the bytes to the Files collection with the specified file name and content type
  1798. </summary>
  1799. <param name="name">The parameter name to use in the request</param>
  1800. <param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param>
  1801. <param name="fileName">The file name to use for the uploaded file</param>
  1802. <param name="contentType">The MIME type of the file to upload</param>
  1803. <returns>This request</returns>
  1804. </member>
  1805. <member name="M:RestSharp.RestRequest.AddBody(System.Object,System.String)">
  1806. <summary>
  1807. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  1808. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  1809. </summary>
  1810. <param name="obj">The object to serialize</param>
  1811. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  1812. <returns>This request</returns>
  1813. </member>
  1814. <member name="M:RestSharp.RestRequest.AddBody(System.Object)">
  1815. <summary>
  1816. Serializes obj to data format specified by RequestFormat and adds it to the request body.
  1817. The default format is XML. Change RequestFormat if you wish to use a different serialization format.
  1818. </summary>
  1819. <param name="obj">The object to serialize</param>
  1820. <returns>This request</returns>
  1821. </member>
  1822. <member name="M:RestSharp.RestRequest.AddJsonBody(System.Object)">
  1823. <summary>
  1824. Serializes obj to JSON format and adds it to the request body.
  1825. </summary>
  1826. <param name="obj">The object to serialize</param>
  1827. <returns>This request</returns>
  1828. </member>
  1829. <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object)">
  1830. <summary>
  1831. Serializes obj to XML format and adds it to the request body.
  1832. </summary>
  1833. <param name="obj">The object to serialize</param>
  1834. <returns>This request</returns>
  1835. </member>
  1836. <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object,System.String)">
  1837. <summary>
  1838. Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer
  1839. Serializes obj to XML format and passes xmlNamespace then adds it to the request body.
  1840. </summary>
  1841. <param name="obj">The object to serialize</param>
  1842. <param name="xmlNamespace">The XML namespace to use when serializing</param>
  1843. <returns>This request</returns>
  1844. </member>
  1845. <member name="M:RestSharp.RestRequest.AddObject(System.Object,System.String[])">
  1846. <summary>
  1847. Calls AddParameter() for all public, readable properties specified in the includedProperties list
  1848. </summary>
  1849. <example>
  1850. request.AddObject(product, "ProductId", "Price", ...);
  1851. </example>
  1852. <param name="obj">The object with properties to add as parameters</param>
  1853. <param name="includedProperties">The names of the properties to include</param>
  1854. <returns>This request</returns>
  1855. </member>
  1856. <member name="M:RestSharp.RestRequest.AddObject(System.Object)">
  1857. <summary>
  1858. Calls AddParameter() for all public, readable properties of obj
  1859. </summary>
  1860. <param name="obj">The object with properties to add as parameters</param>
  1861. <returns>This request</returns>
  1862. </member>
  1863. <member name="M:RestSharp.RestRequest.AddParameter(RestSharp.Parameter)">
  1864. <summary>
  1865. Add the parameter to the request
  1866. </summary>
  1867. <param name="p">Parameter to add</param>
  1868. <returns></returns>
  1869. </member>
  1870. <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object)">
  1871. <summary>
  1872. Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT)
  1873. </summary>
  1874. <param name="name">Name of the parameter</param>
  1875. <param name="value">Value of the parameter</param>
  1876. <returns>This request</returns>
  1877. </member>
  1878. <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)">
  1879. <summary>
  1880. Adds a parameter to the request. There are four types of parameters:
  1881. - GetOrPost: Either a QueryString value or encoded form value based on method
  1882. - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection
  1883. - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId}
  1884. - RequestBody: Used by AddBody() (not recommended to use directly)
  1885. </summary>
  1886. <param name="name">Name of the parameter</param>
  1887. <param name="value">Value of the parameter</param>
  1888. <param name="type">The type of parameter to add</param>
  1889. <returns>This request</returns>
  1890. </member>
  1891. <member name="M:RestSharp.RestRequest.AddHeader(System.String,System.String)">
  1892. <summary>
  1893. Shortcut to AddParameter(name, value, HttpHeader) overload
  1894. </summary>
  1895. <param name="name">Name of the header to add</param>
  1896. <param name="value">Value of the header to add</param>
  1897. <returns></returns>
  1898. </member>
  1899. <member name="M:RestSharp.RestRequest.AddCookie(System.String,System.String)">
  1900. <summary>
  1901. Shortcut to AddParameter(name, value, Cookie) overload
  1902. </summary>
  1903. <param name="name">Name of the cookie to add</param>
  1904. <param name="value">Value of the cookie to add</param>
  1905. <returns></returns>
  1906. </member>
  1907. <member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.String)">
  1908. <summary>
  1909. Shortcut to AddParameter(name, value, UrlSegment) overload
  1910. </summary>
  1911. <param name="name">Name of the segment to add</param>
  1912. <param name="value">Value of the segment to add</param>
  1913. <returns></returns>
  1914. </member>
  1915. <member name="M:RestSharp.RestRequest.AddQueryParameter(System.String,System.String)">
  1916. <summary>
  1917. Shortcut to AddParameter(name, value, QueryString) overload
  1918. </summary>
  1919. <param name="name">Name of the parameter to add</param>
  1920. <param name="value">Value of the parameter to add</param>
  1921. <returns></returns>
  1922. </member>
  1923. <member name="M:RestSharp.RestRequest.IncreaseNumAttempts">
  1924. <summary>
  1925. Internal Method so that RestClient can increase the number of attempts
  1926. </summary>
  1927. </member>
  1928. <member name="P:RestSharp.RestRequest.AlwaysMultipartFormData">
  1929. <summary>
  1930. Always send a multipart/form-data request - even when no Files are present.
  1931. </summary>
  1932. </member>
  1933. <member name="P:RestSharp.RestRequest.JsonSerializer">
  1934. <summary>
  1935. Serializer to use when writing JSON request bodies. Used if RequestFormat is Json.
  1936. By default the included JsonSerializer is used (currently using JSON.NET default serialization).
  1937. </summary>
  1938. </member>
  1939. <member name="P:RestSharp.RestRequest.XmlSerializer">
  1940. <summary>
  1941. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  1942. By default the included XmlSerializer is used.
  1943. </summary>
  1944. </member>
  1945. <member name="P:RestSharp.RestRequest.ResponseWriter">
  1946. <summary>
  1947. Set this to write response to Stream rather than reading into memory.
  1948. </summary>
  1949. </member>
  1950. <member name="P:RestSharp.RestRequest.UseDefaultCredentials">
  1951. <summary>
  1952. Determine whether or not the "default credentials" (e.g. the user account under which the current process is running)
  1953. will be sent along to the server. The default is false.
  1954. </summary>
  1955. </member>
  1956. <member name="P:RestSharp.RestRequest.Parameters">
  1957. <summary>
  1958. Container of all HTTP parameters to be passed with the request.
  1959. See AddParameter() for explanation of the types of parameters that can be passed
  1960. </summary>
  1961. </member>
  1962. <member name="P:RestSharp.RestRequest.Files">
  1963. <summary>
  1964. Container of all the files to be uploaded with the request.
  1965. </summary>
  1966. </member>
  1967. <member name="P:RestSharp.RestRequest.Method">
  1968. <summary>
  1969. Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS
  1970. Default is GET
  1971. </summary>
  1972. </member>
  1973. <member name="P:RestSharp.RestRequest.Resource">
  1974. <summary>
  1975. The Resource URL to make the request against.
  1976. Tokens are substituted with UrlSegment parameters and match by name.
  1977. Should not include the scheme or domain. Do not include leading slash.
  1978. Combined with RestClient.BaseUrl to assemble final URL:
  1979. {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com)
  1980. </summary>
  1981. <example>
  1982. // example for url token replacement
  1983. request.Resource = "Products/{ProductId}";
  1984. request.AddParameter("ProductId", 123, ParameterType.UrlSegment);
  1985. </example>
  1986. </member>
  1987. <member name="P:RestSharp.RestRequest.RequestFormat">
  1988. <summary>
  1989. Serializer to use when writing XML request bodies. Used if RequestFormat is Xml.
  1990. By default XmlSerializer is used.
  1991. </summary>
  1992. </member>
  1993. <member name="P:RestSharp.RestRequest.RootElement">
  1994. <summary>
  1995. Used by the default deserializers to determine where to start deserializing from.
  1996. Can be used to skip container or root elements that do not have corresponding deserialzation targets.
  1997. </summary>
  1998. </member>
  1999. <member name="P:RestSharp.RestRequest.OnBeforeDeserialization">
  2000. <summary>
  2001. A function to run prior to deserializing starting (e.g. change settings if error encountered)
  2002. </summary>
  2003. </member>
  2004. <member name="P:RestSharp.RestRequest.DateFormat">
  2005. <summary>
  2006. Used by the default deserializers to explicitly set which date format string to use when parsing dates.
  2007. </summary>
  2008. </member>
  2009. <member name="P:RestSharp.RestRequest.XmlNamespace">
  2010. <summary>
  2011. Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names.
  2012. </summary>
  2013. </member>
  2014. <member name="P:RestSharp.RestRequest.Credentials">
  2015. <summary>
  2016. In general you would not need to set this directly. Used by the NtlmAuthenticator.
  2017. </summary>
  2018. </member>
  2019. <member name="P:RestSharp.RestRequest.UserState">
  2020. <summary>
  2021. Gets or sets a user-defined state object that contains information about a request and which can be later
  2022. retrieved when the request completes.
  2023. </summary>
  2024. </member>
  2025. <member name="P:RestSharp.RestRequest.Timeout">
  2026. <summary>
  2027. Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient.
  2028. </summary>
  2029. </member>
  2030. <member name="P:RestSharp.RestRequest.ReadWriteTimeout">
  2031. <summary>
  2032. The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient.
  2033. </summary>
  2034. </member>
  2035. <member name="P:RestSharp.RestRequest.Attempts">
  2036. <summary>
  2037. How many attempts were made to send this Request?
  2038. </summary>
  2039. <remarks>
  2040. This Number is incremented each time the RestClient sends the request.
  2041. Useful when using Asynchronous Execution with Callbacks
  2042. </remarks>
  2043. </member>
  2044. <member name="T:RestSharp.RestResponseBase">
  2045. <summary>
  2046. Base class for common properties shared by RestResponse and RestResponse[[T]]
  2047. </summary>
  2048. </member>
  2049. <member name="M:RestSharp.RestResponseBase.#ctor">
  2050. <summary>
  2051. Default constructor
  2052. </summary>
  2053. </member>
  2054. <member name="P:RestSharp.RestResponseBase.Request">
  2055. <summary>
  2056. The RestRequest that was made to get this RestResponse
  2057. </summary>
  2058. <remarks>
  2059. Mainly for debugging if ResponseStatus is not OK
  2060. </remarks>
  2061. </member>
  2062. <member name="P:RestSharp.RestResponseBase.ContentType">
  2063. <summary>
  2064. MIME content type of response
  2065. </summary>
  2066. </member>
  2067. <member name="P:RestSharp.RestResponseBase.ContentLength">
  2068. <summary>
  2069. Length in bytes of the response content
  2070. </summary>
  2071. </member>
  2072. <member name="P:RestSharp.RestResponseBase.ContentEncoding">
  2073. <summary>
  2074. Encoding of the response content
  2075. </summary>
  2076. </member>
  2077. <member name="P:RestSharp.RestResponseBase.Content">
  2078. <summary>
  2079. String representation of response content
  2080. </summary>
  2081. </member>
  2082. <member name="P:RestSharp.RestResponseBase.StatusCode">
  2083. <summary>
  2084. HTTP response status code
  2085. </summary>
  2086. </member>
  2087. <member name="P:RestSharp.RestResponseBase.StatusDescription">
  2088. <summary>
  2089. Description of HTTP status returned
  2090. </summary>
  2091. </member>
  2092. <member name="P:RestSharp.RestResponseBase.RawBytes">
  2093. <summary>
  2094. Response content
  2095. </summary>
  2096. </member>
  2097. <member name="P:RestSharp.RestResponseBase.ResponseUri">
  2098. <summary>
  2099. The URL that actually responded to the content (different from request if redirected)
  2100. </summary>
  2101. </member>
  2102. <member name="P:RestSharp.RestResponseBase.Server">
  2103. <summary>
  2104. HttpWebResponse.Server
  2105. </summary>
  2106. </member>
  2107. <member name="P:RestSharp.RestResponseBase.Cookies">
  2108. <summary>
  2109. Cookies returned by server with the response
  2110. </summary>
  2111. </member>
  2112. <member name="P:RestSharp.RestResponseBase.Headers">
  2113. <summary>
  2114. Headers returned by server with the response
  2115. </summary>
  2116. </member>
  2117. <member name="P:RestSharp.RestResponseBase.ResponseStatus">
  2118. <summary>
  2119. Status of the request. Will return Error for transport errors.
  2120. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead
  2121. </summary>
  2122. </member>
  2123. <member name="P:RestSharp.RestResponseBase.ErrorMessage">
  2124. <summary>
  2125. Transport or other non-HTTP error generated while attempting request
  2126. </summary>
  2127. </member>
  2128. <member name="P:RestSharp.RestResponseBase.ErrorException">
  2129. <summary>
  2130. The exception thrown during the request, if any
  2131. </summary>
  2132. </member>
  2133. <member name="T:RestSharp.RestResponse`1">
  2134. <summary>
  2135. Container for data sent back from API including deserialized data
  2136. </summary>
  2137. <typeparam name="T">Type of data to deserialize to</typeparam>
  2138. </member>
  2139. <member name="P:RestSharp.RestResponse`1.Data">
  2140. <summary>
  2141. Deserialized entity data
  2142. </summary>
  2143. </member>
  2144. <member name="T:RestSharp.RestResponse">
  2145. <summary>
  2146. Container for data sent back from API
  2147. </summary>
  2148. </member>
  2149. <member name="T:RestSharp.Serializers.DotNetXmlSerializer">
  2150. <summary>
  2151. Wrapper for System.Xml.Serialization.XmlSerializer.
  2152. </summary>
  2153. </member>
  2154. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor">
  2155. <summary>
  2156. Default constructor, does not specify namespace
  2157. </summary>
  2158. </member>
  2159. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor(System.String)">
  2160. <summary>
  2161. Specify the namespaced to be used when serializing
  2162. </summary>
  2163. <param name="namespace">XML namespace</param>
  2164. </member>
  2165. <member name="M:RestSharp.Serializers.DotNetXmlSerializer.Serialize(System.Object)">
  2166. <summary>
  2167. Serialize the object as XML
  2168. </summary>
  2169. <param name="obj">Object to serialize</param>
  2170. <returns>XML as string</returns>
  2171. </member>
  2172. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.RootElement">
  2173. <summary>
  2174. Name of the root element to use when serializing
  2175. </summary>
  2176. </member>
  2177. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Namespace">
  2178. <summary>
  2179. XML namespace to use when serializing
  2180. </summary>
  2181. </member>
  2182. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.DateFormat">
  2183. <summary>
  2184. Format string to use when serializing dates
  2185. </summary>
  2186. </member>
  2187. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.ContentType">
  2188. <summary>
  2189. Content type for serialized content
  2190. </summary>
  2191. </member>
  2192. <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Encoding">
  2193. <summary>
  2194. Encoding for serialized content
  2195. </summary>
  2196. </member>
  2197. <member name="T:RestSharp.Serializers.DotNetXmlSerializer.EncodingStringWriter">
  2198. <summary>
  2199. Need to subclass StringWriter in order to override Encoding
  2200. </summary>
  2201. </member>
  2202. <member name="T:RestSharp.Serializers.JsonSerializer">
  2203. <summary>
  2204. Default JSON serializer for request bodies
  2205. Doesn't currently use the SerializeAs attribute, defers to Newtonsoft's attributes
  2206. </summary>
  2207. </member>
  2208. <member name="M:RestSharp.Serializers.JsonSerializer.#ctor">
  2209. <summary>
  2210. Default serializer
  2211. </summary>
  2212. </member>
  2213. <member name="M:RestSharp.Serializers.JsonSerializer.Serialize(System.Object)">
  2214. <summary>
  2215. Serialize the object as JSON
  2216. </summary>
  2217. <param name="obj">Object to serialize</param>
  2218. <returns>JSON as String</returns>
  2219. </member>
  2220. <member name="P:RestSharp.Serializers.JsonSerializer.DateFormat">
  2221. <summary>
  2222. Unused for JSON Serialization
  2223. </summary>
  2224. </member>
  2225. <member name="P:RestSharp.Serializers.JsonSerializer.RootElement">
  2226. <summary>
  2227. Unused for JSON Serialization
  2228. </summary>
  2229. </member>
  2230. <member name="P:RestSharp.Serializers.JsonSerializer.Namespace">
  2231. <summary>
  2232. Unused for JSON Serialization
  2233. </summary>
  2234. </member>
  2235. <member name="P:RestSharp.Serializers.JsonSerializer.ContentType">
  2236. <summary>
  2237. Content type for serialized content
  2238. </summary>
  2239. </member>
  2240. <member name="T:RestSharp.Serializers.SerializeAsAttribute">
  2241. <summary>
  2242. Allows control how class and property names and values are serialized by XmlSerializer
  2243. Currently not supported with the JsonSerializer
  2244. When specified at the property level the class-level specification is overridden
  2245. </summary>
  2246. </member>
  2247. <member name="M:RestSharp.Serializers.SerializeAsAttribute.TransformName(System.String)">
  2248. <summary>
  2249. Called by the attribute when NameStyle is speficied
  2250. </summary>
  2251. <param name="input">The string to transform</param>
  2252. <returns>String</returns>
  2253. </member>
  2254. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Name">
  2255. <summary>
  2256. The name to use for the serialized element
  2257. </summary>
  2258. </member>
  2259. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Attribute">
  2260. <summary>
  2261. Sets the value to be serialized as an Attribute instead of an Element
  2262. </summary>
  2263. </member>
  2264. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Culture">
  2265. <summary>
  2266. The culture to use when serializing
  2267. </summary>
  2268. </member>
  2269. <member name="P:RestSharp.Serializers.SerializeAsAttribute.NameStyle">
  2270. <summary>
  2271. Transforms the casing of the name based on the selected value.
  2272. </summary>
  2273. </member>
  2274. <member name="P:RestSharp.Serializers.SerializeAsAttribute.Index">
  2275. <summary>
  2276. The order to serialize the element. Default is int.MaxValue.
  2277. </summary>
  2278. </member>
  2279. <member name="T:RestSharp.Serializers.NameStyle">
  2280. <summary>
  2281. Options for transforming casing of element names
  2282. </summary>
  2283. </member>
  2284. <member name="T:RestSharp.Serializers.XmlSerializer">
  2285. <summary>
  2286. Default XML Serializer
  2287. </summary>
  2288. </member>
  2289. <member name="M:RestSharp.Serializers.XmlSerializer.#ctor">
  2290. <summary>
  2291. Default constructor, does not specify namespace
  2292. </summary>
  2293. </member>
  2294. <member name="M:RestSharp.Serializers.XmlSerializer.#ctor(System.String)">
  2295. <summary>
  2296. Specify the namespaced to be used when serializing
  2297. </summary>
  2298. <param name="namespace">XML namespace</param>
  2299. </member>
  2300. <member name="M:RestSharp.Serializers.XmlSerializer.Serialize(System.Object)">
  2301. <summary>
  2302. Serialize the object as XML
  2303. </summary>
  2304. <param name="obj">Object to serialize</param>
  2305. <returns>XML as string</returns>
  2306. </member>
  2307. <member name="M:RestSharp.Serializers.XmlSerializer.IsNumeric(System.Object)">
  2308. <summary>
  2309. Determines if a given object is numeric in any way
  2310. (can be integer, double, null, etc).
  2311. </summary>
  2312. </member>
  2313. <member name="P:RestSharp.Serializers.XmlSerializer.RootElement">
  2314. <summary>
  2315. Name of the root element to use when serializing
  2316. </summary>
  2317. </member>
  2318. <member name="P:RestSharp.Serializers.XmlSerializer.Namespace">
  2319. <summary>
  2320. XML namespace to use when serializing
  2321. </summary>
  2322. </member>
  2323. <member name="P:RestSharp.Serializers.XmlSerializer.DateFormat">
  2324. <summary>
  2325. Format string to use when serializing dates
  2326. </summary>
  2327. </member>
  2328. <member name="P:RestSharp.Serializers.XmlSerializer.ContentType">
  2329. <summary>
  2330. Content type for serialized content
  2331. </summary>
  2332. </member>
  2333. <member name="T:RestSharp.JsonArray">
  2334. <summary>
  2335. Represents the json array.
  2336. </summary>
  2337. </member>
  2338. <member name="M:RestSharp.JsonArray.#ctor">
  2339. <summary>
  2340. Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class.
  2341. </summary>
  2342. </member>
  2343. <member name="M:RestSharp.JsonArray.#ctor(System.Int32)">
  2344. <summary>
  2345. Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class.
  2346. </summary>
  2347. <param name="capacity">The capacity of the json array.</param>
  2348. </member>
  2349. <member name="M:RestSharp.JsonArray.ToString">
  2350. <summary>
  2351. The json representation of the array.
  2352. </summary>
  2353. <returns>The json representation of the array.</returns>
  2354. </member>
  2355. <member name="T:RestSharp.JsonObject">
  2356. <summary>
  2357. Represents the json object.
  2358. </summary>
  2359. </member>
  2360. <member name="F:RestSharp.JsonObject._members">
  2361. <summary>
  2362. The internal member dictionary.
  2363. </summary>
  2364. </member>
  2365. <member name="M:RestSharp.JsonObject.#ctor">
  2366. <summary>
  2367. Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>.
  2368. </summary>
  2369. </member>
  2370. <member name="M:RestSharp.JsonObject.#ctor(System.Collections.Generic.IEqualityComparer{System.String})">
  2371. <summary>
  2372. Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>.
  2373. </summary>
  2374. <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>
  2375. </member>
  2376. <member name="M:RestSharp.JsonObject.Add(System.String,System.Object)">
  2377. <summary>
  2378. Adds the specified key.
  2379. </summary>
  2380. <param name="key">The key.</param>
  2381. <param name="value">The value.</param>
  2382. </member>
  2383. <member name="M:RestSharp.JsonObject.ContainsKey(System.String)">
  2384. <summary>
  2385. Determines whether the specified key contains key.
  2386. </summary>
  2387. <param name="key">The key.</param>
  2388. <returns>
  2389. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  2390. </returns>
  2391. </member>
  2392. <member name="M:RestSharp.JsonObject.Remove(System.String)">
  2393. <summary>
  2394. Removes the specified key.
  2395. </summary>
  2396. <param name="key">The key.</param>
  2397. <returns></returns>
  2398. </member>
  2399. <member name="M:RestSharp.JsonObject.TryGetValue(System.String,System.Object@)">
  2400. <summary>
  2401. Tries the get value.
  2402. </summary>
  2403. <param name="key">The key.</param>
  2404. <param name="value">The value.</param>
  2405. <returns></returns>
  2406. </member>
  2407. <member name="M:RestSharp.JsonObject.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  2408. <summary>
  2409. Adds the specified item.
  2410. </summary>
  2411. <param name="item">The item.</param>
  2412. </member>
  2413. <member name="M:RestSharp.JsonObject.Clear">
  2414. <summary>
  2415. Clears this instance.
  2416. </summary>
  2417. </member>
  2418. <member name="M:RestSharp.JsonObject.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  2419. <summary>
  2420. Determines whether [contains] [the specified item].
  2421. </summary>
  2422. <param name="item">The item.</param>
  2423. <returns>
  2424. <c>true</c> if [contains] [the specified item]; otherwise, <c>false</c>.
  2425. </returns>
  2426. </member>
  2427. <member name="M:RestSharp.JsonObject.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)">
  2428. <summary>
  2429. Copies to.
  2430. </summary>
  2431. <param name="array">The array.</param>
  2432. <param name="arrayIndex">Index of the array.</param>
  2433. </member>
  2434. <member name="M:RestSharp.JsonObject.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})">
  2435. <summary>
  2436. Removes the specified item.
  2437. </summary>
  2438. <param name="item">The item.</param>
  2439. <returns></returns>
  2440. </member>
  2441. <member name="M:RestSharp.JsonObject.GetEnumerator">
  2442. <summary>
  2443. Gets the enumerator.
  2444. </summary>
  2445. <returns></returns>
  2446. </member>
  2447. <member name="M:RestSharp.JsonObject.System#Collections#IEnumerable#GetEnumerator">
  2448. <summary>
  2449. Returns an enumerator that iterates through a collection.
  2450. </summary>
  2451. <returns>
  2452. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  2453. </returns>
  2454. </member>
  2455. <member name="M:RestSharp.JsonObject.ToString">
  2456. <summary>
  2457. Returns a json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2458. </summary>
  2459. <returns>
  2460. A json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2461. </returns>
  2462. </member>
  2463. <member name="P:RestSharp.JsonObject.Item(System.Int32)">
  2464. <summary>
  2465. Gets the <see cref="T:System.Object"/> at the specified index.
  2466. </summary>
  2467. <value></value>
  2468. </member>
  2469. <member name="P:RestSharp.JsonObject.Keys">
  2470. <summary>
  2471. Gets the keys.
  2472. </summary>
  2473. <value>The keys.</value>
  2474. </member>
  2475. <member name="P:RestSharp.JsonObject.Values">
  2476. <summary>
  2477. Gets the values.
  2478. </summary>
  2479. <value>The values.</value>
  2480. </member>
  2481. <member name="P:RestSharp.JsonObject.Item(System.String)">
  2482. <summary>
  2483. Gets or sets the <see cref="T:System.Object"/> with the specified key.
  2484. </summary>
  2485. <value></value>
  2486. </member>
  2487. <member name="P:RestSharp.JsonObject.Count">
  2488. <summary>
  2489. Gets the count.
  2490. </summary>
  2491. <value>The count.</value>
  2492. </member>
  2493. <member name="P:RestSharp.JsonObject.IsReadOnly">
  2494. <summary>
  2495. Gets a value indicating whether this instance is read only.
  2496. </summary>
  2497. <value>
  2498. <c>true</c> if this instance is read only; otherwise, <c>false</c>.
  2499. </value>
  2500. </member>
  2501. <member name="T:RestSharp.SimpleJson">
  2502. <summary>
  2503. This class encodes and decodes JSON strings.
  2504. Spec. details, see http://www.json.org/
  2505. JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList&lt;object>) and JsonObject(IDictionary&lt;string,object>).
  2506. All numbers are parsed to doubles.
  2507. </summary>
  2508. </member>
  2509. <member name="M:RestSharp.SimpleJson.DeserializeObject(System.String)">
  2510. <summary>
  2511. Parses the string json into a value
  2512. </summary>
  2513. <param name="json">A JSON string.</param>
  2514. <returns>An IList&lt;object>, a IDictionary&lt;string,object>, a double, a string, null, true, or false</returns>
  2515. </member>
  2516. <member name="M:RestSharp.SimpleJson.TryDeserializeObject(System.String,System.Object@)">
  2517. <summary>
  2518. Try parsing the json string into a value.
  2519. </summary>
  2520. <param name="json">
  2521. A JSON string.
  2522. </param>
  2523. <param name="obj">
  2524. The object.
  2525. </param>
  2526. <returns>
  2527. Returns true if successfull otherwise false.
  2528. </returns>
  2529. </member>
  2530. <member name="M:RestSharp.SimpleJson.SerializeObject(System.Object,RestSharp.IJsonSerializerStrategy)">
  2531. <summary>
  2532. Converts a IDictionary&lt;string,object> / IList&lt;object> object into a JSON string
  2533. </summary>
  2534. <param name="json">A IDictionary&lt;string,object> / IList&lt;object></param>
  2535. <param name="jsonSerializerStrategy">Serializer strategy to use</param>
  2536. <returns>A JSON encoded string, or null if object 'json' is not serializable</returns>
  2537. </member>
  2538. <member name="M:RestSharp.SimpleJson.IsNumeric(System.Object)">
  2539. <summary>
  2540. Determines if a given object is numeric in any way
  2541. (can be integer, double, null, etc).
  2542. </summary>
  2543. </member>
  2544. <member name="T:RestSharp.Validation.Require">
  2545. <summary>
  2546. Helper methods for validating required values
  2547. </summary>
  2548. </member>
  2549. <member name="M:RestSharp.Validation.Require.Argument(System.String,System.Object)">
  2550. <summary>
  2551. Require a parameter to not be null
  2552. </summary>
  2553. <param name="argumentName">Name of the parameter</param>
  2554. <param name="argumentValue">Value of the parameter</param>
  2555. </member>
  2556. <member name="T:RestSharp.Validation.Validate">
  2557. <summary>
  2558. Helper methods for validating values
  2559. </summary>
  2560. </member>
  2561. <member name="M:RestSharp.Validation.Validate.IsBetween(System.Int32,System.Int32,System.Int32)">
  2562. <summary>
  2563. Validate an integer value is between the specified values (exclusive of min/max)
  2564. </summary>
  2565. <param name="value">Value to validate</param>
  2566. <param name="min">Exclusive minimum value</param>
  2567. <param name="max">Exclusive maximum value</param>
  2568. </member>
  2569. <member name="M:RestSharp.Validation.Validate.IsValidLength(System.String,System.Int32)">
  2570. <summary>
  2571. Validate a string length
  2572. </summary>
  2573. <param name="value">String to be validated</param>
  2574. <param name="maxSize">Maximum length of the string</param>
  2575. </member>
  2576. <member name="P:RestSharp.RestResponseCookie.Comment">
  2577. <summary>
  2578. Comment of the cookie
  2579. </summary>
  2580. </member>
  2581. <member name="P:RestSharp.RestResponseCookie.CommentUri">
  2582. <summary>
  2583. Comment of the cookie
  2584. </summary>
  2585. </member>
  2586. <member name="P:RestSharp.RestResponseCookie.Discard">
  2587. <summary>
  2588. Indicates whether the cookie should be discarded at the end of the session
  2589. </summary>
  2590. </member>
  2591. <member name="P:RestSharp.RestResponseCookie.Domain">
  2592. <summary>
  2593. Domain of the cookie
  2594. </summary>
  2595. </member>
  2596. <member name="P:RestSharp.RestResponseCookie.Expired">
  2597. <summary>
  2598. Indicates whether the cookie is expired
  2599. </summary>
  2600. </member>
  2601. <member name="P:RestSharp.RestResponseCookie.Expires">
  2602. <summary>
  2603. Date and time that the cookie expires
  2604. </summary>
  2605. </member>
  2606. <member name="P:RestSharp.RestResponseCookie.HttpOnly">
  2607. <summary>
  2608. Indicates that this cookie should only be accessed by the server
  2609. </summary>
  2610. </member>
  2611. <member name="P:RestSharp.RestResponseCookie.Name">
  2612. <summary>
  2613. Name of the cookie
  2614. </summary>
  2615. </member>
  2616. <member name="P:RestSharp.RestResponseCookie.Path">
  2617. <summary>
  2618. Path of the cookie
  2619. </summary>
  2620. </member>
  2621. <member name="P:RestSharp.RestResponseCookie.Port">
  2622. <summary>
  2623. Port of the cookie
  2624. </summary>
  2625. </member>
  2626. <member name="P:RestSharp.RestResponseCookie.Secure">
  2627. <summary>
  2628. Indicates that the cookie should only be sent over secure channels
  2629. </summary>
  2630. </member>
  2631. <member name="P:RestSharp.RestResponseCookie.TimeStamp">
  2632. <summary>
  2633. Date and time the cookie was created
  2634. </summary>
  2635. </member>
  2636. <member name="P:RestSharp.RestResponseCookie.Value">
  2637. <summary>
  2638. Value of the cookie
  2639. </summary>
  2640. </member>
  2641. <member name="P:RestSharp.RestResponseCookie.Version">
  2642. <summary>
  2643. Version of the cookie
  2644. </summary>
  2645. </member>
  2646. </members>
  2647. </doc>