RestSharp.xml 122 KB

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