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