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