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.

2856 lines
127 KiB

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