RestSharp.Silverlight.xml 114 KB

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