markus / packages / RestSharp.105.2.3 / lib / windowsphone8 / RestSharp.xml @ 8a14e525
이력 | 보기 | 이력해설 | 다운로드 (179 KB)
1 |
<?xml version="1.0"?>
|
---|---|
2 |
<doc>
|
3 |
<assembly>
|
4 |
<name>RestSharp</name> |
5 |
</assembly>
|
6 |
<members>
|
7 |
<member name="T:RestSharp.Authenticators.OAuth1Authenticator"> |
8 |
<seealso href="http://tools.ietf.org/html/rfc5849"/> |
9 |
</member>
|
10 |
<member name="T:RestSharp.Authenticators.OAuth2Authenticator"> |
11 |
<summary>
|
12 |
Base class for OAuth 2 Authenticators. |
13 |
</summary>
|
14 |
<remarks>
|
15 |
Since there are many ways to authenticate in OAuth2, |
16 |
this is used as a base class to differentiate between |
17 |
other authenticators. |
18 |
|
19 |
Any other OAuth2 authenticators must derive from this |
20 |
abstract class. |
21 |
</remarks>
|
22 |
</member>
|
23 |
<member name="F:RestSharp.Authenticators.OAuth2Authenticator.accessToken"> |
24 |
<summary>
|
25 |
Access token to be used when authenticating. |
26 |
</summary>
|
27 |
</member>
|
28 |
<member name="M:RestSharp.Authenticators.OAuth2Authenticator.#ctor(System.String)"> |
29 |
<summary>
|
30 |
Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2Authenticator"/> class. |
31 |
</summary>
|
32 |
<param name="accessToken"> |
33 |
The access token. |
34 |
</param>
|
35 |
</member>
|
36 |
<member name="P:RestSharp.Authenticators.OAuth2Authenticator.AccessToken"> |
37 |
<summary>
|
38 |
Gets the access token. |
39 |
</summary>
|
40 |
</member>
|
41 |
<member name="T:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator"> |
42 |
<summary>
|
43 |
The OAuth 2 authenticator using URI query parameter. |
44 |
</summary>
|
45 |
<remarks>
|
46 |
Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2 |
47 |
</remarks>
|
48 |
</member>
|
49 |
<member name="M:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator.#ctor(System.String)"> |
50 |
<summary>
|
51 |
Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator"/> class. |
52 |
</summary>
|
53 |
<param name="accessToken"> |
54 |
The access token. |
55 |
</param>
|
56 |
</member>
|
57 |
<member name="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator"> |
58 |
<summary>
|
59 |
The OAuth 2 authenticator using the authorization request header field. |
60 |
</summary>
|
61 |
<remarks>
|
62 |
Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1 |
63 |
</remarks>
|
64 |
</member>
|
65 |
<member name="F:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator.authorizationValue"> |
66 |
<summary>
|
67 |
Stores the Authorization header value as "[tokenType] accessToken". used for performance. |
68 |
</summary>
|
69 |
</member>
|
70 |
<member name="M:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String)"> |
71 |
<summary>
|
72 |
Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator"/> class. |
73 |
</summary>
|
74 |
<param name="accessToken"> |
75 |
The access token. |
76 |
</param>
|
77 |
</member>
|
78 |
<member name="M:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String,System.String)"> |
79 |
<summary>
|
80 |
Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator"/> class. |
81 |
</summary>
|
82 |
<param name="accessToken"> |
83 |
The access token. |
84 |
</param>
|
85 |
<param name="tokenType"> |
86 |
The token type. |
87 |
</param>
|
88 |
</member>
|
89 |
<member name="F:RestSharp.Authenticators.OAuth.OAuthTools.encoding"> |
90 |
<summary>
|
91 |
All text parameters are UTF-8 encoded (per section 5.1). |
92 |
</summary>
|
93 |
<seealso cref="!:http://www.hueniverse.com/hueniverse/2008/10/beginners-gui-1.html"/> |
94 |
</member>
|
95 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetNonce"> |
96 |
<summary>
|
97 |
Generates a random 16-byte lowercase alphanumeric string. |
98 |
</summary>
|
99 |
<seealso cref="!:http://oauth.net/core/1.0#nonce"/> |
100 |
<returns></returns> |
101 |
</member>
|
102 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp"> |
103 |
<summary>
|
104 |
Generates a timestamp based on the current elapsed seconds since '01/01/1970 0000 GMT" |
105 |
</summary>
|
106 |
<seealso cref="!:http://oauth.net/core/1.0#nonce"/> |
107 |
<returns></returns> |
108 |
</member>
|
109 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp(System.DateTime)"> |
110 |
<summary>
|
111 |
Generates a timestamp based on the elapsed seconds of a given time since '01/01/1970 0000 GMT" |
112 |
</summary>
|
113 |
<seealso cref="!:http://oauth.net/core/1.0#nonce"/> |
114 |
<param name="dateTime">A specified point in time.</param> |
115 |
<returns></returns> |
116 |
</member>
|
117 |
<member name="F:RestSharp.Authenticators.OAuth.OAuthTools.uriRfc3986CharsToEscape"> |
118 |
<summary>
|
119 |
The set of characters that are unreserved in RFC 2396 but are NOT unreserved in RFC 3986. |
120 |
</summary>
|
121 |
<seealso cref="!:http://stackoverflow.com/questions/846487/how-to-get-uri-escapedatastring-to-comply-with-rfc-3986"/> |
122 |
</member>
|
123 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeRelaxed(System.String)"> |
124 |
<summary>
|
125 |
URL encodes a string based on section 5.1 of the OAuth spec. |
126 |
Namely, percent encoding with [RFC3986], avoiding unreserved characters, |
127 |
upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. |
128 |
</summary>
|
129 |
<param name="value">The value to escape.</param> |
130 |
<returns>The escaped value.</returns> |
131 |
<remarks>
|
132 |
The <see cref="M:System.Uri.EscapeDataString(System.String)"/> method is <i>supposed</i> to take on |
133 |
RFC 3986 behavior if certain elements are present in a .config file. Even if this |
134 |
actually worked (which in my experiments it <i>doesn't</i>), we can't rely on every |
135 |
host actually having this configuration element present. |
136 |
</remarks>
|
137 |
<seealso cref="!:http://oauth.net/core/1.0#encoding_parameters"/> |
138 |
<seealso cref="!:http://stackoverflow.com/questions/846487/how-to-get-uri-escapedatastring-to-comply-with-rfc-3986"/> |
139 |
</member>
|
140 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeStrict(System.String)"> |
141 |
<summary>
|
142 |
URL encodes a string based on section 5.1 of the OAuth spec. |
143 |
Namely, percent encoding with [RFC3986], avoiding unreserved characters, |
144 |
upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. |
145 |
</summary>
|
146 |
<param name="value"></param> |
147 |
<seealso cref="!:http://oauth.net/core/1.0#encoding_parameters"/> |
148 |
</member>
|
149 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.NormalizeRequestParameters(RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
150 |
<summary>
|
151 |
Sorts a collection of key-value pairs by name, and then value if equal, |
152 |
concatenating them into a single string. This string should be encoded |
153 |
prior to, or after normalization is run. |
154 |
</summary>
|
155 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.1"/> |
156 |
<param name="parameters"></param> |
157 |
<returns></returns> |
158 |
</member>
|
159 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.SortParametersExcludingSignature(RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
160 |
<summary>
|
161 |
Sorts a <see cref="T:RestSharp.Authenticators.OAuth.WebParameterCollection"/> by name, and then value if equal. |
162 |
</summary>
|
163 |
<param name="parameters">A collection of parameters to sort</param> |
164 |
<returns>A sorted parameter collection</returns> |
165 |
</member>
|
166 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConstructRequestUrl(System.Uri)"> |
167 |
<summary>
|
168 |
Creates a request URL suitable for making OAuth requests. |
169 |
Resulting URLs must exclude port 80 or port 443 when accompanied by HTTP and HTTPS, respectively. |
170 |
Resulting URLs must be lower case. |
171 |
</summary>
|
172 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.2"/> |
173 |
<param name="url">The original request URL</param> |
174 |
<returns></returns> |
175 |
</member>
|
176 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConcatenateRequestElements(System.String,System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
177 |
<summary>
|
178 |
Creates a request elements concatentation value to send with a request. |
179 |
This is also known as the signature base. |
180 |
</summary>
|
181 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.1.3"/> |
182 |
<seealso cref="!:http://oauth.net/core/1.0#sig_base_example"/> |
183 |
<param name="method">The request's HTTP method type</param> |
184 |
<param name="url">The request URL</param> |
185 |
<param name="parameters">The request's parameters</param> |
186 |
<returns>A signature base string</returns> |
187 |
</member>
|
188 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,System.String,System.String)"> |
189 |
<summary>
|
190 |
Creates a signature value given a signature base and the consumer secret. |
191 |
This method is used when the token secret is currently unknown. |
192 |
</summary>
|
193 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/> |
194 |
<param name="signatureMethod">The hashing method</param> |
195 |
<param name="signatureBase">The signature base</param> |
196 |
<param name="consumerSecret">The consumer key</param> |
197 |
<returns></returns> |
198 |
</member>
|
199 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String)"> |
200 |
<summary>
|
201 |
Creates a signature value given a signature base and the consumer secret. |
202 |
This method is used when the token secret is currently unknown. |
203 |
</summary>
|
204 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/> |
205 |
<param name="signatureMethod">The hashing method</param> |
206 |
<param name="signatureTreatment">The treatment to use on a signature value</param> |
207 |
<param name="signatureBase">The signature base</param> |
208 |
<param name="consumerSecret">The consumer key</param> |
209 |
<returns></returns> |
210 |
</member>
|
211 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,System.String,System.String,System.String)"> |
212 |
<summary>
|
213 |
Creates a signature value given a signature base and the consumer secret and a known token secret. |
214 |
</summary>
|
215 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/> |
216 |
<param name="signatureMethod">The hashing method</param> |
217 |
<param name="signatureBase">The signature base</param> |
218 |
<param name="consumerSecret">The consumer secret</param> |
219 |
<param name="tokenSecret">The token secret</param> |
220 |
<returns></returns> |
221 |
</member>
|
222 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String,System.String)"> |
223 |
<summary>
|
224 |
Creates a signature value given a signature base and the consumer secret and a known token secret. |
225 |
</summary>
|
226 |
<seealso cref="!:http://oauth.net/core/1.0#rfc.section.9.2"/> |
227 |
<param name="signatureMethod">The hashing method</param> |
228 |
<param name="signatureTreatment">The treatment to use on a signature value</param> |
229 |
<param name="signatureBase">The signature base</param> |
230 |
<param name="consumerSecret">The consumer secret</param> |
231 |
<param name="tokenSecret">The token secret</param> |
232 |
<returns></returns> |
233 |
</member>
|
234 |
<member name="T:RestSharp.Authenticators.OAuth.OAuthWorkflow"> |
235 |
<summary>
|
236 |
A class to encapsulate OAuth authentication flow. |
237 |
<seealso cref="!:http://oauth.net/core/1.0#anchor9"/> |
238 |
</summary>
|
239 |
</member>
|
240 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildRequestTokenInfo(System.String)"> |
241 |
<summary>
|
242 |
Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an |
243 |
<see cref="T:RestSharp.Authenticators.IAuthenticator"/> for the purpose of requesting an |
244 |
unauthorized request token. |
245 |
</summary>
|
246 |
<param name="method">The HTTP method for the intended request</param> |
247 |
<seealso cref="!:http://oauth.net/core/1.0#anchor9"/> |
248 |
<returns></returns> |
249 |
</member>
|
250 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildRequestTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
251 |
<summary>
|
252 |
Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an |
253 |
<see cref="T:RestSharp.Authenticators.IAuthenticator"/> for the purpose of requesting an |
254 |
unauthorized request token. |
255 |
</summary>
|
256 |
<param name="method">The HTTP method for the intended request</param> |
257 |
<param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> |
258 |
<seealso cref="!:http://oauth.net/core/1.0#anchor9"/> |
259 |
<returns></returns> |
260 |
</member>
|
261 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildAccessTokenInfo(System.String)"> |
262 |
<summary>
|
263 |
Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an |
264 |
<see cref="T:RestSharp.Authenticators.IAuthenticator"/> for the purpose of exchanging a request token |
265 |
for an access token authorized by the user at the Service Provider site. |
266 |
</summary>
|
267 |
<param name="method">The HTTP method for the intended request</param> |
268 |
<seealso cref="!:http://oauth.net/core/1.0#anchor9"/> |
269 |
</member>
|
270 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildAccessTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
271 |
<summary>
|
272 |
Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an |
273 |
<see cref="T:RestSharp.Authenticators.IAuthenticator"/> for the purpose of exchanging a request token |
274 |
for an access token authorized by the user at the Service Provider site. |
275 |
</summary>
|
276 |
<param name="method">The HTTP method for the intended request</param> |
277 |
<seealso cref="!:http://oauth.net/core/1.0#anchor9"/> |
278 |
<param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> |
279 |
</member>
|
280 |
<member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildClientAuthAccessTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebParameterCollection)"> |
281 |
<summary>
|
282 |
Generates a <see cref="T:RestSharp.Authenticators.OAuth.OAuthWebQueryInfo"/> instance to pass to an |
283 |
<see cref="T:RestSharp.Authenticators.IAuthenticator"/> for the purpose of exchanging user credentials |
284 |
for an access token authorized by the user at the Service Provider site. |
285 |
</summary>
|
286 |
<param name="method">The HTTP method for the intended request</param> |
287 |
<seealso cref="!:http://tools.ietf.org/html/draft-dehora-farrell-oauth-accesstoken-creds-00#section-4"/> |
288 |
<param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> |
289 |
</member>
|
290 |
<member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.RequestTokenUrl"> |
291 |
<seealso cref="!:http://oauth.net/core/1.0#request_urls"/> |
292 |
</member>
|
293 |
<member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.AccessTokenUrl"> |
294 |
<seealso cref="!:http://oauth.net/core/1.0#request_urls"/> |
295 |
</member>
|
296 |
<member name="P:RestSharp.Authenticators.OAuth.OAuthWorkflow.AuthorizationUrl"> |
297 |
<seealso cref="!:http://oauth.net/core/1.0#request_urls"/> |
298 |
</member>
|
299 |
<member name="T:RestSharp.Compression.ZLib.Crc32"> |
300 |
<summary>
|
301 |
Calculates a 32bit Cyclic Redundancy Checksum (CRC) using the same polynomial |
302 |
used by Zip. This type is used internally by DotNetZip; it is generally not used |
303 |
directly by applications wishing to create, read, or manipulate zip archive |
304 |
files. |
305 |
</summary>
|
306 |
</member>
|
307 |
<member name="M:RestSharp.Compression.ZLib.Crc32.GetCrc32(System.IO.Stream)"> |
308 |
<summary>
|
309 |
Returns the CRC32 for the specified stream. |
310 |
</summary>
|
311 |
<param name="input">The stream over which to calculate the CRC32</param> |
312 |
<returns>the CRC32 calculation</returns> |
313 |
</member>
|
314 |
<member name="M:RestSharp.Compression.ZLib.Crc32.GetCrc32AndCopy(System.IO.Stream,System.IO.Stream)"> |
315 |
<summary>
|
316 |
Returns the CRC32 for the specified stream, and writes the input into the |
317 |
output stream. |
318 |
</summary>
|
319 |
<param name="input">The stream over which to calculate the CRC32</param> |
320 |
<param name="output">The stream into which to deflate the input</param> |
321 |
<returns>the CRC32 calculation</returns> |
322 |
</member>
|
323 |
<member name="M:RestSharp.Compression.ZLib.Crc32.ComputeCrc32(System.Int32,System.Byte)"> |
324 |
<summary>
|
325 |
Get the CRC32 for the given (word,byte) combo. This is a computation |
326 |
defined by PKzip. |
327 |
</summary>
|
328 |
<param name="w">The word to start with.</param> |
329 |
<param name="b">The byte to combine it with.</param> |
330 |
<returns>The CRC-ized result.</returns> |
331 |
</member>
|
332 |
<member name="M:RestSharp.Compression.ZLib.Crc32.SlurpBlock(System.Byte[],System.Int32,System.Int32)"> |
333 |
<summary>
|
334 |
Update the value for the running CRC32 using the given block of bytes. |
335 |
This is useful when using the CRC32() class in a Stream. |
336 |
</summary>
|
337 |
<param name="block">block of bytes to slurp</param> |
338 |
<param name="offset">starting point in the block</param> |
339 |
<param name="count">how many bytes within the block to slurp</param> |
340 |
</member>
|
341 |
<member name="P:RestSharp.Compression.ZLib.Crc32.TotalBytesRead"> |
342 |
<summary>
|
343 |
indicates the total number of bytes read on the CRC stream. |
344 |
This is used when writing the ZipDirEntry when compressing files. |
345 |
</summary>
|
346 |
</member>
|
347 |
<member name="P:RestSharp.Compression.ZLib.Crc32.Crc32Result"> |
348 |
<summary>
|
349 |
Indicates the current CRC for all blocks slurped in. |
350 |
</summary>
|
351 |
</member>
|
352 |
<member name="T:RestSharp.Compression.ZLib.CrcCalculatorStream"> |
353 |
<summary>
|
354 |
A Stream that calculates a CRC32 (a checksum) on all bytes read, |
355 |
or on all bytes written. |
356 |
</summary>
|
357 |
|
358 |
<remarks>
|
359 |
<para>
|
360 |
This class can be used to verify the CRC of a ZipEntry when |
361 |
reading from a stream, or to calculate a CRC when writing to a |
362 |
stream. The stream should be used to either read, or write, but |
363 |
not both. If you intermix reads and writes, the results are not |
364 |
defined. |
365 |
</para>
|
366 |
|
367 |
<para>
|
368 |
This class is intended primarily for use internally by the |
369 |
DotNetZip library. |
370 |
</para>
|
371 |
</remarks>
|
372 |
</member>
|
373 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream)"> |
374 |
<summary>
|
375 |
The default constructor. |
376 |
</summary>
|
377 |
<remarks>
|
378 |
Instances returned from this constructor will leave the underlying stream |
379 |
open upon Close(). |
380 |
</remarks>
|
381 |
<param name="stream">The underlying stream</param> |
382 |
</member>
|
383 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Boolean)"> |
384 |
<summary>
|
385 |
The constructor allows the caller to specify how to handle the underlying |
386 |
stream at close. |
387 |
</summary>
|
388 |
<param name="stream">The underlying stream</param> |
389 |
<param name="leaveOpen">true to leave the underlying stream |
390 |
open upon close of the CrcCalculatorStream.; false otherwise.</param>
|
391 |
</member>
|
392 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64)"> |
393 |
<summary>
|
394 |
A constructor allowing the specification of the length of the stream to read. |
395 |
</summary>
|
396 |
<remarks>
|
397 |
Instances returned from this constructor will leave the underlying stream open |
398 |
upon Close(). |
399 |
</remarks>
|
400 |
<param name="stream">The underlying stream</param> |
401 |
<param name="length">The length of the stream to slurp</param> |
402 |
</member>
|
403 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.#ctor(System.IO.Stream,System.Int64,System.Boolean)"> |
404 |
<summary>
|
405 |
A constructor allowing the specification of the length of the stream to |
406 |
read, as well as whether to keep the underlying stream open upon Close(). |
407 |
</summary>
|
408 |
<param name="stream">The underlying stream</param> |
409 |
<param name="length">The length of the stream to slurp</param> |
410 |
<param name="leaveOpen">true to leave the underlying stream |
411 |
open upon close of the CrcCalculatorStream.; false otherwise.</param>
|
412 |
</member>
|
413 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Read(System.Byte[],System.Int32,System.Int32)"> |
414 |
<summary>
|
415 |
Read from the stream |
416 |
</summary>
|
417 |
<param name="buffer">the buffer to read</param> |
418 |
<param name="offset">the offset at which to start</param> |
419 |
<param name="count">the number of bytes to read</param> |
420 |
<returns>the number of bytes actually read</returns> |
421 |
</member>
|
422 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Write(System.Byte[],System.Int32,System.Int32)"> |
423 |
<summary>
|
424 |
Write to the stream. |
425 |
</summary>
|
426 |
<param name="buffer">the buffer from which to write</param> |
427 |
<param name="offset">the offset at which to start writing</param> |
428 |
<param name="count">the number of bytes to write</param> |
429 |
</member>
|
430 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Flush"> |
431 |
<summary>
|
432 |
Flush the stream. |
433 |
</summary>
|
434 |
</member>
|
435 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Seek(System.Int64,System.IO.SeekOrigin)"> |
436 |
<summary>
|
437 |
Not implemented. |
438 |
</summary>
|
439 |
<param name="offset">N/A</param> |
440 |
<param name="origin">N/A</param> |
441 |
<returns>N/A</returns> |
442 |
</member>
|
443 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.SetLength(System.Int64)"> |
444 |
<summary>
|
445 |
Not implemented. |
446 |
</summary>
|
447 |
<param name="value">N/A</param> |
448 |
</member>
|
449 |
<member name="M:RestSharp.Compression.ZLib.CrcCalculatorStream.Close"> |
450 |
<summary>
|
451 |
Closes the stream. |
452 |
</summary>
|
453 |
</member>
|
454 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.TotalBytesSlurped"> |
455 |
<summary>
|
456 |
Gets the total number of bytes run through the CRC32 calculator. |
457 |
</summary>
|
458 |
|
459 |
<remarks>
|
460 |
This is either the total number of bytes read, or the total number of bytes |
461 |
written, depending on the direction of this stream. |
462 |
</remarks>
|
463 |
</member>
|
464 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Crc"> |
465 |
<summary>
|
466 |
Provides the current CRC for all blocks slurped in. |
467 |
</summary>
|
468 |
</member>
|
469 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.LeaveOpen"> |
470 |
<summary>
|
471 |
Indicates whether the underlying stream will be left open when the |
472 |
CrcCalculatorStream is Closed. |
473 |
</summary>
|
474 |
</member>
|
475 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanRead"> |
476 |
<summary>
|
477 |
Indicates whether the stream supports reading. |
478 |
</summary>
|
479 |
</member>
|
480 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanSeek"> |
481 |
<summary>
|
482 |
Indicates whether the stream supports seeking. |
483 |
</summary>
|
484 |
</member>
|
485 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.CanWrite"> |
486 |
<summary>
|
487 |
Indicates whether the stream supports writing. |
488 |
</summary>
|
489 |
</member>
|
490 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Length"> |
491 |
<summary>
|
492 |
Not implemented. |
493 |
</summary>
|
494 |
</member>
|
495 |
<member name="P:RestSharp.Compression.ZLib.CrcCalculatorStream.Position"> |
496 |
<summary>
|
497 |
Not implemented. |
498 |
</summary>
|
499 |
</member>
|
500 |
<member name="T:RestSharp.Compression.ZLib.FlushType"> |
501 |
<summary>
|
502 |
Describes how to flush the current deflate operation. |
503 |
</summary>
|
504 |
<remarks>
|
505 |
The different FlushType values are useful when using a Deflate in a streaming application. |
506 |
</remarks>
|
507 |
</member>
|
508 |
<member name="F:RestSharp.Compression.ZLib.FlushType.None"> |
509 |
<summary>No flush at all.</summary> |
510 |
</member>
|
511 |
<member name="F:RestSharp.Compression.ZLib.FlushType.Partial"> |
512 |
<summary>Closes the current block, but doesn't flush it to
|
513 |
the output. Used internally only in hypothetical |
514 |
scenarios. This was supposed to be removed by Zlib, but it is |
515 |
still in use in some edge cases. |
516 |
</summary>
|
517 |
</member>
|
518 |
<member name="F:RestSharp.Compression.ZLib.FlushType.Sync"> |
519 |
<summary>
|
520 |
Use this during compression to specify that all pending output should be |
521 |
flushed to the output buffer and the output should be aligned on a byte |
522 |
boundary. You might use this in a streaming communication scenario, so that |
523 |
the decompressor can get all input data available so far. When using this |
524 |
with a ZlibCodec, <c>AvailableBytesIn</c> will be zero after the call if |
525 |
enough output space has been provided before the call. Flushing will |
526 |
degrade compression and so it should be used only when necessary. |
527 |
</summary>
|
528 |
</member>
|
529 |
<member name="F:RestSharp.Compression.ZLib.FlushType.Full"> |
530 |
<summary>
|
531 |
Use this during compression to specify that all output should be flushed, as |
532 |
with <c>FlushType.Sync</c>, but also, the compression state should be reset |
533 |
so that decompression can restart from this point if previous compressed |
534 |
data has been damaged or if random access is desired. Using |
535 |
<c>FlushType.Full</c> too often can significantly degrade the compression. |
536 |
</summary>
|
537 |
</member>
|
538 |
<member name="F:RestSharp.Compression.ZLib.FlushType.Finish"> |
539 |
<summary>Signals the end of the compression/decompression stream.</summary> |
540 |
</member>
|
541 |
<member name="T:RestSharp.Compression.ZLib.GZipStream"> |
542 |
<summary>
|
543 |
A class for compressing and decompressing GZIP streams. |
544 |
</summary>
|
545 |
<remarks>
|
546 |
|
547 |
<para>
|
548 |
The GZipStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds GZIP compression or decompression to any stream. |
549 |
</para>
|
550 |
|
551 |
<para> Like the <c>Compression.GZipStream</c> in the .NET Base |
552 |
Class Library, the Ionic.Zlib.GZipStream can compress while writing, or decompress |
553 |
while reading, but not vice versa. The compression method used is GZIP, which is |
554 |
documented in <see href="http://www.ietf.org/rfc/rfc1952.txt">IETF RFC 1952</see>, |
555 |
"GZIP file format specification version 4.3".</para>
|
556 |
|
557 |
<para> A GZipStream can be used to decompress data (through Read()) or to compress
|
558 |
data (through Write()), but not both. </para>
|
559 |
|
560 |
<para> If you wish to use the GZipStream to compress data, you must wrap it around a
|
561 |
write-able stream. As you call Write() on the GZipStream, the data will be |
562 |
compressed into the GZIP format. If you want to decompress data, you must wrap the |
563 |
GZipStream around a readable stream that contains an IETF RFC 1952-compliant stream. |
564 |
The data will be decompressed as you call Read() on the GZipStream. </para>
|
565 |
|
566 |
<para> Though the GZIP format allows data from multiple files to be concatenated
|
567 |
together, this stream handles only a single segment of GZIP format, typically |
568 |
representing a single file. </para>
|
569 |
|
570 |
<para>
|
571 |
This class is similar to <see cref="T:RestSharp.Compression.ZLib.ZlibStream"/> and <see cref="!:DeflateStream"/>. |
572 |
<c>ZlibStream</c> handles RFC1950-compliant streams. <see cref="!:DeflateStream"/> |
573 |
handles RFC1951-compliant streams. This class handles RFC1952-compliant streams. |
574 |
</para>
|
575 |
|
576 |
</remarks>
|
577 |
|
578 |
<seealso cref="!:DeflateStream"/> |
579 |
<seealso cref="T:RestSharp.Compression.ZLib.ZlibStream"/> |
580 |
</member>
|
581 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.#ctor(System.IO.Stream)"> |
582 |
<summary>
|
583 |
Create a GZipStream using the specified CompressionMode and the specified CompressionLevel, |
584 |
and explicitly specify whether the stream should be left open after Deflation or Inflation. |
585 |
</summary>
|
586 |
<remarks>
|
587 |
<para>
|
588 |
This constructor allows the application to request that the captive stream remain open after |
589 |
the deflation or inflation occurs. By default, after Close() is called on the stream, the |
590 |
captive stream is also closed. In some cases this is not desired, for example if the stream |
591 |
is a memory stream that will be re-read after compressed data has been written to it. Specify true for the |
592 |
leaveOpen parameter to leave the stream open. |
593 |
</para>
|
594 |
<para>
|
595 |
As noted in the class documentation, |
596 |
the CompressionMode (Compress or Decompress) also establishes the "direction" of the stream. |
597 |
A GZipStream with CompressionMode.Compress works only through Write(). A GZipStream with |
598 |
CompressionMode.Decompress works only through Read(). |
599 |
</para>
|
600 |
</remarks>
|
601 |
<example>
|
602 |
This example shows how to use a DeflateStream to compress data. |
603 |
<code>
|
604 |
using (System.IO.Stream input = System.IO.File.OpenRead(fileToCompress)) |
605 |
{ |
606 |
using (var raw = System.IO.File.Create(outputFile)) |
607 |
{ |
608 |
using (Stream compressor = new GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, true)) |
609 |
{ |
610 |
byte[] buffer = new byte[WORKING_BUFFER_SIZE]; |
611 |
int n; |
612 |
while ((n= input.Read(buffer, 0, buffer.Length)) != 0) |
613 |
{ |
614 |
compressor.Write(buffer, 0, n); |
615 |
} |
616 |
} |
617 |
} |
618 |
} |
619 |
</code>
|
620 |
<code lang="VB"> |
621 |
Dim outputFile As String = (fileToCompress & ".compressed")
|
622 |
Using input As Stream = File.OpenRead(fileToCompress) |
623 |
Using raw As FileStream = File.Create(outputFile) |
624 |
Using compressor As Stream = New GZipStream(raw, CompressionMode.Compress, CompressionLevel.BestCompression, True) |
625 |
Dim buffer As Byte() = New Byte(4096) {} |
626 |
Dim n As Integer = -1 |
627 |
Do While (n <> 0) |
628 |
If (n > 0) Then
|
629 |
compressor.Write(buffer, 0, n) |
630 |
End If |
631 |
n = input.Read(buffer, 0, buffer.Length) |
632 |
Loop |
633 |
End Using |
634 |
End Using |
635 |
End Using |
636 |
</code>
|
637 |
</example>
|
638 |
<param name="stream">The stream which will be read or written.</param> |
639 |
<param name="mode">Indicates whether the GZipStream will compress or decompress.</param> |
640 |
<param name="leaveOpen">true if the application would like the stream to remain open after inflation/deflation.</param> |
641 |
<param name="level">A tuning knob to trade speed for effectiveness.</param> |
642 |
</member>
|
643 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.Dispose(System.Boolean)"> |
644 |
<summary>
|
645 |
Dispose the stream. |
646 |
</summary>
|
647 |
<remarks>
|
648 |
This may or may not result in a Close() call on the captive stream. |
649 |
See the ctor's with leaveOpen parameters for more information. |
650 |
</remarks>
|
651 |
</member>
|
652 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.Flush"> |
653 |
<summary>
|
654 |
Flush the stream. |
655 |
</summary>
|
656 |
</member>
|
657 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.Read(System.Byte[],System.Int32,System.Int32)"> |
658 |
<summary>
|
659 |
Read and decompress data from the source stream. |
660 |
</summary>
|
661 |
<remarks>
|
662 |
With a GZipStream, decompression is done through reading. |
663 |
</remarks>
|
664 |
<example>
|
665 |
<code>
|
666 |
byte[] working = new byte[WORKING_BUFFER_SIZE]; |
667 |
using (System.IO.Stream input = System.IO.File.OpenRead(_CompressedFile)) |
668 |
{ |
669 |
using (Stream decompressor= new Ionic.Zlib.GZipStream(input, CompressionMode.Decompress, true)) |
670 |
{ |
671 |
using (var output = System.IO.File.Create(_DecompressedFile)) |
672 |
{ |
673 |
int n; |
674 |
while ((n= decompressor.Read(working, 0, working.Length)) !=0) |
675 |
{ |
676 |
output.Write(working, 0, n); |
677 |
} |
678 |
} |
679 |
} |
680 |
} |
681 |
</code>
|
682 |
</example>
|
683 |
<param name="buffer">The buffer into which the decompressed data should be placed.</param> |
684 |
<param name="offset">the offset within that data array to put the first byte read.</param> |
685 |
<param name="count">the number of bytes to read.</param> |
686 |
<returns>the number of bytes actually read</returns> |
687 |
</member>
|
688 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.Seek(System.Int64,System.IO.SeekOrigin)"> |
689 |
<summary>
|
690 |
Calling this method always throws a <see cref="T:System.NotImplementedException"/>. |
691 |
</summary>
|
692 |
<param name="offset">irrelevant; it will always throw!</param> |
693 |
<param name="origin">irrelevant; it will always throw!</param> |
694 |
<returns>irrelevant!</returns> |
695 |
</member>
|
696 |
<member name="M:RestSharp.Compression.ZLib.GZipStream.SetLength(System.Int64)"> |
697 |
<summary>
|
698 |
Calling this method always throws a NotImplementedException. |
699 |
</summary>
|
700 |
<param name="value">irrelevant; this method will always throw!</param> |
701 |
</member>
|
702 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.Comment"> |
703 |
<summary>
|
704 |
The Comment on the GZIP stream. |
705 |
</summary>
|
706 |
<remarks>
|
707 |
<para>
|
708 |
The GZIP format allows for each file to optionally have an associated comment stored with the |
709 |
file. The comment is encoded with the ISO-8859-1 code page. To include a comment in |
710 |
a GZIP stream you create, set this property before calling Write() for the first time |
711 |
on the GZipStream. |
712 |
</para>
|
713 |
|
714 |
<para>
|
715 |
When using GZipStream to decompress, you can retrieve this property after the first |
716 |
call to Read(). If no comment has been set in the GZIP bytestream, the Comment |
717 |
property will return null (Nothing in VB). |
718 |
</para>
|
719 |
</remarks>
|
720 |
</member>
|
721 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.FileName"> |
722 |
<summary>
|
723 |
The FileName for the GZIP stream. |
724 |
</summary>
|
725 |
<remarks>
|
726 |
<para>
|
727 |
The GZIP format optionally allows each file to have an associated filename. When |
728 |
compressing data (through Write()), set this FileName before calling Write() the first |
729 |
time on the GZipStream. The actual filename is encoded into the GZIP bytestream with |
730 |
the ISO-8859-1 code page, according to RFC 1952. It is the application's responsibility to |
731 |
insure that the FileName can be encoded and decoded correctly with this code page. |
732 |
</para>
|
733 |
<para>
|
734 |
When decompressing (through Read()), you can retrieve this value any time after the |
735 |
first Read(). In the case where there was no filename encoded into the GZIP |
736 |
bytestream, the property will return null (Nothing in VB). |
737 |
</para>
|
738 |
</remarks>
|
739 |
</member>
|
740 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.Crc32"> |
741 |
<summary>
|
742 |
The CRC on the GZIP stream. |
743 |
</summary>
|
744 |
<remarks>
|
745 |
This is used for internal error checking. You probably don't need to look at this property. |
746 |
</remarks>
|
747 |
</member>
|
748 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.FlushMode"> |
749 |
<summary>
|
750 |
This property sets the flush behavior on the stream. |
751 |
</summary>
|
752 |
</member>
|
753 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.BufferSize"> |
754 |
<summary>
|
755 |
The size of the working buffer for the compression codec. |
756 |
</summary>
|
757 |
|
758 |
<remarks>
|
759 |
<para>
|
760 |
The working buffer is used for all stream operations. The default size is 1024 bytes. |
761 |
The minimum size is 128 bytes. You may get better performance with a larger buffer. |
762 |
Then again, you might not. You would have to test it. |
763 |
</para>
|
764 |
|
765 |
<para>
|
766 |
Set this before the first call to Read() or Write() on the stream. If you try to set it |
767 |
afterwards, it will throw. |
768 |
</para>
|
769 |
</remarks>
|
770 |
</member>
|
771 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.TotalIn"> |
772 |
<summary> Returns the total number of bytes input so far.</summary> |
773 |
</member>
|
774 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.TotalOut"> |
775 |
<summary> Returns the total number of bytes output so far.</summary> |
776 |
</member>
|
777 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.CanRead"> |
778 |
<summary>
|
779 |
Indicates whether the stream can be read. |
780 |
</summary>
|
781 |
<remarks>
|
782 |
The return value depends on whether the captive stream supports reading. |
783 |
</remarks>
|
784 |
</member>
|
785 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.CanSeek"> |
786 |
<summary>
|
787 |
Indicates whether the stream supports Seek operations. |
788 |
</summary>
|
789 |
<remarks>
|
790 |
Always returns false. |
791 |
</remarks>
|
792 |
</member>
|
793 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.CanWrite"> |
794 |
<summary>
|
795 |
Indicates whether the stream can be written. |
796 |
</summary>
|
797 |
<remarks>
|
798 |
The return value depends on whether the captive stream supports writing. |
799 |
</remarks>
|
800 |
</member>
|
801 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.Length"> |
802 |
<summary>
|
803 |
Reading this property always throws a NotImplementedException. |
804 |
</summary>
|
805 |
</member>
|
806 |
<member name="P:RestSharp.Compression.ZLib.GZipStream.Position"> |
807 |
<summary>
|
808 |
The position of the stream pointer. |
809 |
</summary>
|
810 |
<remarks>
|
811 |
Writing this property always throws a NotImplementedException. Reading will |
812 |
return the total bytes written out, if used in writing, or the total bytes |
813 |
read in, if used in reading. The count may refer to compressed bytes or |
814 |
uncompressed bytes, depending on how you've used the stream. |
815 |
</remarks>
|
816 |
</member>
|
817 |
<member name="T:RestSharp.Compression.ZLib.ZlibException"> |
818 |
<summary>
|
819 |
A general purpose exception class for exceptions in the Zlib library. |
820 |
</summary>
|
821 |
</member>
|
822 |
<member name="M:RestSharp.Compression.ZLib.ZlibException.#ctor"> |
823 |
<summary>
|
824 |
The ZlibException class captures exception information generated |
825 |
by the Zlib library. |
826 |
</summary>
|
827 |
</member>
|
828 |
<member name="M:RestSharp.Compression.ZLib.ZlibException.#ctor(System.String)"> |
829 |
<summary>
|
830 |
This ctor collects a message attached to the exception. |
831 |
</summary>
|
832 |
<param name="s"></param> |
833 |
</member>
|
834 |
<member name="M:RestSharp.Compression.ZLib.SharedUtils.UrShift(System.Int32,System.Int32)"> |
835 |
<summary>
|
836 |
Performs an unsigned bitwise right shift with the specified number |
837 |
</summary>
|
838 |
<param name="number">Number to operate on</param> |
839 |
<param name="bits">Ammount of bits to shift</param> |
840 |
<returns>The resulting number from the shift operation</returns> |
841 |
</member>
|
842 |
<member name="M:RestSharp.Compression.ZLib.SharedUtils.UrShift(System.Int64,System.Int32)"> |
843 |
<summary>
|
844 |
Performs an unsigned bitwise right shift with the specified number |
845 |
</summary>
|
846 |
<param name="number">Number to operate on</param> |
847 |
<param name="bits">Ammount of bits to shift</param> |
848 |
<returns>The resulting number from the shift operation</returns> |
849 |
</member>
|
850 |
<member name="M:RestSharp.Compression.ZLib.SharedUtils.ReadInput(System.IO.TextReader,System.Byte[],System.Int32,System.Int32)"> |
851 |
<summary>Reads a number of characters from the current source TextReader and writes the data to the target array at the specified index.</summary> |
852 |
<param name="sourceTextReader">The source TextReader to read from</param> |
853 |
<param name="target">Contains the array of characteres read from the source TextReader.</param> |
854 |
<param name="start">The starting index of the target array.</param> |
855 |
<param name="count">The maximum number of characters to read from the source TextReader.</param> |
856 |
<returns>The number of characters read. The number will be less than or equal to count depending on the data available in the source TextReader. Returns -1 if the end of the stream is reached.</returns> |
857 |
</member>
|
858 |
<member name="T:RestSharp.Compression.ZLib.Adler"> |
859 |
<summary>
|
860 |
Computes an Adler-32 checksum. |
861 |
</summary>
|
862 |
<remarks>
|
863 |
The Adler checksum is similar to a CRC checksum, but faster to compute, though less |
864 |
reliable. It is used in producing RFC1950 compressed streams. The Adler checksum |
865 |
is a required part of the "ZLIB" standard. Applications will almost never need to |
866 |
use this class directly. |
867 |
</remarks>
|
868 |
</member>
|
869 |
<member name="T:RestSharp.Compression.ZLib.ZlibCodec"> |
870 |
<summary>
|
871 |
Encoder and Decoder for ZLIB and DEFLATE (IETF RFC1950 and RFC1951). |
872 |
</summary>
|
873 |
|
874 |
<remarks>
|
875 |
This class compresses and decompresses data according to the Deflate algorithm |
876 |
and optionally, the ZLIB format, as documented in <see
|
877 |
href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950 - ZLIB</see> and <see |
878 |
href="http://www.ietf.org/rfc/rfc1951.txt">RFC 1951 - DEFLATE</see>. |
879 |
</remarks>
|
880 |
</member>
|
881 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.InputBuffer"> |
882 |
<summary>
|
883 |
The buffer from which data is taken. |
884 |
</summary>
|
885 |
</member>
|
886 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.NextIn"> |
887 |
<summary>
|
888 |
An index into the InputBuffer array, indicating where to start reading. |
889 |
</summary>
|
890 |
</member>
|
891 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.AvailableBytesIn"> |
892 |
<summary>
|
893 |
The number of bytes available in the InputBuffer, starting at NextIn. |
894 |
</summary>
|
895 |
<remarks>
|
896 |
Generally you should set this to InputBuffer.Length before the first Inflate() or Deflate() call. |
897 |
The class will update this number as calls to Inflate/Deflate are made. |
898 |
</remarks>
|
899 |
</member>
|
900 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.TotalBytesIn"> |
901 |
<summary>
|
902 |
Total number of bytes read so far, through all calls to Inflate()/Deflate(). |
903 |
</summary>
|
904 |
</member>
|
905 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.OutputBuffer"> |
906 |
<summary>
|
907 |
Buffer to store output data. |
908 |
</summary>
|
909 |
</member>
|
910 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.NextOut"> |
911 |
<summary>
|
912 |
An index into the OutputBuffer array, indicating where to start writing. |
913 |
</summary>
|
914 |
</member>
|
915 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.AvailableBytesOut"> |
916 |
<summary>
|
917 |
The number of bytes available in the OutputBuffer, starting at NextOut. |
918 |
</summary>
|
919 |
<remarks>
|
920 |
Generally you should set this to OutputBuffer.Length before the first Inflate() or Deflate() call. |
921 |
The class will update this number as calls to Inflate/Deflate are made. |
922 |
</remarks>
|
923 |
</member>
|
924 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.TotalBytesOut"> |
925 |
<summary>
|
926 |
Total number of bytes written to the output so far, through all calls to Inflate()/Deflate(). |
927 |
</summary>
|
928 |
</member>
|
929 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.Message"> |
930 |
<summary>
|
931 |
used for diagnostics, when something goes wrong! |
932 |
</summary>
|
933 |
</member>
|
934 |
<member name="F:RestSharp.Compression.ZLib.ZlibCodec.WindowBits"> |
935 |
<summary>
|
936 |
The number of Window Bits to use. |
937 |
</summary>
|
938 |
<remarks>
|
939 |
This gauges the size of the sliding window, and hence the |
940 |
compression effectiveness as well as memory consumption. It's best to just leave this |
941 |
setting alone if you don't know what it is. The maximum value is 15 bits, which implies |
942 |
a 32k window. |
943 |
</remarks>
|
944 |
</member>
|
945 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.#ctor"> |
946 |
<summary>
|
947 |
Create a ZlibCodec that decompresses. |
948 |
</summary>
|
949 |
</member>
|
950 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate"> |
951 |
<summary>
|
952 |
Initialize the inflation state. |
953 |
</summary>
|
954 |
<remarks>
|
955 |
It is not necessary to call this before using the ZlibCodec to inflate data; |
956 |
It is implicitly called when you call the constructor. |
957 |
</remarks>
|
958 |
<returns>Z_OK if everything goes well.</returns> |
959 |
</member>
|
960 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Boolean)"> |
961 |
<summary>
|
962 |
Initialize the inflation state with an explicit flag to |
963 |
govern the handling of RFC1950 header bytes. |
964 |
</summary>
|
965 |
|
966 |
<remarks>
|
967 |
By default, the ZLIB header defined in <see
|
968 |
href="http://www.ietf.org/rfc/rfc1950.txt">RFC 1950</see> is expected. If |
969 |
you want to read a zlib stream you should specify true for |
970 |
expectRfc1950Header. If you have a deflate stream, you will want to specify |
971 |
false. It is only necessary to invoke this initializer explicitly if you |
972 |
want to specify false. |
973 |
</remarks>
|
974 |
|
975 |
<param name="expectRfc1950Header">whether to expect an RFC1950 header byte |
976 |
pair when reading the stream of data to be inflated.</param>
|
977 |
|
978 |
<returns>Z_OK if everything goes well.</returns> |
979 |
</member>
|
980 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Int32)"> |
981 |
<summary>
|
982 |
Initialize the ZlibCodec for inflation, with the specified number of window bits. |
983 |
</summary>
|
984 |
<param name="windowBits">The number of window bits to use. If you need to ask what that is, |
985 |
then you shouldn't be calling this initializer.</param>
|
986 |
<returns>Z_OK if all goes well.</returns> |
987 |
</member>
|
988 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.InitializeInflate(System.Int32,System.Boolean)"> |
989 |
<summary>
|
990 |
Initialize the inflation state with an explicit flag to govern the handling of |
991 |
RFC1950 header bytes. |
992 |
</summary>
|
993 |
|
994 |
<remarks>
|
995 |
If you want to read a zlib stream you should specify true for |
996 |
expectRfc1950Header. In this case, the library will expect to find a ZLIB |
997 |
header, as defined in <see href="http://www.ietf.org/rfc/rfc1950.txt">RFC |
998 |
1950</see>, in the compressed stream. If you will be reading a DEFLATE or
|
999 |
GZIP stream, which does not have such a header, you will want to specify |
1000 |
false. |
1001 |
</remarks>
|
1002 |
|
1003 |
<param name="expectRfc1950Header">whether to expect an RFC1950 header byte pair when reading |
1004 |
the stream of data to be inflated.</param>
|
1005 |
<param name="windowBits">The number of window bits to use. If you need to ask what that is, |
1006 |
then you shouldn't be calling this initializer.</param>
|
1007 |
<returns>Z_OK if everything goes well.</returns> |
1008 |
</member>
|
1009 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.Inflate(RestSharp.Compression.ZLib.FlushType)"> |
1010 |
<summary>
|
1011 |
Inflate the data in the InputBuffer, placing the result in the OutputBuffer. |
1012 |
</summary>
|
1013 |
<remarks>
|
1014 |
You must have set InputBuffer and OutputBuffer, NextIn and NextOut, and AvailableBytesIn and |
1015 |
AvailableBytesOut before calling this method. |
1016 |
</remarks>
|
1017 |
<example>
|
1018 |
<code>
|
1019 |
private void InflateBuffer() |
1020 |
{ |
1021 |
int bufferSize = 1024; |
1022 |
byte[] buffer = new byte[bufferSize]; |
1023 |
ZlibCodec decompressor = new ZlibCodec(); |
1024 |
|
1025 |
Console.WriteLine("\n============================================"); |
1026 |
Console.WriteLine("Size of Buffer to Inflate: {0} bytes.", CompressedBytes.Length); |
1027 |
MemoryStream ms = new MemoryStream(DecompressedBytes); |
1028 |
|
1029 |
int rc = decompressor.InitializeInflate(); |
1030 |
|
1031 |
decompressor.InputBuffer = CompressedBytes; |
1032 |
decompressor.NextIn = 0; |
1033 |
decompressor.AvailableBytesIn = CompressedBytes.Length; |
1034 |
|
1035 |
decompressor.OutputBuffer = buffer; |
1036 |
|
1037 |
// pass 1: inflate |
1038 |
do |
1039 |
{ |
1040 |
decompressor.NextOut = 0; |
1041 |
decompressor.AvailableBytesOut = buffer.Length; |
1042 |
rc = decompressor.Inflate(ZlibConstants.Z_NO_FLUSH); |
1043 |
|
1044 |
if (rc != ZlibConstants.Z_OK && rc != ZlibConstants.Z_STREAM_END) |
1045 |
throw new Exception("inflating: " + decompressor.Message); |
1046 |
|
1047 |
ms.Write(decompressor.OutputBuffer, 0, buffer.Length - decompressor.AvailableBytesOut); |
1048 |
} |
1049 |
while (decompressor.AvailableBytesIn > 0 || decompressor.AvailableBytesOut == 0);
|
1050 |
|
1051 |
// pass 2: finish and flush |
1052 |
do |
1053 |
{ |
1054 |
decompressor.NextOut = 0; |
1055 |
decompressor.AvailableBytesOut = buffer.Length; |
1056 |
rc = decompressor.Inflate(ZlibConstants.Z_FINISH); |
1057 |
|
1058 |
if (rc != ZlibConstants.Z_STREAM_END && rc != ZlibConstants.Z_OK) |
1059 |
throw new Exception("inflating: " + decompressor.Message); |
1060 |
|
1061 |
if (buffer.Length - decompressor.AvailableBytesOut > 0)
|
1062 |
ms.Write(buffer, 0, buffer.Length - decompressor.AvailableBytesOut); |
1063 |
} |
1064 |
while (decompressor.AvailableBytesIn > 0 || decompressor.AvailableBytesOut == 0);
|
1065 |
|
1066 |
decompressor.EndInflate(); |
1067 |
} |
1068 |
|
1069 |
</code>
|
1070 |
</example>
|
1071 |
<param name="flush">The flush to use when inflating.</param> |
1072 |
<returns>Z_OK if everything goes well.</returns> |
1073 |
</member>
|
1074 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.EndInflate"> |
1075 |
<summary>
|
1076 |
Ends an inflation session. |
1077 |
</summary>
|
1078 |
<remarks>
|
1079 |
Call this after successively calling Inflate(). This will cause all buffers to be flushed. |
1080 |
After calling this you cannot call Inflate() without a intervening call to one of the |
1081 |
InitializeInflate() overloads. |
1082 |
</remarks>
|
1083 |
<returns>Z_OK if everything goes well.</returns> |
1084 |
</member>
|
1085 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.SyncInflate"> |
1086 |
<summary>
|
1087 |
I don't know what this does! |
1088 |
</summary>
|
1089 |
<returns>Z_OK if everything goes well.</returns> |
1090 |
</member>
|
1091 |
<member name="M:RestSharp.Compression.ZLib.ZlibCodec.SetDictionary(System.Byte[])"> |
1092 |
<summary>
|
1093 |
Set the dictionary to be used for either Inflation or Deflation. |
1094 |
</summary>
|
1095 |
<param name="dictionary">The dictionary bytes to use.</param> |
1096 |
<returns>Z_OK if all goes well.</returns> |
1097 |
</member>
|
1098 |
<member name="P:RestSharp.Compression.ZLib.ZlibCodec.Adler32"> |
1099 |
<summary>
|
1100 |
The Adler32 checksum on the data transferred through the codec so far. You probably don't need to look at this. |
1101 |
</summary>
|
1102 |
</member>
|
1103 |
<member name="T:RestSharp.Compression.ZLib.ZlibConstants"> |
1104 |
<summary>
|
1105 |
A bunch of constants used in the Zlib interface. |
1106 |
</summary>
|
1107 |
</member>
|
1108 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.WINDOW_BITS_MAX"> |
1109 |
<summary>
|
1110 |
The maximum number of window bits for the Deflate algorithm. |
1111 |
</summary>
|
1112 |
</member>
|
1113 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.WINDOW_BITS_DEFAULT"> |
1114 |
<summary>
|
1115 |
The default number of window bits for the Deflate algorithm. |
1116 |
</summary>
|
1117 |
</member>
|
1118 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_OK"> |
1119 |
<summary>
|
1120 |
indicates everything is A-OK |
1121 |
</summary>
|
1122 |
</member>
|
1123 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_STREAM_END"> |
1124 |
<summary>
|
1125 |
Indicates that the last operation reached the end of the stream. |
1126 |
</summary>
|
1127 |
</member>
|
1128 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_NEED_DICT"> |
1129 |
<summary>
|
1130 |
The operation ended in need of a dictionary. |
1131 |
</summary>
|
1132 |
</member>
|
1133 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_STREAM_ERROR"> |
1134 |
<summary>
|
1135 |
There was an error with the stream - not enough data, not open and readable, etc. |
1136 |
</summary>
|
1137 |
</member>
|
1138 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_DATA_ERROR"> |
1139 |
<summary>
|
1140 |
There was an error with the data - not enough data, bad data, etc. |
1141 |
</summary>
|
1142 |
</member>
|
1143 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.Z_BUF_ERROR"> |
1144 |
<summary>
|
1145 |
There was an error with the working buffer. |
1146 |
</summary>
|
1147 |
</member>
|
1148 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.WORKING_BUFFER_SIZE_DEFAULT"> |
1149 |
<summary>
|
1150 |
The size of the working buffer used in the ZlibCodec class. Defaults to 8192 bytes. |
1151 |
</summary>
|
1152 |
</member>
|
1153 |
<member name="F:RestSharp.Compression.ZLib.ZlibConstants.WORKING_BUFFER_SIZE_MIN"> |
1154 |
<summary>
|
1155 |
The minimum size of the working buffer used in the ZlibCodec class. Currently it is 128 bytes. |
1156 |
</summary>
|
1157 |
</member>
|
1158 |
<member name="T:RestSharp.Compression.ZLib.ZlibStream"> |
1159 |
<summary>
|
1160 |
Represents a Zlib stream for compression or decompression. |
1161 |
</summary>
|
1162 |
<remarks>
|
1163 |
|
1164 |
<para>
|
1165 |
The ZlibStream is a <see href="http://en.wikipedia.org/wiki/Decorator_pattern">Decorator</see> on a <see cref="T:System.IO.Stream"/>. It adds ZLIB compression or decompression to any |
1166 |
stream. |
1167 |
</para>
|
1168 |
|
1169 |
<para> Using this stream, applications can compress or decompress data via
|
1170 |
stream <c>Read</c> and <c>Write</c> operations. Either compresssion or |
1171 |
decompression can occur through either reading or writing. The compression |
1172 |
format used is ZLIB, which is documented in <see href="http://www.ietf.org/rfc/rfc1950.txt">IETF RFC 1950</see>, "ZLIB Compressed |
1173 |
Data Format Specification version 3.3". This implementation of ZLIB always uses |
1174 |
DEFLATE as the compression method. (see <see href="http://www.ietf.org/rfc/rfc1951.txt">IETF RFC 1951</see>, "DEFLATE |
1175 |
Compressed Data Format Specification version 1.3.") </para>
|
1176 |
|
1177 |
<para>
|
1178 |
The ZLIB format allows for varying compression methods, window sizes, and dictionaries. |
1179 |
This implementation always uses the DEFLATE compression method, a preset dictionary, |
1180 |
and 15 window bits by default. |
1181 |
</para>
|
1182 |
|
1183 |
<para>
|
1184 |
This class is similar to <see cref="!:DeflateStream"/>, except that it adds the |
1185 |
RFC1950 header and trailer bytes to a compressed stream when compressing, or expects |
1186 |
the RFC1950 header and trailer bytes when decompressing. It is also similar to the |
1187 |
<see cref="T:RestSharp.Compression.ZLib.GZipStream"/>. |
1188 |
</para>
|
1189 |
</remarks>
|
1190 |
<seealso cref="!:DeflateStream"/> |
1191 |
<seealso cref="T:RestSharp.Compression.ZLib.GZipStream"/> |
1192 |
</member>
|
1193 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.Dispose(System.Boolean)"> |
1194 |
<summary>
|
1195 |
Dispose the stream. |
1196 |
</summary>
|
1197 |
<remarks>
|
1198 |
This may or may not result in a Close() call on the captive stream. |
1199 |
See the constructors that have a leaveOpen parameter for more information. |
1200 |
</remarks>
|
1201 |
</member>
|
1202 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.Flush"> |
1203 |
<summary>
|
1204 |
Flush the stream. |
1205 |
</summary>
|
1206 |
</member>
|
1207 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.Read(System.Byte[],System.Int32,System.Int32)"> |
1208 |
<summary>
|
1209 |
Read data from the stream. |
1210 |
</summary>
|
1211 |
|
1212 |
<remarks>
|
1213 |
|
1214 |
<para>
|
1215 |
If you wish to use the ZlibStream to compress data while reading, you can create a |
1216 |
ZlibStream with CompressionMode.Compress, providing an uncompressed data stream. Then |
1217 |
call Read() on that ZlibStream, and the data read will be compressed. If you wish to |
1218 |
use the ZlibStream to decompress data while reading, you can create a ZlibStream with |
1219 |
CompressionMode.Decompress, providing a readable compressed data stream. Then call |
1220 |
Read() on that ZlibStream, and the data will be decompressed as it is read. |
1221 |
</para>
|
1222 |
|
1223 |
<para>
|
1224 |
A ZlibStream can be used for Read() or Write(), but not both. |
1225 |
</para>
|
1226 |
</remarks>
|
1227 |
<param name="buffer">The buffer into which the read data should be placed.</param> |
1228 |
<param name="offset">the offset within that data array to put the first byte read.</param> |
1229 |
<param name="count">the number of bytes to read.</param> |
1230 |
</member>
|
1231 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.Seek(System.Int64,System.IO.SeekOrigin)"> |
1232 |
<summary>
|
1233 |
Calling this method always throws a NotImplementedException. |
1234 |
</summary>
|
1235 |
</member>
|
1236 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.SetLength(System.Int64)"> |
1237 |
<summary>
|
1238 |
Calling this method always throws a NotImplementedException. |
1239 |
</summary>
|
1240 |
</member>
|
1241 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.Write(System.Byte[],System.Int32,System.Int32)"> |
1242 |
<summary>
|
1243 |
Write data to the stream. |
1244 |
</summary>
|
1245 |
|
1246 |
<remarks>
|
1247 |
|
1248 |
<para>
|
1249 |
If you wish to use the ZlibStream to compress data while writing, you can create a |
1250 |
ZlibStream with CompressionMode.Compress, and a writable output stream. Then call |
1251 |
Write() on that ZlibStream, providing uncompressed data as input. The data sent to |
1252 |
the output stream will be the compressed form of the data written. If you wish to use |
1253 |
the ZlibStream to decompress data while writing, you can create a ZlibStream with |
1254 |
CompressionMode.Decompress, and a writable output stream. Then call Write() on that |
1255 |
stream, providing previously compressed data. The data sent to the output stream will |
1256 |
be the decompressed form of the data written. |
1257 |
</para>
|
1258 |
|
1259 |
<para>
|
1260 |
A ZlibStream can be used for Read() or Write(), but not both. |
1261 |
</para>
|
1262 |
</remarks>
|
1263 |
<param name="buffer">The buffer holding data to write to the stream.</param> |
1264 |
<param name="offset">the offset within that data array to find the first byte to write.</param> |
1265 |
<param name="count">the number of bytes to write.</param> |
1266 |
</member>
|
1267 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.UncompressString(System.Byte[])"> |
1268 |
<summary>
|
1269 |
Uncompress a byte array into a single string. |
1270 |
</summary>
|
1271 |
<seealso cref="!:ZlibStream.CompressString(String)"/> |
1272 |
<param name="compressed"> |
1273 |
A buffer containing ZLIB-compressed data. |
1274 |
</param>
|
1275 |
</member>
|
1276 |
<member name="M:RestSharp.Compression.ZLib.ZlibStream.UncompressBuffer(System.Byte[])"> |
1277 |
<summary>
|
1278 |
Uncompress a byte array into a byte array. |
1279 |
</summary>
|
1280 |
<seealso cref="!:ZlibStream.CompressBuffer(byte[])"/> |
1281 |
<seealso cref="M:RestSharp.Compression.ZLib.ZlibStream.UncompressString(System.Byte[])"/> |
1282 |
<param name="compressed"> |
1283 |
A buffer containing ZLIB-compressed data. |
1284 |
</param>
|
1285 |
</member>
|
1286 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.FlushMode"> |
1287 |
<summary>
|
1288 |
This property sets the flush behavior on the stream. |
1289 |
Sorry, though, not sure exactly how to describe all the various settings. |
1290 |
</summary>
|
1291 |
</member>
|
1292 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.BufferSize"> |
1293 |
<summary>
|
1294 |
The size of the working buffer for the compression codec. |
1295 |
</summary>
|
1296 |
|
1297 |
<remarks>
|
1298 |
<para>
|
1299 |
The working buffer is used for all stream operations. The default size is 1024 bytes. |
1300 |
The minimum size is 128 bytes. You may get better performance with a larger buffer. |
1301 |
Then again, you might not. You would have to test it. |
1302 |
</para>
|
1303 |
|
1304 |
<para>
|
1305 |
Set this before the first call to Read() or Write() on the stream. If you try to set it |
1306 |
afterwards, it will throw. |
1307 |
</para>
|
1308 |
</remarks>
|
1309 |
</member>
|
1310 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.TotalIn"> |
1311 |
<summary> Returns the total number of bytes input so far.</summary> |
1312 |
</member>
|
1313 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.TotalOut"> |
1314 |
<summary> Returns the total number of bytes output so far.</summary> |
1315 |
</member>
|
1316 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.CanRead"> |
1317 |
<summary>
|
1318 |
Indicates whether the stream can be read. |
1319 |
</summary>
|
1320 |
<remarks>
|
1321 |
The return value depends on whether the captive stream supports reading. |
1322 |
</remarks>
|
1323 |
</member>
|
1324 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.CanSeek"> |
1325 |
<summary>
|
1326 |
Indicates whether the stream supports Seek operations. |
1327 |
</summary>
|
1328 |
<remarks>
|
1329 |
Always returns false. |
1330 |
</remarks>
|
1331 |
</member>
|
1332 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.CanWrite"> |
1333 |
<summary>
|
1334 |
Indicates whether the stream can be written. |
1335 |
</summary>
|
1336 |
<remarks>
|
1337 |
The return value depends on whether the captive stream supports writing. |
1338 |
</remarks>
|
1339 |
</member>
|
1340 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.Length"> |
1341 |
<summary>
|
1342 |
Reading this property always throws a NotImplementedException. |
1343 |
</summary>
|
1344 |
</member>
|
1345 |
<member name="P:RestSharp.Compression.ZLib.ZlibStream.Position"> |
1346 |
<summary>
|
1347 |
The position of the stream pointer. |
1348 |
</summary>
|
1349 |
<remarks>
|
1350 |
Writing this property always throws a NotImplementedException. Reading will |
1351 |
return the total bytes written out, if used in writing, or the total bytes |
1352 |
read in, if used in reading. The count may refer to compressed bytes or |
1353 |
uncompressed bytes, depending on how you've used the stream. |
1354 |
</remarks>
|
1355 |
</member>
|
1356 |
<member name="T:RestSharp.Deserializers.DeserializeAsAttribute"> |
1357 |
<summary>
|
1358 |
Allows control how class and property names and values are deserialized by XmlAttributeDeserializer |
1359 |
</summary>
|
1360 |
</member>
|
1361 |
<member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Name"> |
1362 |
<summary>
|
1363 |
The name to use for the serialized element |
1364 |
</summary>
|
1365 |
</member>
|
1366 |
<member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Attribute"> |
1367 |
<summary>
|
1368 |
Sets if the property to Deserialize is an Attribute or Element (Default: false) |
1369 |
</summary>
|
1370 |
</member>
|
1371 |
<member name="T:RestSharp.Deserializers.DotNetXmlDeserializer"> |
1372 |
<summary>
|
1373 |
Wrapper for System.Xml.Serialization.XmlSerializer. |
1374 |
</summary>
|
1375 |
</member>
|
1376 |
<member name="T:RestSharp.ParameterType"> |
1377 |
<summary>
|
1378 |
Types of parameters that can be added to requests |
1379 |
</summary>
|
1380 |
</member>
|
1381 |
<member name="T:RestSharp.DataFormat"> |
1382 |
<summary>
|
1383 |
Data formats |
1384 |
</summary>
|
1385 |
</member>
|
1386 |
<member name="T:RestSharp.Method"> |
1387 |
<summary>
|
1388 |
HTTP method to use when making requests |
1389 |
</summary>
|
1390 |
</member>
|
1391 |
<member name="T:RestSharp.DateFormat"> |
1392 |
<summary>
|
1393 |
Format strings for commonly-used date formats |
1394 |
</summary>
|
1395 |
</member>
|
1396 |
<member name="F:RestSharp.DateFormat.ISO_8601"> |
1397 |
<summary>
|
1398 |
.NET format string for ISO 8601 date format |
1399 |
</summary>
|
1400 |
</member>
|
1401 |
<member name="F:RestSharp.DateFormat.ROUND_TRIP"> |
1402 |
<summary>
|
1403 |
.NET format string for roundtrip date format |
1404 |
</summary>
|
1405 |
</member>
|
1406 |
<member name="T:RestSharp.ResponseStatus"> |
1407 |
<summary>
|
1408 |
Status for responses (surprised?) |
1409 |
</summary>
|
1410 |
</member>
|
1411 |
<member name="T:RestSharp.Extensions.MiscExtensions"> |
1412 |
<summary>
|
1413 |
Extension method overload! |
1414 |
</summary>
|
1415 |
</member>
|
1416 |
<member name="M:RestSharp.Extensions.MiscExtensions.ReadAsBytes(System.IO.Stream)"> |
1417 |
<summary>
|
1418 |
Read a stream into a byte array |
1419 |
</summary>
|
1420 |
<param name="input">Stream to read</param> |
1421 |
<returns>byte[]</returns> |
1422 |
</member>
|
1423 |
<member name="M:RestSharp.Extensions.MiscExtensions.CopyTo(System.IO.Stream,System.IO.Stream)"> |
1424 |
<summary>
|
1425 |
Copies bytes from one stream to another |
1426 |
</summary>
|
1427 |
<param name="input">The input stream.</param> |
1428 |
<param name="output">The output stream.</param> |
1429 |
</member>
|
1430 |
<member name="M:RestSharp.Extensions.MiscExtensions.AsString(System.Byte[])"> |
1431 |
<summary>
|
1432 |
Converts a byte array to a string, using its byte order mark to convert it to the right encoding. |
1433 |
http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx |
1434 |
</summary>
|
1435 |
<param name="buffer">An array of bytes to convert</param> |
1436 |
<returns>The byte as a string.</returns> |
1437 |
</member>
|
1438 |
<member name="T:RestSharp.Extensions.ReflectionExtensions"> |
1439 |
<summary>
|
1440 |
Reflection extensions |
1441 |
</summary>
|
1442 |
</member>
|
1443 |
<member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Reflection.MemberInfo)"> |
1444 |
<summary>
|
1445 |
Retrieve an attribute from a member (property) |
1446 |
</summary>
|
1447 |
<typeparam name="T">Type of attribute to retrieve</typeparam> |
1448 |
<param name="prop">Member to retrieve attribute from</param> |
1449 |
<returns></returns> |
1450 |
</member>
|
1451 |
<member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Type)"> |
1452 |
<summary>
|
1453 |
Retrieve an attribute from a type |
1454 |
</summary>
|
1455 |
<typeparam name="T">Type of attribute to retrieve</typeparam> |
1456 |
<param name="type">Type to retrieve attribute from</param> |
1457 |
<returns></returns> |
1458 |
</member>
|
1459 |
<member name="M:RestSharp.Extensions.ReflectionExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)"> |
1460 |
<summary>
|
1461 |
Checks a type to see if it derives from a raw generic (e.g. List[[]]) |
1462 |
</summary>
|
1463 |
<param name="toCheck"></param> |
1464 |
<param name="generic"></param> |
1465 |
<returns></returns> |
1466 |
</member>
|
1467 |
<member name="M:RestSharp.Extensions.ReflectionExtensions.FindEnumValue(System.Type,System.String,System.Globalization.CultureInfo)"> |
1468 |
<summary>
|
1469 |
Find a value from a System.Enum by trying several possible variants |
1470 |
of the string value of the enum. |
1471 |
</summary>
|
1472 |
<param name="type">Type of enum</param> |
1473 |
<param name="value">Value for which to search</param> |
1474 |
<param name="culture">The culture used to calculate the name variants</param> |
1475 |
<returns></returns> |
1476 |
</member>
|
1477 |
<member name="M:RestSharp.Extensions.ResponseStatusExtensions.ToWebException(RestSharp.ResponseStatus)"> |
1478 |
<summary>
|
1479 |
Convert a <see cref="T:RestSharp.ResponseStatus"/> to a <see cref="T:System.Net.WebException"/> instance. |
1480 |
</summary>
|
1481 |
<param name="responseStatus">The response status.</param> |
1482 |
<returns></returns> |
1483 |
<exception cref="T:System.ArgumentOutOfRangeException">responseStatus</exception> |
1484 |
</member>
|
1485 |
<member name="M:RestSharp.Extensions.StringExtensions.UrlEncode(System.String)"> |
1486 |
<summary>
|
1487 |
Uses Uri.EscapeDataString() based on recommendations on MSDN |
1488 |
http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx |
1489 |
</summary>
|
1490 |
</member>
|
1491 |
<member name="M:RestSharp.Extensions.StringExtensions.HasValue(System.String)"> |
1492 |
<summary>
|
1493 |
Check that a string is not null or empty |
1494 |
</summary>
|
1495 |
<param name="input">String to check</param> |
1496 |
<returns>bool</returns> |
1497 |
</member>
|
1498 |
<member name="M:RestSharp.Extensions.StringExtensions.RemoveUnderscoresAndDashes(System.String)"> |
1499 |
<summary>
|
1500 |
Remove underscores from a string |
1501 |
</summary>
|
1502 |
<param name="input">String to process</param> |
1503 |
<returns>string</returns> |
1504 |
</member>
|
1505 |
<member name="M:RestSharp.Extensions.StringExtensions.ParseJsonDate(System.String,System.Globalization.CultureInfo)"> |
1506 |
<summary>
|
1507 |
Parses most common JSON date formats |
1508 |
</summary>
|
1509 |
<param name="input">JSON value to parse</param> |
1510 |
<param name="culture"></param> |
1511 |
<returns>DateTime</returns> |
1512 |
</member>
|
1513 |
<member name="M:RestSharp.Extensions.StringExtensions.RemoveSurroundingQuotes(System.String)"> |
1514 |
<summary>
|
1515 |
Remove leading and trailing " from a string |
1516 |
</summary>
|
1517 |
<param name="input">String to parse</param> |
1518 |
<returns>String</returns> |
1519 |
</member>
|
1520 |
<member name="M:RestSharp.Extensions.StringExtensions.Matches(System.String,System.String)"> |
1521 |
<summary>
|
1522 |
Checks a string to see if it matches a regex |
1523 |
</summary>
|
1524 |
<param name="input">String to check</param> |
1525 |
<param name="pattern">Pattern to match</param> |
1526 |
<returns>bool</returns> |
1527 |
</member>
|
1528 |
<member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Globalization.CultureInfo)"> |
1529 |
<summary>
|
1530 |
Converts a string to pascal case |
1531 |
</summary>
|
1532 |
<param name="lowercaseAndUnderscoredWord">String to convert</param> |
1533 |
<param name="culture"></param> |
1534 |
<returns>string</returns> |
1535 |
</member>
|
1536 |
<member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Boolean,System.Globalization.CultureInfo)"> |
1537 |
<summary>
|
1538 |
Converts a string to pascal case with the option to remove underscores |
1539 |
</summary>
|
1540 |
<param name="text">String to convert</param> |
1541 |
<param name="removeUnderscores">Option to remove underscores</param> |
1542 |
<param name="culture"></param> |
1543 |
<returns></returns> |
1544 |
</member>
|
1545 |
<member name="M:RestSharp.Extensions.StringExtensions.ToCamelCase(System.String,System.Globalization.CultureInfo)"> |
1546 |
<summary>
|
1547 |
Converts a string to camel case |
1548 |
</summary>
|
1549 |
<param name="lowercaseAndUnderscoredWord">String to convert</param> |
1550 |
<param name="culture"></param> |
1551 |
<returns>String</returns> |
1552 |
</member>
|
1553 |
<member name="M:RestSharp.Extensions.StringExtensions.MakeInitialLowerCase(System.String)"> |
1554 |
<summary>
|
1555 |
Convert the first letter of a string to lower case |
1556 |
</summary>
|
1557 |
<param name="word">String to convert</param> |
1558 |
<returns>string</returns> |
1559 |
</member>
|
1560 |
<member name="M:RestSharp.Extensions.StringExtensions.IsUpperCase(System.String)"> |
1561 |
<summary>
|
1562 |
Checks to see if a string is all uppper case |
1563 |
</summary>
|
1564 |
<param name="inputString">String to check</param> |
1565 |
<returns>bool</returns> |
1566 |
</member>
|
1567 |
<member name="M:RestSharp.Extensions.StringExtensions.AddUnderscores(System.String)"> |
1568 |
<summary>
|
1569 |
Add underscores to a pascal-cased string |
1570 |
</summary>
|
1571 |
<param name="pascalCasedWord">String to convert</param> |
1572 |
<returns>string</returns> |
1573 |
</member>
|
1574 |
<member name="M:RestSharp.Extensions.StringExtensions.AddDashes(System.String)"> |
1575 |
<summary>
|
1576 |
Add dashes to a pascal-cased string |
1577 |
</summary>
|
1578 |
<param name="pascalCasedWord">String to convert</param> |
1579 |
<returns>string</returns> |
1580 |
</member>
|
1581 |
<member name="M:RestSharp.Extensions.StringExtensions.AddUnderscorePrefix(System.String)"> |
1582 |
<summary>
|
1583 |
Add an undescore prefix to a pascasl-cased string |
1584 |
</summary>
|
1585 |
<param name="pascalCasedWord"></param> |
1586 |
<returns></returns> |
1587 |
</member>
|
1588 |
<member name="M:RestSharp.Extensions.StringExtensions.AddSpaces(System.String)"> |
1589 |
<summary>
|
1590 |
Add spaces to a pascal-cased string |
1591 |
</summary>
|
1592 |
<param name="pascalCasedWord">String to convert</param> |
1593 |
<returns>string</returns> |
1594 |
</member>
|
1595 |
<member name="M:RestSharp.Extensions.StringExtensions.GetNameVariants(System.String,System.Globalization.CultureInfo)"> |
1596 |
<summary>
|
1597 |
Return possible variants of a name for name matching. |
1598 |
</summary>
|
1599 |
<param name="name">String to convert</param> |
1600 |
<param name="culture">The culture to use for conversion</param> |
1601 |
<returns>IEnumerable<string></returns> |
1602 |
</member>
|
1603 |
<member name="T:RestSharp.Extensions.XmlExtensions"> |
1604 |
<summary>
|
1605 |
XML Extension Methods |
1606 |
</summary>
|
1607 |
</member>
|
1608 |
<member name="M:RestSharp.Extensions.XmlExtensions.AsNamespaced(System.String,System.String)"> |
1609 |
<summary>
|
1610 |
Returns the name of an element with the namespace if specified |
1611 |
</summary>
|
1612 |
<param name="name">Element name</param> |
1613 |
<param name="namespace">XML Namespace</param> |
1614 |
<returns></returns> |
1615 |
</member>
|
1616 |
<member name="T:RestSharp.FileParameter"> |
1617 |
<summary>
|
1618 |
Container for files to be uploaded with requests |
1619 |
</summary>
|
1620 |
</member>
|
1621 |
<member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String,System.String)"> |
1622 |
<summary>
|
1623 |
Creates a file parameter from an array of bytes. |
1624 |
</summary>
|
1625 |
<param name="name">The parameter name to use in the request.</param> |
1626 |
<param name="data">The data to use as the file's contents.</param> |
1627 |
<param name="filename">The filename to use in the request.</param> |
1628 |
<param name="contentType">The content type to use in the request.</param> |
1629 |
<returns>The <see cref="T:RestSharp.FileParameter"/></returns> |
1630 |
</member>
|
1631 |
<member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String)"> |
1632 |
<summary>
|
1633 |
Creates a file parameter from an array of bytes. |
1634 |
</summary>
|
1635 |
<param name="name">The parameter name to use in the request.</param> |
1636 |
<param name="data">The data to use as the file's contents.</param> |
1637 |
<param name="filename">The filename to use in the request.</param> |
1638 |
<returns>The <see cref="T:RestSharp.FileParameter"/> using the default content type.</returns> |
1639 |
</member>
|
1640 |
<member name="P:RestSharp.FileParameter.ContentLength"> |
1641 |
<summary>
|
1642 |
The length of data to be sent |
1643 |
</summary>
|
1644 |
</member>
|
1645 |
<member name="P:RestSharp.FileParameter.Writer"> |
1646 |
<summary>
|
1647 |
Provides raw data for file |
1648 |
</summary>
|
1649 |
</member>
|
1650 |
<member name="P:RestSharp.FileParameter.FileName"> |
1651 |
<summary>
|
1652 |
Name of the file to use when uploading |
1653 |
</summary>
|
1654 |
</member>
|
1655 |
<member name="P:RestSharp.FileParameter.ContentType"> |
1656 |
<summary>
|
1657 |
MIME content type of file |
1658 |
</summary>
|
1659 |
</member>
|
1660 |
<member name="P:RestSharp.FileParameter.Name"> |
1661 |
<summary>
|
1662 |
Name of the parameter |
1663 |
</summary>
|
1664 |
</member>
|
1665 |
<member name="T:RestSharp.Http"> |
1666 |
<summary>
|
1667 |
HttpWebRequest wrapper (async methods) |
1668 |
</summary>
|
1669 |
<summary>
|
1670 |
HttpWebRequest wrapper |
1671 |
</summary>
|
1672 |
</member>
|
1673 |
<member name="P:RestSharp.IHttp.AlwaysMultipartFormData"> |
1674 |
<summary>
|
1675 |
Always send a multipart/form-data request - even when no Files are present. |
1676 |
</summary>
|
1677 |
</member>
|
1678 |
<member name="P:RestSharp.IHttp.RequestBodyBytes"> |
1679 |
<summary>
|
1680 |
An alternative to RequestBody, for when the caller already has the byte array. |
1681 |
</summary>
|
1682 |
</member>
|
1683 |
<member name="M:RestSharp.Http.AsPostAsync(System.Action{RestSharp.HttpResponse},System.String)"> |
1684 |
<summary>
|
1685 |
Execute an async POST-style request with the specified HTTP Method. |
1686 |
</summary>
|
1687 |
<param name="action"></param> |
1688 |
<param name="httpMethod">The HTTP method to execute.</param> |
1689 |
<returns></returns> |
1690 |
</member>
|
1691 |
<member name="M:RestSharp.Http.AsGetAsync(System.Action{RestSharp.HttpResponse},System.String)"> |
1692 |
<summary>
|
1693 |
Execute an async GET-style request with the specified HTTP Method. |
1694 |
</summary>
|
1695 |
<param name="action"></param> |
1696 |
<param name="httpMethod">The HTTP method to execute.</param> |
1697 |
<returns></returns> |
1698 |
</member>
|
1699 |
<member name="M:RestSharp.Http.Create"> |
1700 |
<summary>
|
1701 |
Creates an IHttp |
1702 |
</summary>
|
1703 |
<returns></returns> |
1704 |
</member>
|
1705 |
<member name="M:RestSharp.Http.#ctor"> |
1706 |
<summary>
|
1707 |
Default constructor |
1708 |
</summary>
|
1709 |
</member>
|
1710 |
<member name="P:RestSharp.Http.HasParameters"> |
1711 |
<summary>
|
1712 |
True if this HTTP request has any HTTP parameters |
1713 |
</summary>
|
1714 |
</member>
|
1715 |
<member name="P:RestSharp.Http.HasCookies"> |
1716 |
<summary>
|
1717 |
True if this HTTP request has any HTTP cookies |
1718 |
</summary>
|
1719 |
</member>
|
1720 |
<member name="P:RestSharp.Http.HasBody"> |
1721 |
<summary>
|
1722 |
True if a request body has been specified |
1723 |
</summary>
|
1724 |
</member>
|
1725 |
<member name="P:RestSharp.Http.HasFiles"> |
1726 |
<summary>
|
1727 |
True if files have been set to be uploaded |
1728 |
</summary>
|
1729 |
</member>
|
1730 |
<member name="P:RestSharp.Http.AlwaysMultipartFormData"> |
1731 |
<summary>
|
1732 |
Always send a multipart/form-data request - even when no Files are present. |
1733 |
</summary>
|
1734 |
</member>
|
1735 |
<member name="P:RestSharp.Http.UserAgent"> |
1736 |
<summary>
|
1737 |
UserAgent to be sent with request |
1738 |
</summary>
|
1739 |
</member>
|
1740 |
<member name="P:RestSharp.Http.Timeout"> |
1741 |
<summary>
|
1742 |
Timeout in milliseconds to be used for the request |
1743 |
</summary>
|
1744 |
</member>
|
1745 |
<member name="P:RestSharp.Http.ReadWriteTimeout"> |
1746 |
<summary>
|
1747 |
The number of milliseconds before the writing or reading times out. |
1748 |
</summary>
|
1749 |
</member>
|
1750 |
<member name="P:RestSharp.Http.Credentials"> |
1751 |
<summary>
|
1752 |
System.Net.ICredentials to be sent with request |
1753 |
</summary>
|
1754 |
</member>
|
1755 |
<member name="P:RestSharp.Http.CookieContainer"> |
1756 |
<summary>
|
1757 |
The System.Net.CookieContainer to be used for the request |
1758 |
</summary>
|
1759 |
</member>
|
1760 |
<member name="P:RestSharp.Http.ResponseWriter"> |
1761 |
<summary>
|
1762 |
The method to use to write the response instead of reading into RawBytes |
1763 |
</summary>
|
1764 |
</member>
|
1765 |
<member name="P:RestSharp.Http.Files"> |
1766 |
<summary>
|
1767 |
Collection of files to be sent with request |
1768 |
</summary>
|
1769 |
</member>
|
1770 |
<member name="P:RestSharp.Http.FollowRedirects"> |
1771 |
<summary>
|
1772 |
Whether or not HTTP 3xx response redirects should be automatically followed |
1773 |
</summary>
|
1774 |
</member>
|
1775 |
<member name="P:RestSharp.Http.UseDefaultCredentials"> |
1776 |
<summary>
|
1777 |
Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) |
1778 |
will be sent along to the server. |
1779 |
</summary>
|
1780 |
</member>
|
1781 |
<member name="P:RestSharp.Http.Headers"> |
1782 |
<summary>
|
1783 |
HTTP headers to be sent with request |
1784 |
</summary>
|
1785 |
</member>
|
1786 |
<member name="P:RestSharp.Http.Parameters"> |
1787 |
<summary>
|
1788 |
HTTP parameters (QueryString or Form values) to be sent with request |
1789 |
</summary>
|
1790 |
</member>
|
1791 |
<member name="P:RestSharp.Http.Cookies"> |
1792 |
<summary>
|
1793 |
HTTP cookies to be sent with request |
1794 |
</summary>
|
1795 |
</member>
|
1796 |
<member name="P:RestSharp.Http.RequestBody"> |
1797 |
<summary>
|
1798 |
Request body to be sent with request |
1799 |
</summary>
|
1800 |
</member>
|
1801 |
<member name="P:RestSharp.Http.RequestContentType"> |
1802 |
<summary>
|
1803 |
Content type of the request body. |
1804 |
</summary>
|
1805 |
</member>
|
1806 |
<member name="P:RestSharp.Http.RequestBodyBytes"> |
1807 |
<summary>
|
1808 |
An alternative to RequestBody, for when the caller already has the byte array. |
1809 |
</summary>
|
1810 |
</member>
|
1811 |
<member name="P:RestSharp.Http.Url"> |
1812 |
<summary>
|
1813 |
URL to call for this request |
1814 |
</summary>
|
1815 |
</member>
|
1816 |
<member name="P:RestSharp.Http.PreAuthenticate"> |
1817 |
<summary>
|
1818 |
Flag to send authorisation header with the HttpWebRequest |
1819 |
</summary>
|
1820 |
</member>
|
1821 |
<member name="T:RestSharp.HttpCookie"> |
1822 |
<summary>
|
1823 |
Representation of an HTTP cookie |
1824 |
</summary>
|
1825 |
</member>
|
1826 |
<member name="P:RestSharp.HttpCookie.Comment"> |
1827 |
<summary>
|
1828 |
Comment of the cookie |
1829 |
</summary>
|
1830 |
</member>
|
1831 |
<member name="P:RestSharp.HttpCookie.CommentUri"> |
1832 |
<summary>
|
1833 |
Comment of the cookie |
1834 |
</summary>
|
1835 |
</member>
|
1836 |
<member name="P:RestSharp.HttpCookie.Discard"> |
1837 |
<summary>
|
1838 |
Indicates whether the cookie should be discarded at the end of the session |
1839 |
</summary>
|
1840 |
</member>
|
1841 |
<member name="P:RestSharp.HttpCookie.Domain"> |
1842 |
<summary>
|
1843 |
Domain of the cookie |
1844 |
</summary>
|
1845 |
</member>
|
1846 |
<member name="P:RestSharp.HttpCookie.Expired"> |
1847 |
<summary>
|
1848 |
Indicates whether the cookie is expired |
1849 |
</summary>
|
1850 |
</member>
|
1851 |
<member name="P:RestSharp.HttpCookie.Expires"> |
1852 |
<summary>
|
1853 |
Date and time that the cookie expires |
1854 |
</summary>
|
1855 |
</member>
|
1856 |
<member name="P:RestSharp.HttpCookie.HttpOnly"> |
1857 |
<summary>
|
1858 |
Indicates that this cookie should only be accessed by the server |
1859 |
</summary>
|
1860 |
</member>
|
1861 |
<member name="P:RestSharp.HttpCookie.Name"> |
1862 |
<summary>
|
1863 |
Name of the cookie |
1864 |
</summary>
|
1865 |
</member>
|
1866 |
<member name="P:RestSharp.HttpCookie.Path"> |
1867 |
<summary>
|
1868 |
Path of the cookie |
1869 |
</summary>
|
1870 |
</member>
|
1871 |
<member name="P:RestSharp.HttpCookie.Port"> |
1872 |
<summary>
|
1873 |
Port of the cookie |
1874 |
</summary>
|
1875 |
</member>
|
1876 |
<member name="P:RestSharp.HttpCookie.Secure"> |
1877 |
<summary>
|
1878 |
Indicates that the cookie should only be sent over secure channels |
1879 |
</summary>
|
1880 |
</member>
|
1881 |
<member name="P:RestSharp.HttpCookie.TimeStamp"> |
1882 |
<summary>
|
1883 |
Date and time the cookie was created |
1884 |
</summary>
|
1885 |
</member>
|
1886 |
<member name="P:RestSharp.HttpCookie.Value"> |
1887 |
<summary>
|
1888 |
Value of the cookie |
1889 |
</summary>
|
1890 |
</member>
|
1891 |
<member name="P:RestSharp.HttpCookie.Version"> |
1892 |
<summary>
|
1893 |
Version of the cookie |
1894 |
</summary>
|
1895 |
</member>
|
1896 |
<member name="T:RestSharp.HttpFile"> |
1897 |
<summary>
|
1898 |
Container for HTTP file |
1899 |
</summary>
|
1900 |
</member>
|
1901 |
<member name="P:RestSharp.HttpFile.ContentLength"> |
1902 |
<summary>
|
1903 |
The length of data to be sent |
1904 |
</summary>
|
1905 |
</member>
|
1906 |
<member name="P:RestSharp.HttpFile.Writer"> |
1907 |
<summary>
|
1908 |
Provides raw data for file |
1909 |
</summary>
|
1910 |
</member>
|
1911 |
<member name="P:RestSharp.HttpFile.FileName"> |
1912 |
<summary>
|
1913 |
Name of the file to use when uploading |
1914 |
</summary>
|
1915 |
</member>
|
1916 |
<member name="P:RestSharp.HttpFile.ContentType"> |
1917 |
<summary>
|
1918 |
MIME content type of file |
1919 |
</summary>
|
1920 |
</member>
|
1921 |
<member name="P:RestSharp.HttpFile.Name"> |
1922 |
<summary>
|
1923 |
Name of the parameter |
1924 |
</summary>
|
1925 |
</member>
|
1926 |
<member name="T:RestSharp.HttpHeader"> |
1927 |
<summary>
|
1928 |
Representation of an HTTP header |
1929 |
</summary>
|
1930 |
</member>
|
1931 |
<member name="P:RestSharp.HttpHeader.Name"> |
1932 |
<summary>
|
1933 |
Name of the header |
1934 |
</summary>
|
1935 |
</member>
|
1936 |
<member name="P:RestSharp.HttpHeader.Value"> |
1937 |
<summary>
|
1938 |
Value of the header |
1939 |
</summary>
|
1940 |
</member>
|
1941 |
<member name="T:RestSharp.HttpParameter"> |
1942 |
<summary>
|
1943 |
Representation of an HTTP parameter (QueryString or Form value) |
1944 |
</summary>
|
1945 |
</member>
|
1946 |
<member name="P:RestSharp.HttpParameter.Name"> |
1947 |
<summary>
|
1948 |
Name of the parameter |
1949 |
</summary>
|
1950 |
</member>
|
1951 |
<member name="P:RestSharp.HttpParameter.Value"> |
1952 |
<summary>
|
1953 |
Value of the parameter |
1954 |
</summary>
|
1955 |
</member>
|
1956 |
<member name="P:RestSharp.HttpParameter.ContentType"> |
1957 |
<summary>
|
1958 |
Content-Type of the parameter |
1959 |
</summary>
|
1960 |
</member>
|
1961 |
<member name="T:RestSharp.HttpResponse"> |
1962 |
<summary>
|
1963 |
HTTP response data |
1964 |
</summary>
|
1965 |
</member>
|
1966 |
<member name="T:RestSharp.IHttpResponse"> |
1967 |
<summary>
|
1968 |
HTTP response data |
1969 |
</summary>
|
1970 |
</member>
|
1971 |
<member name="P:RestSharp.IHttpResponse.ContentType"> |
1972 |
<summary>
|
1973 |
MIME content type of response |
1974 |
</summary>
|
1975 |
</member>
|
1976 |
<member name="P:RestSharp.IHttpResponse.ContentLength"> |
1977 |
<summary>
|
1978 |
Length in bytes of the response content |
1979 |
</summary>
|
1980 |
</member>
|
1981 |
<member name="P:RestSharp.IHttpResponse.ContentEncoding"> |
1982 |
<summary>
|
1983 |
Encoding of the response content |
1984 |
</summary>
|
1985 |
</member>
|
1986 |
<member name="P:RestSharp.IHttpResponse.Content"> |
1987 |
<summary>
|
1988 |
String representation of response content |
1989 |
</summary>
|
1990 |
</member>
|
1991 |
<member name="P:RestSharp.IHttpResponse.StatusCode"> |
1992 |
<summary>
|
1993 |
HTTP response status code |
1994 |
</summary>
|
1995 |
</member>
|
1996 |
<member name="P:RestSharp.IHttpResponse.StatusDescription"> |
1997 |
<summary>
|
1998 |
Description of HTTP status returned |
1999 |
</summary>
|
2000 |
</member>
|
2001 |
<member name="P:RestSharp.IHttpResponse.RawBytes"> |
2002 |
<summary>
|
2003 |
Response content |
2004 |
</summary>
|
2005 |
</member>
|
2006 |
<member name="P:RestSharp.IHttpResponse.ResponseUri"> |
2007 |
<summary>
|
2008 |
The URL that actually responded to the content (different from request if redirected) |
2009 |
</summary>
|
2010 |
</member>
|
2011 |
<member name="P:RestSharp.IHttpResponse.Server"> |
2012 |
<summary>
|
2013 |
HttpWebResponse.Server |
2014 |
</summary>
|
2015 |
</member>
|
2016 |
<member name="P:RestSharp.IHttpResponse.Headers"> |
2017 |
<summary>
|
2018 |
Headers returned by server with the response |
2019 |
</summary>
|
2020 |
</member>
|
2021 |
<member name="P:RestSharp.IHttpResponse.Cookies"> |
2022 |
<summary>
|
2023 |
Cookies returned by server with the response |
2024 |
</summary>
|
2025 |
</member>
|
2026 |
<member name="P:RestSharp.IHttpResponse.ResponseStatus"> |
2027 |
<summary>
|
2028 |
Status of the request. Will return Error for transport errors. |
2029 |
HTTP errors will still return ResponseStatus.Completed, check StatusCode instead |
2030 |
</summary>
|
2031 |
</member>
|
2032 |
<member name="P:RestSharp.IHttpResponse.ErrorMessage"> |
2033 |
<summary>
|
2034 |
Transport or other non-HTTP error generated while attempting request |
2035 |
</summary>
|
2036 |
</member>
|
2037 |
<member name="P:RestSharp.IHttpResponse.ErrorException"> |
2038 |
<summary>
|
2039 |
Exception thrown when error is encountered. |
2040 |
</summary>
|
2041 |
</member>
|
2042 |
<member name="M:RestSharp.HttpResponse.#ctor"> |
2043 |
<summary>
|
2044 |
Default constructor |
2045 |
</summary>
|
2046 |
</member>
|
2047 |
<member name="P:RestSharp.HttpResponse.ContentType"> |
2048 |
<summary>
|
2049 |
MIME content type of response |
2050 |
</summary>
|
2051 |
</member>
|
2052 |
<member name="P:RestSharp.HttpResponse.ContentLength"> |
2053 |
<summary>
|
2054 |
Length in bytes of the response content |
2055 |
</summary>
|
2056 |
</member>
|
2057 |
<member name="P:RestSharp.HttpResponse.ContentEncoding"> |
2058 |
<summary>
|
2059 |
Encoding of the response content |
2060 |
</summary>
|
2061 |
</member>
|
2062 |
<member name="P:RestSharp.HttpResponse.Content"> |
2063 |
<summary>
|
2064 |
Lazy-loaded string representation of response content |
2065 |
</summary>
|
2066 |
</member>
|
2067 |
<member name="P:RestSharp.HttpResponse.StatusCode"> |
2068 |
<summary>
|
2069 |
HTTP response status code |
2070 |
</summary>
|
2071 |
</member>
|
2072 |
<member name="P:RestSharp.HttpResponse.StatusDescription"> |
2073 |
<summary>
|
2074 |
Description of HTTP status returned |
2075 |
</summary>
|
2076 |
</member>
|
2077 |
<member name="P:RestSharp.HttpResponse.RawBytes"> |
2078 |
<summary>
|
2079 |
Response content |
2080 |
</summary>
|
2081 |
</member>
|
2082 |
<member name="P:RestSharp.HttpResponse.ResponseUri"> |
2083 |
<summary>
|
2084 |
The URL that actually responded to the content (different from request if redirected) |
2085 |
</summary>
|
2086 |
</member>
|
2087 |
<member name="P:RestSharp.HttpResponse.Server"> |
2088 |
<summary>
|
2089 |
HttpWebResponse.Server |
2090 |
</summary>
|
2091 |
</member>
|
2092 |
<member name="P:RestSharp.HttpResponse.Headers"> |
2093 |
<summary>
|
2094 |
Headers returned by server with the response |
2095 |
</summary>
|
2096 |
</member>
|
2097 |
<member name="P:RestSharp.HttpResponse.Cookies"> |
2098 |
<summary>
|
2099 |
Cookies returned by server with the response |
2100 |
</summary>
|
2101 |
</member>
|
2102 |
<member name="P:RestSharp.HttpResponse.ResponseStatus"> |
2103 |
<summary>
|
2104 |
Status of the request. Will return Error for transport errors. |
2105 |
HTTP errors will still return ResponseStatus.Completed, check StatusCode instead |
2106 |
</summary>
|
2107 |
</member>
|
2108 |
<member name="P:RestSharp.HttpResponse.ErrorMessage"> |
2109 |
<summary>
|
2110 |
Transport or other non-HTTP error generated while attempting request |
2111 |
</summary>
|
2112 |
</member>
|
2113 |
<member name="P:RestSharp.HttpResponse.ErrorException"> |
2114 |
<summary>
|
2115 |
Exception thrown when error is encountered. |
2116 |
</summary>
|
2117 |
</member>
|
2118 |
<member name="M:RestSharp.IRestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> |
2119 |
<summary>
|
2120 |
Executes a GET-style request and callback asynchronously, authenticating if needed |
2121 |
</summary>
|
2122 |
<param name="request">Request to be executed</param> |
2123 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> |
2124 |
<param name="httpMethod">The HTTP method to execute</param> |
2125 |
</member>
|
2126 |
<member name="M:RestSharp.IRestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> |
2127 |
<summary>
|
2128 |
Executes a POST-style request and callback asynchronously, authenticating if needed |
2129 |
</summary>
|
2130 |
<param name="request">Request to be executed</param> |
2131 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> |
2132 |
<param name="httpMethod">The HTTP method to execute</param> |
2133 |
</member>
|
2134 |
<member name="M:RestSharp.IRestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> |
2135 |
<summary>
|
2136 |
Executes a GET-style request and callback asynchronously, authenticating if needed |
2137 |
</summary>
|
2138 |
<typeparam name="T">Target deserialization type</typeparam> |
2139 |
<param name="request">Request to be executed</param> |
2140 |
<param name="callback">Callback function to be executed upon completion</param> |
2141 |
<param name="httpMethod">The HTTP method to execute</param> |
2142 |
</member>
|
2143 |
<member name="M:RestSharp.IRestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> |
2144 |
<summary>
|
2145 |
Executes a GET-style request and callback asynchronously, authenticating if needed |
2146 |
</summary>
|
2147 |
<typeparam name="T">Target deserialization type</typeparam> |
2148 |
<param name="request">Request to be executed</param> |
2149 |
<param name="callback">Callback function to be executed upon completion</param> |
2150 |
<param name="httpMethod">The HTTP method to execute</param> |
2151 |
</member>
|
2152 |
<member name="M:RestSharp.IRestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2153 |
<summary>
|
2154 |
Executes the request and callback asynchronously, authenticating if needed |
2155 |
</summary>
|
2156 |
<typeparam name="T">Target deserialization type</typeparam> |
2157 |
<param name="request">Request to be executed</param> |
2158 |
<param name="token">The cancellation token</param> |
2159 |
</member>
|
2160 |
<member name="M:RestSharp.IRestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest)"> |
2161 |
<summary>
|
2162 |
Executes the request asynchronously, authenticating if needed |
2163 |
</summary>
|
2164 |
<typeparam name="T">Target deserialization type</typeparam> |
2165 |
<param name="request">Request to be executed</param> |
2166 |
</member>
|
2167 |
<member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest)"> |
2168 |
<summary>
|
2169 |
Executes a GET-style request asynchronously, authenticating if needed |
2170 |
</summary>
|
2171 |
<typeparam name="T">Target deserialization type</typeparam> |
2172 |
<param name="request">Request to be executed</param> |
2173 |
</member>
|
2174 |
<member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2175 |
<summary>
|
2176 |
Executes a GET-style request asynchronously, authenticating if needed |
2177 |
</summary>
|
2178 |
<typeparam name="T">Target deserialization type</typeparam> |
2179 |
<param name="request">Request to be executed</param> |
2180 |
<param name="token">The cancellation token</param> |
2181 |
</member>
|
2182 |
<member name="M:RestSharp.IRestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest)"> |
2183 |
<summary>
|
2184 |
Executes a POST-style request asynchronously, authenticating if needed |
2185 |
</summary>
|
2186 |
<typeparam name="T">Target deserialization type</typeparam> |
2187 |
<param name="request">Request to be executed</param> |
2188 |
</member>
|
2189 |
<member name="M:RestSharp.IRestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2190 |
<summary>
|
2191 |
Executes a POST-style request asynchronously, authenticating if needed |
2192 |
</summary>
|
2193 |
<typeparam name="T">Target deserialization type</typeparam> |
2194 |
<param name="request">Request to be executed</param> |
2195 |
<param name="token">The cancellation token</param> |
2196 |
</member>
|
2197 |
<member name="M:RestSharp.IRestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2198 |
<summary>
|
2199 |
Executes the request and callback asynchronously, authenticating if needed |
2200 |
</summary>
|
2201 |
<param name="request">Request to be executed</param> |
2202 |
<param name="token">The cancellation token</param> |
2203 |
</member>
|
2204 |
<member name="M:RestSharp.IRestClient.ExecuteTaskAsync(RestSharp.IRestRequest)"> |
2205 |
<summary>
|
2206 |
Executes the request asynchronously, authenticating if needed |
2207 |
</summary>
|
2208 |
<param name="request">Request to be executed</param> |
2209 |
</member>
|
2210 |
<member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest)"> |
2211 |
<summary>
|
2212 |
Executes a GET-style asynchronously, authenticating if needed |
2213 |
</summary>
|
2214 |
<param name="request">Request to be executed</param> |
2215 |
</member>
|
2216 |
<member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2217 |
<summary>
|
2218 |
Executes a GET-style asynchronously, authenticating if needed |
2219 |
</summary>
|
2220 |
<param name="request">Request to be executed</param> |
2221 |
<param name="token">The cancellation token</param> |
2222 |
</member>
|
2223 |
<member name="M:RestSharp.IRestClient.ExecutePostTaskAsync(RestSharp.IRestRequest)"> |
2224 |
<summary>
|
2225 |
Executes a POST-style asynchronously, authenticating if needed |
2226 |
</summary>
|
2227 |
<param name="request">Request to be executed</param> |
2228 |
</member>
|
2229 |
<member name="M:RestSharp.IRestClient.ExecutePostTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2230 |
<summary>
|
2231 |
Executes a POST-style asynchronously, authenticating if needed |
2232 |
</summary>
|
2233 |
<param name="request">Request to be executed</param> |
2234 |
<param name="token">The cancellation token</param> |
2235 |
</member>
|
2236 |
<member name="M:RestSharp.IRestRequest.AddBody(System.Object,System.String)"> |
2237 |
<summary>
|
2238 |
Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer |
2239 |
The default format is XML. Change RequestFormat if you wish to use a different serialization format. |
2240 |
</summary>
|
2241 |
<param name="obj">The object to serialize</param> |
2242 |
<param name="xmlNamespace">The XML namespace to use when serializing</param> |
2243 |
<returns>This request</returns> |
2244 |
</member>
|
2245 |
<member name="M:RestSharp.IRestRequest.AddBody(System.Object)"> |
2246 |
<summary>
|
2247 |
Serializes obj to data format specified by RequestFormat and adds it to the request body. |
2248 |
The default format is XML. Change RequestFormat if you wish to use a different serialization format. |
2249 |
</summary>
|
2250 |
<param name="obj">The object to serialize</param> |
2251 |
<returns>This request</returns> |
2252 |
</member>
|
2253 |
<member name="M:RestSharp.IRestRequest.AddJsonBody(System.Object)"> |
2254 |
<summary>
|
2255 |
Serializes obj to JSON format and adds it to the request body. |
2256 |
</summary>
|
2257 |
<param name="obj">The object to serialize</param> |
2258 |
<returns>This request</returns> |
2259 |
</member>
|
2260 |
<member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object)"> |
2261 |
<summary>
|
2262 |
Serializes obj to XML format and adds it to the request body. |
2263 |
</summary>
|
2264 |
<param name="obj">The object to serialize</param> |
2265 |
<returns>This request</returns> |
2266 |
</member>
|
2267 |
<member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object,System.String)"> |
2268 |
<summary>
|
2269 |
Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer |
2270 |
Serializes obj to XML format and passes xmlNamespace then adds it to the request body. |
2271 |
</summary>
|
2272 |
<param name="obj">The object to serialize</param> |
2273 |
<param name="xmlNamespace">The XML namespace to use when serializing</param> |
2274 |
<returns>This request</returns> |
2275 |
</member>
|
2276 |
<member name="M:RestSharp.IRestRequest.AddObject(System.Object,System.String[])"> |
2277 |
<summary>
|
2278 |
Calls AddParameter() for all public, readable properties specified in the includedProperties list |
2279 |
</summary>
|
2280 |
<example>
|
2281 |
request.AddObject(product, "ProductId", "Price", ...); |
2282 |
</example>
|
2283 |
<param name="obj">The object with properties to add as parameters</param> |
2284 |
<param name="includedProperties">The names of the properties to include</param> |
2285 |
<returns>This request</returns> |
2286 |
</member>
|
2287 |
<member name="M:RestSharp.IRestRequest.AddObject(System.Object)"> |
2288 |
<summary>
|
2289 |
Calls AddParameter() for all public, readable properties of obj |
2290 |
</summary>
|
2291 |
<param name="obj">The object with properties to add as parameters</param> |
2292 |
<returns>This request</returns> |
2293 |
</member>
|
2294 |
<member name="M:RestSharp.IRestRequest.AddParameter(RestSharp.Parameter)"> |
2295 |
<summary>
|
2296 |
Add the parameter to the request |
2297 |
</summary>
|
2298 |
<param name="p">Parameter to add</param> |
2299 |
<returns></returns> |
2300 |
</member>
|
2301 |
<member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object)"> |
2302 |
<summary>
|
2303 |
Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) |
2304 |
</summary>
|
2305 |
<param name="name">Name of the parameter</param> |
2306 |
<param name="value">Value of the parameter</param> |
2307 |
<returns>This request</returns> |
2308 |
</member>
|
2309 |
<member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)"> |
2310 |
<summary>
|
2311 |
Adds a parameter to the request. There are five types of parameters: |
2312 |
- GetOrPost: Either a QueryString value or encoded form value based on method |
2313 |
- HttpHeader: Adds the name/value pair to the HTTP request's Headers collection |
2314 |
- UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} |
2315 |
- Cookie: Adds the name/value pair to the HTTP request's Cookies collection |
2316 |
- RequestBody: Used by AddBody() (not recommended to use directly) |
2317 |
</summary>
|
2318 |
<param name="name">Name of the parameter</param> |
2319 |
<param name="value">Value of the parameter</param> |
2320 |
<param name="type">The type of parameter to add</param> |
2321 |
<returns>This request</returns> |
2322 |
</member>
|
2323 |
<member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> |
2324 |
<summary>
|
2325 |
Adds a parameter to the request. There are five types of parameters: |
2326 |
- GetOrPost: Either a QueryString value or encoded form value based on method |
2327 |
- HttpHeader: Adds the name/value pair to the HTTP request's Headers collection |
2328 |
- UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} |
2329 |
- Cookie: Adds the name/value pair to the HTTP request's Cookies collection |
2330 |
- RequestBody: Used by AddBody() (not recommended to use directly) |
2331 |
</summary>
|
2332 |
<param name="name">Name of the parameter</param> |
2333 |
<param name="value">Value of the parameter</param> |
2334 |
<param name="contentType">Content-Type of the parameter</param> |
2335 |
<param name="type">The type of parameter to add</param> |
2336 |
<returns>This request</returns> |
2337 |
</member>
|
2338 |
<member name="M:RestSharp.IRestRequest.AddHeader(System.String,System.String)"> |
2339 |
<summary>
|
2340 |
Shortcut to AddParameter(name, value, HttpHeader) overload |
2341 |
</summary>
|
2342 |
<param name="name">Name of the header to add</param> |
2343 |
<param name="value">Value of the header to add</param> |
2344 |
<returns></returns> |
2345 |
</member>
|
2346 |
<member name="M:RestSharp.IRestRequest.AddCookie(System.String,System.String)"> |
2347 |
<summary>
|
2348 |
Shortcut to AddParameter(name, value, Cookie) overload |
2349 |
</summary>
|
2350 |
<param name="name">Name of the cookie to add</param> |
2351 |
<param name="value">Value of the cookie to add</param> |
2352 |
<returns></returns> |
2353 |
</member>
|
2354 |
<member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.String)"> |
2355 |
<summary>
|
2356 |
Shortcut to AddParameter(name, value, UrlSegment) overload |
2357 |
</summary>
|
2358 |
<param name="name">Name of the segment to add</param> |
2359 |
<param name="value">Value of the segment to add</param> |
2360 |
<returns></returns> |
2361 |
</member>
|
2362 |
<member name="M:RestSharp.IRestRequest.AddQueryParameter(System.String,System.String)"> |
2363 |
<summary>
|
2364 |
Shortcut to AddParameter(name, value, QueryString) overload |
2365 |
</summary>
|
2366 |
<param name="name">Name of the parameter to add</param> |
2367 |
<param name="value">Value of the parameter to add</param> |
2368 |
<returns></returns> |
2369 |
</member>
|
2370 |
<member name="P:RestSharp.IRestRequest.AlwaysMultipartFormData"> |
2371 |
<summary>
|
2372 |
Always send a multipart/form-data request - even when no Files are present. |
2373 |
</summary>
|
2374 |
</member>
|
2375 |
<member name="P:RestSharp.IRestRequest.JsonSerializer"> |
2376 |
<summary>
|
2377 |
Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. |
2378 |
By default the included JsonSerializer is used (currently using JSON.NET default serialization). |
2379 |
</summary>
|
2380 |
</member>
|
2381 |
<member name="P:RestSharp.IRestRequest.XmlSerializer"> |
2382 |
<summary>
|
2383 |
Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. |
2384 |
By default the included XmlSerializer is used. |
2385 |
</summary>
|
2386 |
</member>
|
2387 |
<member name="P:RestSharp.IRestRequest.ResponseWriter"> |
2388 |
<summary>
|
2389 |
Set this to write response to Stream rather than reading into memory. |
2390 |
</summary>
|
2391 |
</member>
|
2392 |
<member name="P:RestSharp.IRestRequest.Parameters"> |
2393 |
<summary>
|
2394 |
Container of all HTTP parameters to be passed with the request. |
2395 |
See AddParameter() for explanation of the types of parameters that can be passed |
2396 |
</summary>
|
2397 |
</member>
|
2398 |
<member name="P:RestSharp.IRestRequest.Files"> |
2399 |
<summary>
|
2400 |
Container of all the files to be uploaded with the request. |
2401 |
</summary>
|
2402 |
</member>
|
2403 |
<member name="P:RestSharp.IRestRequest.Method"> |
2404 |
<summary>
|
2405 |
Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS |
2406 |
Default is GET |
2407 |
</summary>
|
2408 |
</member>
|
2409 |
<member name="P:RestSharp.IRestRequest.Resource"> |
2410 |
<summary>
|
2411 |
The Resource URL to make the request against. |
2412 |
Tokens are substituted with UrlSegment parameters and match by name. |
2413 |
Should not include the scheme or domain. Do not include leading slash. |
2414 |
Combined with RestClient.BaseUrl to assemble final URL: |
2415 |
{BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) |
2416 |
</summary>
|
2417 |
<example>
|
2418 |
// example for url token replacement |
2419 |
request.Resource = "Products/{ProductId}"; |
2420 |
request.AddParameter("ProductId", 123, ParameterType.UrlSegment); |
2421 |
</example>
|
2422 |
</member>
|
2423 |
<member name="P:RestSharp.IRestRequest.RequestFormat"> |
2424 |
<summary>
|
2425 |
Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. |
2426 |
By default XmlSerializer is used. |
2427 |
</summary>
|
2428 |
</member>
|
2429 |
<member name="P:RestSharp.IRestRequest.RootElement"> |
2430 |
<summary>
|
2431 |
Used by the default deserializers to determine where to start deserializing from. |
2432 |
Can be used to skip container or root elements that do not have corresponding deserialzation targets. |
2433 |
</summary>
|
2434 |
</member>
|
2435 |
<member name="P:RestSharp.IRestRequest.DateFormat"> |
2436 |
<summary>
|
2437 |
Used by the default deserializers to explicitly set which date format string to use when parsing dates. |
2438 |
</summary>
|
2439 |
</member>
|
2440 |
<member name="P:RestSharp.IRestRequest.XmlNamespace"> |
2441 |
<summary>
|
2442 |
Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names. |
2443 |
</summary>
|
2444 |
</member>
|
2445 |
<member name="P:RestSharp.IRestRequest.Credentials"> |
2446 |
<summary>
|
2447 |
In general you would not need to set this directly. Used by the NtlmAuthenticator. |
2448 |
</summary>
|
2449 |
</member>
|
2450 |
<member name="P:RestSharp.IRestRequest.Timeout"> |
2451 |
<summary>
|
2452 |
Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient. |
2453 |
</summary>
|
2454 |
</member>
|
2455 |
<member name="P:RestSharp.IRestRequest.ReadWriteTimeout"> |
2456 |
<summary>
|
2457 |
The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient. |
2458 |
</summary>
|
2459 |
</member>
|
2460 |
<member name="P:RestSharp.IRestRequest.Attempts"> |
2461 |
<summary>
|
2462 |
How many attempts were made to send this Request? |
2463 |
</summary>
|
2464 |
<remarks>
|
2465 |
This Number is incremented each time the RestClient sends the request. |
2466 |
Useful when using Asynchronous Execution with Callbacks |
2467 |
</remarks>
|
2468 |
</member>
|
2469 |
<member name="P:RestSharp.IRestRequest.UseDefaultCredentials"> |
2470 |
<summary>
|
2471 |
Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) |
2472 |
will be sent along to the server. The default is false. |
2473 |
</summary>
|
2474 |
</member>
|
2475 |
<member name="T:RestSharp.IRestResponse"> |
2476 |
<summary>
|
2477 |
Container for data sent back from API |
2478 |
</summary>
|
2479 |
</member>
|
2480 |
<member name="P:RestSharp.IRestResponse.Request"> |
2481 |
<summary>
|
2482 |
The RestRequest that was made to get this RestResponse |
2483 |
</summary>
|
2484 |
<remarks>
|
2485 |
Mainly for debugging if ResponseStatus is not OK |
2486 |
</remarks>
|
2487 |
</member>
|
2488 |
<member name="P:RestSharp.IRestResponse.ContentType"> |
2489 |
<summary>
|
2490 |
MIME content type of response |
2491 |
</summary>
|
2492 |
</member>
|
2493 |
<member name="P:RestSharp.IRestResponse.ContentLength"> |
2494 |
<summary>
|
2495 |
Length in bytes of the response content |
2496 |
</summary>
|
2497 |
</member>
|
2498 |
<member name="P:RestSharp.IRestResponse.ContentEncoding"> |
2499 |
<summary>
|
2500 |
Encoding of the response content |
2501 |
</summary>
|
2502 |
</member>
|
2503 |
<member name="P:RestSharp.IRestResponse.Content"> |
2504 |
<summary>
|
2505 |
String representation of response content |
2506 |
</summary>
|
2507 |
</member>
|
2508 |
<member name="P:RestSharp.IRestResponse.StatusCode"> |
2509 |
<summary>
|
2510 |
HTTP response status code |
2511 |
</summary>
|
2512 |
</member>
|
2513 |
<member name="P:RestSharp.IRestResponse.StatusDescription"> |
2514 |
<summary>
|
2515 |
Description of HTTP status returned |
2516 |
</summary>
|
2517 |
</member>
|
2518 |
<member name="P:RestSharp.IRestResponse.RawBytes"> |
2519 |
<summary>
|
2520 |
Response content |
2521 |
</summary>
|
2522 |
</member>
|
2523 |
<member name="P:RestSharp.IRestResponse.ResponseUri"> |
2524 |
<summary>
|
2525 |
The URL that actually responded to the content (different from request if redirected) |
2526 |
</summary>
|
2527 |
</member>
|
2528 |
<member name="P:RestSharp.IRestResponse.Server"> |
2529 |
<summary>
|
2530 |
HttpWebResponse.Server |
2531 |
</summary>
|
2532 |
</member>
|
2533 |
<member name="P:RestSharp.IRestResponse.Cookies"> |
2534 |
<summary>
|
2535 |
Cookies returned by server with the response |
2536 |
</summary>
|
2537 |
</member>
|
2538 |
<member name="P:RestSharp.IRestResponse.Headers"> |
2539 |
<summary>
|
2540 |
Headers returned by server with the response |
2541 |
</summary>
|
2542 |
</member>
|
2543 |
<member name="P:RestSharp.IRestResponse.ResponseStatus"> |
2544 |
<summary>
|
2545 |
Status of the request. Will return Error for transport errors. |
2546 |
HTTP errors will still return ResponseStatus.Completed, check StatusCode instead |
2547 |
</summary>
|
2548 |
</member>
|
2549 |
<member name="P:RestSharp.IRestResponse.ErrorMessage"> |
2550 |
<summary>
|
2551 |
Transport or other non-HTTP error generated while attempting request |
2552 |
</summary>
|
2553 |
</member>
|
2554 |
<member name="P:RestSharp.IRestResponse.ErrorException"> |
2555 |
<summary>
|
2556 |
Exceptions thrown during the request, if any. |
2557 |
</summary>
|
2558 |
<remarks>Will contain only network transport or framework exceptions thrown during the request.
|
2559 |
HTTP protocol errors are handled by RestSharp and will not appear here.</remarks>
|
2560 |
</member>
|
2561 |
<member name="T:RestSharp.IRestResponse`1"> |
2562 |
<summary>
|
2563 |
Container for data sent back from API including deserialized data |
2564 |
</summary>
|
2565 |
<typeparam name="T">Type of data to deserialize to</typeparam> |
2566 |
</member>
|
2567 |
<member name="P:RestSharp.IRestResponse`1.Data"> |
2568 |
<summary>
|
2569 |
Deserialized entity data |
2570 |
</summary>
|
2571 |
</member>
|
2572 |
<member name="T:RestSharp.Parameter"> |
2573 |
<summary>
|
2574 |
Parameter container for REST requests |
2575 |
</summary>
|
2576 |
</member>
|
2577 |
<member name="M:RestSharp.Parameter.ToString"> |
2578 |
<summary>
|
2579 |
Return a human-readable representation of this parameter |
2580 |
</summary>
|
2581 |
<returns>String</returns> |
2582 |
</member>
|
2583 |
<member name="P:RestSharp.Parameter.Name"> |
2584 |
<summary>
|
2585 |
Name of the parameter |
2586 |
</summary>
|
2587 |
</member>
|
2588 |
<member name="P:RestSharp.Parameter.Value"> |
2589 |
<summary>
|
2590 |
Value of the parameter |
2591 |
</summary>
|
2592 |
</member>
|
2593 |
<member name="P:RestSharp.Parameter.Type"> |
2594 |
<summary>
|
2595 |
Type of the parameter |
2596 |
</summary>
|
2597 |
</member>
|
2598 |
<member name="P:RestSharp.Parameter.ContentType"> |
2599 |
<summary>
|
2600 |
MIME content type of the parameter |
2601 |
</summary>
|
2602 |
</member>
|
2603 |
<member name="T:RestSharp.RestClient"> |
2604 |
<summary>
|
2605 |
Client to translate RestRequests into Http requests and process response result |
2606 |
</summary>
|
2607 |
</member>
|
2608 |
<member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})"> |
2609 |
<summary>
|
2610 |
Executes the request and callback asynchronously, authenticating if needed |
2611 |
</summary>
|
2612 |
<param name="request">Request to be executed</param> |
2613 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> |
2614 |
</member>
|
2615 |
<member name="M:RestSharp.RestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> |
2616 |
<summary>
|
2617 |
Executes a GET-style request and callback asynchronously, authenticating if needed |
2618 |
</summary>
|
2619 |
<param name="request">Request to be executed</param> |
2620 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> |
2621 |
<param name="httpMethod">The HTTP method to execute</param> |
2622 |
</member>
|
2623 |
<member name="M:RestSharp.RestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> |
2624 |
<summary>
|
2625 |
Executes a POST-style request and callback asynchronously, authenticating if needed |
2626 |
</summary>
|
2627 |
<param name="request">Request to be executed</param> |
2628 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> |
2629 |
<param name="httpMethod">The HTTP method to execute</param> |
2630 |
</member>
|
2631 |
<member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})"> |
2632 |
<summary>
|
2633 |
Executes the request and callback asynchronously, authenticating if needed |
2634 |
</summary>
|
2635 |
<typeparam name="T">Target deserialization type</typeparam> |
2636 |
<param name="request">Request to be executed</param> |
2637 |
<param name="callback">Callback function to be executed upon completion</param> |
2638 |
</member>
|
2639 |
<member name="M:RestSharp.RestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> |
2640 |
<summary>
|
2641 |
Executes a GET-style request and callback asynchronously, authenticating if needed |
2642 |
</summary>
|
2643 |
<typeparam name="T">Target deserialization type</typeparam> |
2644 |
<param name="request">Request to be executed</param> |
2645 |
<param name="callback">Callback function to be executed upon completion</param> |
2646 |
<param name="httpMethod">The HTTP method to execute</param> |
2647 |
</member>
|
2648 |
<member name="M:RestSharp.RestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> |
2649 |
<summary>
|
2650 |
Executes a POST-style request and callback asynchronously, authenticating if needed |
2651 |
</summary>
|
2652 |
<typeparam name="T">Target deserialization type</typeparam> |
2653 |
<param name="request">Request to be executed</param> |
2654 |
<param name="callback">Callback function to be executed upon completion</param> |
2655 |
<param name="httpMethod">The HTTP method to execute</param> |
2656 |
</member>
|
2657 |
<member name="M:RestSharp.RestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest)"> |
2658 |
<summary>
|
2659 |
Executes a GET-style request asynchronously, authenticating if needed |
2660 |
</summary>
|
2661 |
<typeparam name="T">Target deserialization type</typeparam> |
2662 |
<param name="request">Request to be executed</param> |
2663 |
</member>
|
2664 |
<member name="M:RestSharp.RestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2665 |
<summary>
|
2666 |
Executes a GET-style request asynchronously, authenticating if needed |
2667 |
</summary>
|
2668 |
<typeparam name="T">Target deserialization type</typeparam> |
2669 |
<param name="request">Request to be executed</param> |
2670 |
<param name="token">The cancellation token</param> |
2671 |
</member>
|
2672 |
<member name="M:RestSharp.RestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest)"> |
2673 |
<summary>
|
2674 |
Executes a POST-style request asynchronously, authenticating if needed |
2675 |
</summary>
|
2676 |
<typeparam name="T">Target deserialization type</typeparam> |
2677 |
<param name="request">Request to be executed</param> |
2678 |
</member>
|
2679 |
<member name="M:RestSharp.RestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2680 |
<summary>
|
2681 |
Executes a POST-style request asynchronously, authenticating if needed |
2682 |
</summary>
|
2683 |
<typeparam name="T">Target deserialization type</typeparam> |
2684 |
<param name="request">Request to be executed</param> |
2685 |
<param name="token">The cancellation token</param> |
2686 |
</member>
|
2687 |
<member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest)"> |
2688 |
<summary>
|
2689 |
Executes the request asynchronously, authenticating if needed |
2690 |
</summary>
|
2691 |
<typeparam name="T">Target deserialization type</typeparam> |
2692 |
<param name="request">Request to be executed</param> |
2693 |
</member>
|
2694 |
<member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2695 |
<summary>
|
2696 |
Executes the request asynchronously, authenticating if needed |
2697 |
</summary>
|
2698 |
<typeparam name="T">Target deserialization type</typeparam> |
2699 |
<param name="request">Request to be executed</param> |
2700 |
<param name="token">The cancellation token</param> |
2701 |
</member>
|
2702 |
<member name="M:RestSharp.RestClient.ExecuteTaskAsync(RestSharp.IRestRequest)"> |
2703 |
<summary>
|
2704 |
Executes the request asynchronously, authenticating if needed |
2705 |
</summary>
|
2706 |
<param name="request">Request to be executed</param> |
2707 |
</member>
|
2708 |
<member name="M:RestSharp.RestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest)"> |
2709 |
<summary>
|
2710 |
Executes a GET-style asynchronously, authenticating if needed |
2711 |
</summary>
|
2712 |
<param name="request">Request to be executed</param> |
2713 |
</member>
|
2714 |
<member name="M:RestSharp.RestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2715 |
<summary>
|
2716 |
Executes a GET-style asynchronously, authenticating if needed |
2717 |
</summary>
|
2718 |
<param name="request">Request to be executed</param> |
2719 |
<param name="token">The cancellation token</param> |
2720 |
</member>
|
2721 |
<member name="M:RestSharp.RestClient.ExecutePostTaskAsync(RestSharp.IRestRequest)"> |
2722 |
<summary>
|
2723 |
Executes a POST-style asynchronously, authenticating if needed |
2724 |
</summary>
|
2725 |
<param name="request">Request to be executed</param> |
2726 |
</member>
|
2727 |
<member name="M:RestSharp.RestClient.ExecutePostTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2728 |
<summary>
|
2729 |
Executes a POST-style asynchronously, authenticating if needed |
2730 |
</summary>
|
2731 |
<param name="request">Request to be executed</param> |
2732 |
<param name="token">The cancellation token</param> |
2733 |
</member>
|
2734 |
<member name="M:RestSharp.RestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> |
2735 |
<summary>
|
2736 |
Executes the request asynchronously, authenticating if needed |
2737 |
</summary>
|
2738 |
<param name="request">Request to be executed</param> |
2739 |
<param name="token">The cancellation token</param> |
2740 |
</member>
|
2741 |
<member name="M:RestSharp.RestClient.#ctor"> |
2742 |
<summary>
|
2743 |
Default constructor that registers default content handlers |
2744 |
</summary>
|
2745 |
</member>
|
2746 |
<member name="M:RestSharp.RestClient.#ctor(System.Uri)"> |
2747 |
<summary>
|
2748 |
Sets the BaseUrl property for requests made by this client instance |
2749 |
</summary>
|
2750 |
<param name="baseUrl"></param> |
2751 |
</member>
|
2752 |
<member name="M:RestSharp.RestClient.#ctor(System.String)"> |
2753 |
<summary>
|
2754 |
Sets the BaseUrl property for requests made by this client instance |
2755 |
</summary>
|
2756 |
<param name="baseUrl"></param> |
2757 |
</member>
|
2758 |
<member name="M:RestSharp.RestClient.AddHandler(System.String,RestSharp.Deserializers.IDeserializer)"> |
2759 |
<summary>
|
2760 |
Registers a content handler to process response content |
2761 |
</summary>
|
2762 |
<param name="contentType">MIME content type of the response content</param> |
2763 |
<param name="deserializer">Deserializer to use to process content</param> |
2764 |
</member>
|
2765 |
<member name="M:RestSharp.RestClient.RemoveHandler(System.String)"> |
2766 |
<summary>
|
2767 |
Remove a content handler for the specified MIME content type |
2768 |
</summary>
|
2769 |
<param name="contentType">MIME content type to remove</param> |
2770 |
</member>
|
2771 |
<member name="M:RestSharp.RestClient.ClearHandlers"> |
2772 |
<summary>
|
2773 |
Remove all content handlers |
2774 |
</summary>
|
2775 |
</member>
|
2776 |
<member name="M:RestSharp.RestClient.GetHandler(System.String)"> |
2777 |
<summary>
|
2778 |
Retrieve the handler for the specified MIME content type |
2779 |
</summary>
|
2780 |
<param name="contentType">MIME content type to retrieve</param> |
2781 |
<returns>IDeserializer instance</returns> |
2782 |
</member>
|
2783 |
<member name="M:RestSharp.RestClient.BuildUri(RestSharp.IRestRequest)"> |
2784 |
<summary>
|
2785 |
Assembles URL to call based on parameters, method and resource |
2786 |
</summary>
|
2787 |
<param name="request">RestRequest to execute</param> |
2788 |
<returns>Assembled System.Uri</returns> |
2789 |
</member>
|
2790 |
<member name="P:RestSharp.RestClient.MaxRedirects"> |
2791 |
<summary>
|
2792 |
Maximum number of redirects to follow if FollowRedirects is true |
2793 |
</summary>
|
2794 |
</member>
|
2795 |
<member name="P:RestSharp.RestClient.FollowRedirects"> |
2796 |
<summary>
|
2797 |
Default is true. Determine whether or not requests that result in |
2798 |
HTTP status codes of 3xx should follow returned redirect |
2799 |
</summary>
|
2800 |
</member>
|
2801 |
<member name="P:RestSharp.RestClient.CookieContainer"> |
2802 |
<summary>
|
2803 |
The CookieContainer used for requests made by this client instance |
2804 |
</summary>
|
2805 |
</member>
|
2806 |
<member name="P:RestSharp.RestClient.UserAgent"> |
2807 |
<summary>
|
2808 |
UserAgent to use for requests made by this client instance |
2809 |
</summary>
|
2810 |
</member>
|
2811 |
<member name="P:RestSharp.RestClient.Timeout"> |
2812 |
<summary>
|
2813 |
Timeout in milliseconds to use for requests made by this client instance |
2814 |
</summary>
|
2815 |
</member>
|
2816 |
<member name="P:RestSharp.RestClient.ReadWriteTimeout"> |
2817 |
<summary>
|
2818 |
The number of milliseconds before the writing or reading times out. |
2819 |
</summary>
|
2820 |
</member>
|
2821 |
<member name="P:RestSharp.RestClient.UseSynchronizationContext"> |
2822 |
<summary>
|
2823 |
Whether to invoke async callbacks using the SynchronizationContext.Current captured when invoked |
2824 |
</summary>
|
2825 |
</member>
|
2826 |
<member name="P:RestSharp.RestClient.Authenticator"> |
2827 |
<summary>
|
2828 |
Authenticator to use for requests made by this client instance |
2829 |
</summary>
|
2830 |
</member>
|
2831 |
<member name="P:RestSharp.RestClient.BaseUrl"> |
2832 |
<summary>
|
2833 |
Combined with Request.Resource to construct URL for request |
2834 |
Should include scheme and domain without trailing slash. |
2835 |
</summary>
|
2836 |
<example>
|
2837 |
client.BaseUrl = new Uri("http://example.com"); |
2838 |
</example>
|
2839 |
</member>
|
2840 |
<member name="P:RestSharp.RestClient.DefaultParameters"> |
2841 |
<summary>
|
2842 |
Parameters included with every request made with this instance of RestClient |
2843 |
If specified in both client and request, the request wins |
2844 |
</summary>
|
2845 |
</member>
|
2846 |
<member name="M:RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse})"> |
2847 |
<summary>
|
2848 |
Executes the request and callback asynchronously, authenticating if needed |
2849 |
</summary>
|
2850 |
<param name="client">The IRestClient this method extends</param> |
2851 |
<param name="request">Request to be executed</param> |
2852 |
<param name="callback">Callback function to be executed upon completion</param> |
2853 |
</member>
|
2854 |
<member name="M:RestSharp.RestClientExtensions.ExecuteAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0}})"> |
2855 |
<summary>
|
2856 |
Executes the request and callback asynchronously, authenticating if needed |
2857 |
</summary>
|
2858 |
<param name="client">The IRestClient this method extends</param> |
2859 |
<typeparam name="T">Target deserialization type</typeparam> |
2860 |
<param name="request">Request to be executed</param> |
2861 |
<param name="callback">Callback function to be executed upon completion providing access to the async handle</param> |
2862 |
</member>
|
2863 |
<member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,RestSharp.Parameter)"> |
2864 |
<summary>
|
2865 |
Add a parameter to use on every request made with this client instance |
2866 |
</summary>
|
2867 |
<param name="restClient">The IRestClient instance</param> |
2868 |
<param name="p">Parameter to add</param> |
2869 |
<returns></returns> |
2870 |
</member>
|
2871 |
<member name="M:RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient,System.String)"> |
2872 |
<summary>
|
2873 |
Removes a parameter from the default parameters that are used on every request made with this client instance |
2874 |
</summary>
|
2875 |
<param name="restClient">The IRestClient instance</param> |
2876 |
<param name="name">The name of the parameter that needs to be removed</param> |
2877 |
<returns></returns> |
2878 |
</member>
|
2879 |
<member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object)"> |
2880 |
<summary>
|
2881 |
Adds a HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) |
2882 |
Used on every request made by this client instance |
2883 |
</summary>
|
2884 |
<param name="restClient">The IRestClient instance</param> |
2885 |
<param name="name">Name of the parameter</param> |
2886 |
<param name="value">Value of the parameter</param> |
2887 |
<returns>This request</returns> |
2888 |
</member>
|
2889 |
<member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object,RestSharp.ParameterType)"> |
2890 |
<summary>
|
2891 |
Adds a parameter to the request. There are four types of parameters: |
2892 |
- GetOrPost: Either a QueryString value or encoded form value based on method |
2893 |
- HttpHeader: Adds the name/value pair to the HTTP request's Headers collection |
2894 |
- UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} |
2895 |
- RequestBody: Used by AddBody() (not recommended to use directly) |
2896 |
</summary>
|
2897 |
<param name="restClient">The IRestClient instance</param> |
2898 |
<param name="name">Name of the parameter</param> |
2899 |
<param name="value">Value of the parameter</param> |
2900 |
<param name="type">The type of parameter to add</param> |
2901 |
<returns>This request</returns> |
2902 |
</member>
|
2903 |
<member name="M:RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient,System.String,System.String)"> |
2904 |
<summary>
|
2905 |
Shortcut to AddDefaultParameter(name, value, HttpHeader) overload |
2906 |
</summary>
|
2907 |
<param name="restClient">The IRestClient instance</param> |
2908 |
<param name="name">Name of the header to add</param> |
2909 |
<param name="value">Value of the header to add</param> |
2910 |
<returns></returns> |
2911 |
</member>
|
2912 |
<member name="M:RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient,System.String,System.String)"> |
2913 |
<summary>
|
2914 |
Shortcut to AddDefaultParameter(name, value, UrlSegment) overload |
2915 |
</summary>
|
2916 |
<param name="restClient">The IRestClient instance</param> |
2917 |
<param name="name">Name of the segment to add</param> |
2918 |
<param name="value">Value of the segment to add</param> |
2919 |
<returns></returns> |
2920 |
</member>
|
2921 |
<member name="T:RestSharp.RestRequest"> |
2922 |
<summary>
|
2923 |
Container for data used to make requests |
2924 |
</summary>
|
2925 |
</member>
|
2926 |
<member name="M:RestSharp.RestRequest.#ctor"> |
2927 |
<summary>
|
2928 |
Default constructor |
2929 |
</summary>
|
2930 |
</member>
|
2931 |
<member name="M:RestSharp.RestRequest.#ctor(RestSharp.Method)"> |
2932 |
<summary>
|
2933 |
Sets Method property to value of method |
2934 |
</summary>
|
2935 |
<param name="method">Method to use for this request</param> |
2936 |
</member>
|
2937 |
<member name="M:RestSharp.RestRequest.#ctor(System.String)"> |
2938 |
<summary>
|
2939 |
Sets Resource property |
2940 |
</summary>
|
2941 |
<param name="resource">Resource to use for this request</param> |
2942 |
</member>
|
2943 |
<member name="M:RestSharp.RestRequest.#ctor(System.String,RestSharp.Method)"> |
2944 |
<summary>
|
2945 |
Sets Resource and Method properties |
2946 |
</summary>
|
2947 |
<param name="resource">Resource to use for this request</param> |
2948 |
<param name="method">Method to use for this request</param> |
2949 |
</member>
|
2950 |
<member name="M:RestSharp.RestRequest.#ctor(System.Uri)"> |
2951 |
<summary>
|
2952 |
Sets Resource property |
2953 |
</summary>
|
2954 |
<param name="resource">Resource to use for this request</param> |
2955 |
</member>
|
2956 |
<member name="M:RestSharp.RestRequest.#ctor(System.Uri,RestSharp.Method)"> |
2957 |
<summary>
|
2958 |
Sets Resource and Method properties |
2959 |
</summary>
|
2960 |
<param name="resource">Resource to use for this request</param> |
2961 |
<param name="method">Method to use for this request</param> |
2962 |
</member>
|
2963 |
<member name="M:RestSharp.RestRequest.AddFile(System.String,System.String,System.String)"> |
2964 |
<summary>
|
2965 |
Adds a file to the Files collection to be included with a POST or PUT request |
2966 |
(other methods do not support file uploads). |
2967 |
</summary>
|
2968 |
<param name="name">The parameter name to use in the request</param> |
2969 |
<param name="path">Full path to file to upload</param> |
2970 |
<param name="contentType">The MIME type of the file to upload</param> |
2971 |
<returns>This request</returns> |
2972 |
</member>
|
2973 |
<member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String,System.String)"> |
2974 |
<summary>
|
2975 |
Adds the bytes to the Files collection with the specified file name |
2976 |
</summary>
|
2977 |
<param name="name">The parameter name to use in the request</param> |
2978 |
<param name="bytes">The file data</param> |
2979 |
<param name="fileName">The file name to use for the uploaded file</param> |
2980 |
<param name="contentType">The MIME type of the file to upload</param> |
2981 |
<returns>This request</returns> |
2982 |
</member>
|
2983 |
<member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String,System.String)"> |
2984 |
<summary>
|
2985 |
Adds the bytes to the Files collection with the specified file name and content type |
2986 |
</summary>
|
2987 |
<param name="name">The parameter name to use in the request</param> |
2988 |
<param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param> |
2989 |
<param name="fileName">The file name to use for the uploaded file</param> |
2990 |
<param name="contentType">The MIME type of the file to upload</param> |
2991 |
<returns>This request</returns> |
2992 |
</member>
|
2993 |
<member name="M:RestSharp.RestRequest.AddFileBytes(System.String,System.Byte[],System.String,System.String)"> |
2994 |
<summary>
|
2995 |
Add bytes to the Files collection as if it was a file of specific type |
2996 |
</summary>
|
2997 |
<param name="name">A form parameter name</param> |
2998 |
<param name="bytes">The file data</param> |
2999 |
<param name="filename">The file name to use for the uploaded file</param> |
3000 |
<param name="contentType">Specific content type. Es: application/x-gzip </param> |
3001 |
<returns></returns> |
3002 |
</member>
|
3003 |
<member name="M:RestSharp.RestRequest.AddBody(System.Object,System.String)"> |
3004 |
<summary>
|
3005 |
Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer |
3006 |
The default format is XML. Change RequestFormat if you wish to use a different serialization format. |
3007 |
</summary>
|
3008 |
<param name="obj">The object to serialize</param> |
3009 |
<param name="xmlNamespace">The XML namespace to use when serializing</param> |
3010 |
<returns>This request</returns> |
3011 |
</member>
|
3012 |
<member name="M:RestSharp.RestRequest.AddBody(System.Object)"> |
3013 |
<summary>
|
3014 |
Serializes obj to data format specified by RequestFormat and adds it to the request body. |
3015 |
The default format is XML. Change RequestFormat if you wish to use a different serialization format. |
3016 |
</summary>
|
3017 |
<param name="obj">The object to serialize</param> |
3018 |
<returns>This request</returns> |
3019 |
</member>
|
3020 |
<member name="M:RestSharp.RestRequest.AddJsonBody(System.Object)"> |
3021 |
<summary>
|
3022 |
Serializes obj to JSON format and adds it to the request body. |
3023 |
</summary>
|
3024 |
<param name="obj">The object to serialize</param> |
3025 |
<returns>This request</returns> |
3026 |
</member>
|
3027 |
<member name="M:RestSharp.RestRequest.AddXmlBody(System.Object)"> |
3028 |
<summary>
|
3029 |
Serializes obj to XML format and adds it to the request body. |
3030 |
</summary>
|
3031 |
<param name="obj">The object to serialize</param> |
3032 |
<returns>This request</returns> |
3033 |
</member>
|
3034 |
<member name="M:RestSharp.RestRequest.AddXmlBody(System.Object,System.String)"> |
3035 |
<summary>
|
3036 |
Serializes obj to format specified by RequestFormat, but passes xmlNamespace if using the default XmlSerializer |
3037 |
Serializes obj to XML format and passes xmlNamespace then adds it to the request body. |
3038 |
</summary>
|
3039 |
<param name="obj">The object to serialize</param> |
3040 |
<param name="xmlNamespace">The XML namespace to use when serializing</param> |
3041 |
<returns>This request</returns> |
3042 |
</member>
|
3043 |
<member name="M:RestSharp.RestRequest.AddObject(System.Object,System.String[])"> |
3044 |
<summary>
|
3045 |
Calls AddParameter() for all public, readable properties specified in the includedProperties list |
3046 |
</summary>
|
3047 |
<example>
|
3048 |
request.AddObject(product, "ProductId", "Price", ...); |
3049 |
</example>
|
3050 |
<param name="obj">The object with properties to add as parameters</param> |
3051 |
<param name="includedProperties">The names of the properties to include</param> |
3052 |
<returns>This request</returns> |
3053 |
</member>
|
3054 |
<member name="M:RestSharp.RestRequest.AddObject(System.Object)"> |
3055 |
<summary>
|
3056 |
Calls AddParameter() for all public, readable properties of obj |
3057 |
</summary>
|
3058 |
<param name="obj">The object with properties to add as parameters</param> |
3059 |
<returns>This request</returns> |
3060 |
</member>
|
3061 |
<member name="M:RestSharp.RestRequest.AddParameter(RestSharp.Parameter)"> |
3062 |
<summary>
|
3063 |
Add the parameter to the request |
3064 |
</summary>
|
3065 |
<param name="p">Parameter to add</param> |
3066 |
<returns></returns> |
3067 |
</member>
|
3068 |
<member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object)"> |
3069 |
<summary>
|
3070 |
Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) |
3071 |
</summary>
|
3072 |
<param name="name">Name of the parameter</param> |
3073 |
<param name="value">Value of the parameter</param> |
3074 |
<returns>This request</returns> |
3075 |
</member>
|
3076 |
<member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)"> |
3077 |
<summary>
|
3078 |
Adds a parameter to the request. There are four types of parameters: |
3079 |
- GetOrPost: Either a QueryString value or encoded form value based on method |
3080 |
- HttpHeader: Adds the name/value pair to the HTTP request's Headers collection |
3081 |
- UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} |
3082 |
- RequestBody: Used by AddBody() (not recommended to use directly) |
3083 |
</summary>
|
3084 |
<param name="name">Name of the parameter</param> |
3085 |
<param name="value">Value of the parameter</param> |
3086 |
<param name="type">The type of parameter to add</param> |
3087 |
<returns>This request</returns> |
3088 |
</member>
|
3089 |
<member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> |
3090 |
<summary>
|
3091 |
Adds a parameter to the request. There are four types of parameters: |
3092 |
- GetOrPost: Either a QueryString value or encoded form value based on method |
3093 |
- HttpHeader: Adds the name/value pair to the HTTP request's Headers collection |
3094 |
- UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} |
3095 |
- RequestBody: Used by AddBody() (not recommended to use directly) |
3096 |
</summary>
|
3097 |
<param name="name">Name of the parameter</param> |
3098 |
<param name="value">Value of the parameter</param> |
3099 |
<param name="contentType">Content-Type of the parameter</param> |
3100 |
<param name="type">The type of parameter to add</param> |
3101 |
<returns>This request</returns> |
3102 |
</member>
|
3103 |
<member name="M:RestSharp.RestRequest.AddHeader(System.String,System.String)"> |
3104 |
<summary>
|
3105 |
Shortcut to AddParameter(name, value, HttpHeader) overload |
3106 |
</summary>
|
3107 |
<param name="name">Name of the header to add</param> |
3108 |
<param name="value">Value of the header to add</param> |
3109 |
<returns></returns> |
3110 |
</member>
|
3111 |
<member name="M:RestSharp.RestRequest.AddCookie(System.String,System.String)"> |
3112 |
<summary>
|
3113 |
Shortcut to AddParameter(name, value, Cookie) overload |
3114 |
</summary>
|
3115 |
<param name="name">Name of the cookie to add</param> |
3116 |
<param name="value">Value of the cookie to add</param> |
3117 |
<returns></returns> |
3118 |
</member>
|
3119 |
<member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.String)"> |
3120 |
<summary>
|
3121 |
Shortcut to AddParameter(name, value, UrlSegment) overload |
3122 |
</summary>
|
3123 |
<param name="name">Name of the segment to add</param> |
3124 |
<param name="value">Value of the segment to add</param> |
3125 |
<returns></returns> |
3126 |
</member>
|
3127 |
<member name="M:RestSharp.RestRequest.AddQueryParameter(System.String,System.String)"> |
3128 |
<summary>
|
3129 |
Shortcut to AddParameter(name, value, QueryString) overload |
3130 |
</summary>
|
3131 |
<param name="name">Name of the parameter to add</param> |
3132 |
<param name="value">Value of the parameter to add</param> |
3133 |
<returns></returns> |
3134 |
</member>
|
3135 |
<member name="M:RestSharp.RestRequest.IncreaseNumAttempts"> |
3136 |
<summary>
|
3137 |
Internal Method so that RestClient can increase the number of attempts |
3138 |
</summary>
|
3139 |
</member>
|
3140 |
<member name="P:RestSharp.RestRequest.AlwaysMultipartFormData"> |
3141 |
<summary>
|
3142 |
Always send a multipart/form-data request - even when no Files are present. |
3143 |
</summary>
|
3144 |
</member>
|
3145 |
<member name="P:RestSharp.RestRequest.JsonSerializer"> |
3146 |
<summary>
|
3147 |
Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. |
3148 |
By default the included JsonSerializer is used (currently using JSON.NET default serialization). |
3149 |
</summary>
|
3150 |
</member>
|
3151 |
<member name="P:RestSharp.RestRequest.XmlSerializer"> |
3152 |
<summary>
|
3153 |
Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. |
3154 |
By default the included XmlSerializer is used. |
3155 |
</summary>
|
3156 |
</member>
|
3157 |
<member name="P:RestSharp.RestRequest.ResponseWriter"> |
3158 |
<summary>
|
3159 |
Set this to write response to Stream rather than reading into memory. |
3160 |
</summary>
|
3161 |
</member>
|
3162 |
<member name="P:RestSharp.RestRequest.UseDefaultCredentials"> |
3163 |
<summary>
|
3164 |
Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) |
3165 |
will be sent along to the server. The default is false. |
3166 |
</summary>
|
3167 |
</member>
|
3168 |
<member name="P:RestSharp.RestRequest.Parameters"> |
3169 |
<summary>
|
3170 |
Container of all HTTP parameters to be passed with the request. |
3171 |
See AddParameter() for explanation of the types of parameters that can be passed |
3172 |
</summary>
|
3173 |
</member>
|
3174 |
<member name="P:RestSharp.RestRequest.Files"> |
3175 |
<summary>
|
3176 |
Container of all the files to be uploaded with the request. |
3177 |
</summary>
|
3178 |
</member>
|
3179 |
<member name="P:RestSharp.RestRequest.Method"> |
3180 |
<summary>
|
3181 |
Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS |
3182 |
Default is GET |
3183 |
</summary>
|
3184 |
</member>
|
3185 |
<member name="P:RestSharp.RestRequest.Resource"> |
3186 |
<summary>
|
3187 |
The Resource URL to make the request against. |
3188 |
Tokens are substituted with UrlSegment parameters and match by name. |
3189 |
Should not include the scheme or domain. Do not include leading slash. |
3190 |
Combined with RestClient.BaseUrl to assemble final URL: |
3191 |
{BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) |
3192 |
</summary>
|
3193 |
<example>
|
3194 |
// example for url token replacement |
3195 |
request.Resource = "Products/{ProductId}"; |
3196 |
request.AddParameter("ProductId", 123, ParameterType.UrlSegment); |
3197 |
</example>
|
3198 |
</member>
|
3199 |
<member name="P:RestSharp.RestRequest.RequestFormat"> |
3200 |
<summary>
|
3201 |
Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. |
3202 |
By default XmlSerializer is used. |
3203 |
</summary>
|
3204 |
</member>
|
3205 |
<member name="P:RestSharp.RestRequest.RootElement"> |
3206 |
<summary>
|
3207 |
Used by the default deserializers to determine where to start deserializing from. |
3208 |
Can be used to skip container or root elements that do not have corresponding deserialzation targets. |
3209 |
</summary>
|
3210 |
</member>
|
3211 |
<member name="P:RestSharp.RestRequest.OnBeforeDeserialization"> |
3212 |
<summary>
|
3213 |
A function to run prior to deserializing starting (e.g. change settings if error encountered) |
3214 |
</summary>
|
3215 |
</member>
|
3216 |
<member name="P:RestSharp.RestRequest.DateFormat"> |
3217 |
<summary>
|
3218 |
Used by the default deserializers to explicitly set which date format string to use when parsing dates. |
3219 |
</summary>
|
3220 |
</member>
|
3221 |
<member name="P:RestSharp.RestRequest.XmlNamespace"> |
3222 |
<summary>
|
3223 |
Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names. |
3224 |
</summary>
|
3225 |
</member>
|
3226 |
<member name="P:RestSharp.RestRequest.Credentials"> |
3227 |
<summary>
|
3228 |
In general you would not need to set this directly. Used by the NtlmAuthenticator. |
3229 |
</summary>
|
3230 |
</member>
|
3231 |
<member name="P:RestSharp.RestRequest.UserState"> |
3232 |
<summary>
|
3233 |
Gets or sets a user-defined state object that contains information about a request and which can be later |
3234 |
retrieved when the request completes. |
3235 |
</summary>
|
3236 |
</member>
|
3237 |
<member name="P:RestSharp.RestRequest.Timeout"> |
3238 |
<summary>
|
3239 |
Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient. |
3240 |
</summary>
|
3241 |
</member>
|
3242 |
<member name="P:RestSharp.RestRequest.ReadWriteTimeout"> |
3243 |
<summary>
|
3244 |
The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient. |
3245 |
</summary>
|
3246 |
</member>
|
3247 |
<member name="P:RestSharp.RestRequest.Attempts"> |
3248 |
<summary>
|
3249 |
How many attempts were made to send this Request? |
3250 |
</summary>
|
3251 |
<remarks>
|
3252 |
This Number is incremented each time the RestClient sends the request. |
3253 |
Useful when using Asynchronous Execution with Callbacks |
3254 |
</remarks>
|
3255 |
</member>
|
3256 |
<member name="T:RestSharp.RestResponseBase"> |
3257 |
<summary>
|
3258 |
Base class for common properties shared by RestResponse and RestResponse[[T]] |
3259 |
</summary>
|
3260 |
</member>
|
3261 |
<member name="M:RestSharp.RestResponseBase.#ctor"> |
3262 |
<summary>
|
3263 |
Default constructor |
3264 |
</summary>
|
3265 |
</member>
|
3266 |
<member name="M:RestSharp.RestResponseBase.DebuggerDisplay"> |
3267 |
<summary>
|
3268 |
Assists with debugging responses by displaying in the debugger output |
3269 |
</summary>
|
3270 |
<returns></returns> |
3271 |
</member>
|
3272 |
<member name="P:RestSharp.RestResponseBase.Request"> |
3273 |
<summary>
|
3274 |
The RestRequest that was made to get this RestResponse |
3275 |
</summary>
|
3276 |
<remarks>
|
3277 |
Mainly for debugging if ResponseStatus is not OK |
3278 |
</remarks>
|
3279 |
</member>
|
3280 |
<member name="P:RestSharp.RestResponseBase.ContentType"> |
3281 |
<summary>
|
3282 |
MIME content type of response |
3283 |
</summary>
|
3284 |
</member>
|
3285 |
<member name="P:RestSharp.RestResponseBase.ContentLength"> |
3286 |
<summary>
|
3287 |
Length in bytes of the response content |
3288 |
</summary>
|
3289 |
</member>
|
3290 |
<member name="P:RestSharp.RestResponseBase.ContentEncoding"> |
3291 |
<summary>
|
3292 |
Encoding of the response content |
3293 |
</summary>
|
3294 |
</member>
|
3295 |
<member name="P:RestSharp.RestResponseBase.Content"> |
3296 |
<summary>
|
3297 |
String representation of response content |
3298 |
</summary>
|
3299 |
</member>
|
3300 |
<member name="P:RestSharp.RestResponseBase.StatusCode"> |
3301 |
<summary>
|
3302 |
HTTP response status code |
3303 |
</summary>
|
3304 |
</member>
|
3305 |
<member name="P:RestSharp.RestResponseBase.StatusDescription"> |
3306 |
<summary>
|
3307 |
Description of HTTP status returned |
3308 |
</summary>
|
3309 |
</member>
|
3310 |
<member name="P:RestSharp.RestResponseBase.RawBytes"> |
3311 |
<summary>
|
3312 |
Response content |
3313 |
</summary>
|
3314 |
</member>
|
3315 |
<member name="P:RestSharp.RestResponseBase.ResponseUri"> |
3316 |
<summary>
|
3317 |
The URL that actually responded to the content (different from request if redirected) |
3318 |
</summary>
|
3319 |
</member>
|
3320 |
<member name="P:RestSharp.RestResponseBase.Server"> |
3321 |
<summary>
|
3322 |
HttpWebResponse.Server |
3323 |
</summary>
|
3324 |
</member>
|
3325 |
<member name="P:RestSharp.RestResponseBase.Cookies"> |
3326 |
<summary>
|
3327 |
Cookies returned by server with the response |
3328 |
</summary>
|
3329 |
</member>
|
3330 |
<member name="P:RestSharp.RestResponseBase.Headers"> |
3331 |
<summary>
|
3332 |
Headers returned by server with the response |
3333 |
</summary>
|
3334 |
</member>
|
3335 |
<member name="P:RestSharp.RestResponseBase.ResponseStatus"> |
3336 |
<summary>
|
3337 |
Status of the request. Will return Error for transport errors. |
3338 |
HTTP errors will still return ResponseStatus.Completed, check StatusCode instead |
3339 |
</summary>
|
3340 |
</member>
|
3341 |
<member name="P:RestSharp.RestResponseBase.ErrorMessage"> |
3342 |
<summary>
|
3343 |
Transport or other non-HTTP error generated while attempting request |
3344 |
</summary>
|
3345 |
</member>
|
3346 |
<member name="P:RestSharp.RestResponseBase.ErrorException"> |
3347 |
<summary>
|
3348 |
The exception thrown during the request, if any |
3349 |
</summary>
|
3350 |
</member>
|
3351 |
<member name="T:RestSharp.RestResponse`1"> |
3352 |
<summary>
|
3353 |
Container for data sent back from API including deserialized data |
3354 |
</summary>
|
3355 |
<typeparam name="T">Type of data to deserialize to</typeparam> |
3356 |
</member>
|
3357 |
<member name="P:RestSharp.RestResponse`1.Data"> |
3358 |
<summary>
|
3359 |
Deserialized entity data |
3360 |
</summary>
|
3361 |
</member>
|
3362 |
<member name="T:RestSharp.RestResponse"> |
3363 |
<summary>
|
3364 |
Container for data sent back from API |
3365 |
</summary>
|
3366 |
</member>
|
3367 |
<member name="T:RestSharp.Serializers.DotNetXmlSerializer"> |
3368 |
<summary>
|
3369 |
Wrapper for System.Xml.Serialization.XmlSerializer. |
3370 |
</summary>
|
3371 |
</member>
|
3372 |
<member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor"> |
3373 |
<summary>
|
3374 |
Default constructor, does not specify namespace |
3375 |
</summary>
|
3376 |
</member>
|
3377 |
<member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor(System.String)"> |
3378 |
<summary>
|
3379 |
Specify the namespaced to be used when serializing |
3380 |
</summary>
|
3381 |
<param name="namespace">XML namespace</param> |
3382 |
</member>
|
3383 |
<member name="M:RestSharp.Serializers.DotNetXmlSerializer.Serialize(System.Object)"> |
3384 |
<summary>
|
3385 |
Serialize the object as XML |
3386 |
</summary>
|
3387 |
<param name="obj">Object to serialize</param> |
3388 |
<returns>XML as string</returns> |
3389 |
</member>
|
3390 |
<member name="P:RestSharp.Serializers.DotNetXmlSerializer.RootElement"> |
3391 |
<summary>
|
3392 |
Name of the root element to use when serializing |
3393 |
</summary>
|
3394 |
</member>
|
3395 |
<member name="P:RestSharp.Serializers.DotNetXmlSerializer.Namespace"> |
3396 |
<summary>
|
3397 |
XML namespace to use when serializing |
3398 |
</summary>
|
3399 |
</member>
|
3400 |
<member name="P:RestSharp.Serializers.DotNetXmlSerializer.DateFormat"> |
3401 |
<summary>
|
3402 |
Format string to use when serializing dates |
3403 |
</summary>
|
3404 |
</member>
|
3405 |
<member name="P:RestSharp.Serializers.DotNetXmlSerializer.ContentType"> |
3406 |
<summary>
|
3407 |
Content type for serialized content |
3408 |
</summary>
|
3409 |
</member>
|
3410 |
<member name="P:RestSharp.Serializers.DotNetXmlSerializer.Encoding"> |
3411 |
<summary>
|
3412 |
Encoding for serialized content |
3413 |
</summary>
|
3414 |
</member>
|
3415 |
<member name="T:RestSharp.Serializers.DotNetXmlSerializer.EncodingStringWriter"> |
3416 |
<summary>
|
3417 |
Need to subclass StringWriter in order to override Encoding |
3418 |
</summary>
|
3419 |
</member>
|
3420 |
<member name="T:RestSharp.Serializers.JsonSerializer"> |
3421 |
<summary>
|
3422 |
Default JSON serializer for request bodies |
3423 |
Doesn't currently use the SerializeAs attribute, defers to Newtonsoft's attributes |
3424 |
</summary>
|
3425 |
</member>
|
3426 |
<member name="M:RestSharp.Serializers.JsonSerializer.#ctor"> |
3427 |
<summary>
|
3428 |
Default serializer |
3429 |
</summary>
|
3430 |
</member>
|
3431 |
<member name="M:RestSharp.Serializers.JsonSerializer.Serialize(System.Object)"> |
3432 |
<summary>
|
3433 |
Serialize the object as JSON |
3434 |
</summary>
|
3435 |
<param name="obj">Object to serialize</param> |
3436 |
<returns>JSON as String</returns> |
3437 |
</member>
|
3438 |
<member name="P:RestSharp.Serializers.JsonSerializer.DateFormat"> |
3439 |
<summary>
|
3440 |
Unused for JSON Serialization |
3441 |
</summary>
|
3442 |
</member>
|
3443 |
<member name="P:RestSharp.Serializers.JsonSerializer.RootElement"> |
3444 |
<summary>
|
3445 |
Unused for JSON Serialization |
3446 |
</summary>
|
3447 |
</member>
|
3448 |
<member name="P:RestSharp.Serializers.JsonSerializer.Namespace"> |
3449 |
<summary>
|
3450 |
Unused for JSON Serialization |
3451 |
</summary>
|
3452 |
</member>
|
3453 |
<member name="P:RestSharp.Serializers.JsonSerializer.ContentType"> |
3454 |
<summary>
|
3455 |
Content type for serialized content |
3456 |
</summary>
|
3457 |
</member>
|
3458 |
<member name="T:RestSharp.Serializers.SerializeAsAttribute"> |
3459 |
<summary>
|
3460 |
Allows control how class and property names and values are serialized by XmlSerializer |
3461 |
Currently not supported with the JsonSerializer |
3462 |
When specified at the property level the class-level specification is overridden |
3463 |
</summary>
|
3464 |
</member>
|
3465 |
<member name="M:RestSharp.Serializers.SerializeAsAttribute.TransformName(System.String)"> |
3466 |
<summary>
|
3467 |
Called by the attribute when NameStyle is speficied |
3468 |
</summary>
|
3469 |
<param name="input">The string to transform</param> |
3470 |
<returns>String</returns> |
3471 |
</member>
|
3472 |
<member name="P:RestSharp.Serializers.SerializeAsAttribute.Name"> |
3473 |
<summary>
|
3474 |
The name to use for the serialized element |
3475 |
</summary>
|
3476 |
</member>
|
3477 |
<member name="P:RestSharp.Serializers.SerializeAsAttribute.Attribute"> |
3478 |
<summary>
|
3479 |
Sets the value to be serialized as an Attribute instead of an Element |
3480 |
</summary>
|
3481 |
</member>
|
3482 |
<member name="P:RestSharp.Serializers.SerializeAsAttribute.Culture"> |
3483 |
<summary>
|
3484 |
The culture to use when serializing |
3485 |
</summary>
|
3486 |
</member>
|
3487 |
<member name="P:RestSharp.Serializers.SerializeAsAttribute.NameStyle"> |
3488 |
<summary>
|
3489 |
Transforms the casing of the name based on the selected value. |
3490 |
</summary>
|
3491 |
</member>
|
3492 |
<member name="P:RestSharp.Serializers.SerializeAsAttribute.Index"> |
3493 |
<summary>
|
3494 |
The order to serialize the element. Default is int.MaxValue. |
3495 |
</summary>
|
3496 |
</member>
|
3497 |
<member name="T:RestSharp.Serializers.NameStyle"> |
3498 |
<summary>
|
3499 |
Options for transforming casing of element names |
3500 |
</summary>
|
3501 |
</member>
|
3502 |
<member name="T:RestSharp.Serializers.XmlSerializer"> |
3503 |
<summary>
|
3504 |
Default XML Serializer |
3505 |
</summary>
|
3506 |
</member>
|
3507 |
<member name="M:RestSharp.Serializers.XmlSerializer.#ctor"> |
3508 |
<summary>
|
3509 |
Default constructor, does not specify namespace |
3510 |
</summary>
|
3511 |
</member>
|
3512 |
<member name="M:RestSharp.Serializers.XmlSerializer.#ctor(System.String)"> |
3513 |
<summary>
|
3514 |
Specify the namespaced to be used when serializing |
3515 |
</summary>
|
3516 |
<param name="namespace">XML namespace</param> |
3517 |
</member>
|
3518 |
<member name="M:RestSharp.Serializers.XmlSerializer.Serialize(System.Object)"> |
3519 |
<summary>
|
3520 |
Serialize the object as XML |
3521 |
</summary>
|
3522 |
<param name="obj">Object to serialize</param> |
3523 |
<returns>XML as string</returns> |
3524 |
</member>
|
3525 |
<member name="M:RestSharp.Serializers.XmlSerializer.IsNumeric(System.Object)"> |
3526 |
<summary>
|
3527 |
Determines if a given object is numeric in any way |
3528 |
(can be integer, double, null, etc). |
3529 |
</summary>
|
3530 |
</member>
|
3531 |
<member name="P:RestSharp.Serializers.XmlSerializer.RootElement"> |
3532 |
<summary>
|
3533 |
Name of the root element to use when serializing |
3534 |
</summary>
|
3535 |
</member>
|
3536 |
<member name="P:RestSharp.Serializers.XmlSerializer.Namespace"> |
3537 |
<summary>
|
3538 |
XML namespace to use when serializing |
3539 |
</summary>
|
3540 |
</member>
|
3541 |
<member name="P:RestSharp.Serializers.XmlSerializer.DateFormat"> |
3542 |
<summary>
|
3543 |
Format string to use when serializing dates |
3544 |
</summary>
|
3545 |
</member>
|
3546 |
<member name="P:RestSharp.Serializers.XmlSerializer.ContentType"> |
3547 |
<summary>
|
3548 |
Content type for serialized content |
3549 |
</summary>
|
3550 |
</member>
|
3551 |
<member name="T:RestSharp.JsonArray"> |
3552 |
<summary>
|
3553 |
Represents the json array. |
3554 |
</summary>
|
3555 |
</member>
|
3556 |
<member name="M:RestSharp.JsonArray.#ctor"> |
3557 |
<summary>
|
3558 |
Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class. |
3559 |
</summary>
|
3560 |
</member>
|
3561 |
<member name="M:RestSharp.JsonArray.#ctor(System.Int32)"> |
3562 |
<summary>
|
3563 |
Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class. |
3564 |
</summary>
|
3565 |
<param name="capacity">The capacity of the json array.</param> |
3566 |
</member>
|
3567 |
<member name="M:RestSharp.JsonArray.ToString"> |
3568 |
<summary>
|
3569 |
The json representation of the array. |
3570 |
</summary>
|
3571 |
<returns>The json representation of the array.</returns> |
3572 |
</member>
|
3573 |
<member name="T:RestSharp.JsonObject"> |
3574 |
<summary>
|
3575 |
Represents the json object. |
3576 |
</summary>
|
3577 |
</member>
|
3578 |
<member name="F:RestSharp.JsonObject._members"> |
3579 |
<summary>
|
3580 |
The internal member dictionary. |
3581 |
</summary>
|
3582 |
</member>
|
3583 |
<member name="M:RestSharp.JsonObject.#ctor"> |
3584 |
<summary>
|
3585 |
Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>. |
3586 |
</summary>
|
3587 |
</member>
|
3588 |
<member name="M:RestSharp.JsonObject.#ctor(System.Collections.Generic.IEqualityComparer{System.String})"> |
3589 |
<summary>
|
3590 |
Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>. |
3591 |
</summary>
|
3592 |
<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> |
3593 |
</member>
|
3594 |
<member name="M:RestSharp.JsonObject.Add(System.String,System.Object)"> |
3595 |
<summary>
|
3596 |
Adds the specified key. |
3597 |
</summary>
|
3598 |
<param name="key">The key.</param> |
3599 |
<param name="value">The value.</param> |
3600 |
</member>
|
3601 |
<member name="M:RestSharp.JsonObject.ContainsKey(System.String)"> |
3602 |
<summary>
|
3603 |
Determines whether the specified key contains key. |
3604 |
</summary>
|
3605 |
<param name="key">The key.</param> |
3606 |
<returns>
|
3607 |
<c>true</c> if the specified key contains key; otherwise, <c>false</c>. |
3608 |
</returns>
|
3609 |
</member>
|
3610 |
<member name="M:RestSharp.JsonObject.Remove(System.String)"> |
3611 |
<summary>
|
3612 |
Removes the specified key. |
3613 |
</summary>
|
3614 |
<param name="key">The key.</param> |
3615 |
<returns></returns> |
3616 |
</member>
|
3617 |
<member name="M:RestSharp.JsonObject.TryGetValue(System.String,System.Object@)"> |
3618 |
<summary>
|
3619 |
Tries the get value. |
3620 |
</summary>
|
3621 |
<param name="key">The key.</param> |
3622 |
<param name="value">The value.</param> |
3623 |
<returns></returns> |
3624 |
</member>
|
3625 |
<member name="M:RestSharp.JsonObject.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> |
3626 |
<summary>
|
3627 |
Adds the specified item. |
3628 |
</summary>
|
3629 |
<param name="item">The item.</param> |
3630 |
</member>
|
3631 |
<member name="M:RestSharp.JsonObject.Clear"> |
3632 |
<summary>
|
3633 |
Clears this instance. |
3634 |
</summary>
|
3635 |
</member>
|
3636 |
<member name="M:RestSharp.JsonObject.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> |
3637 |
<summary>
|
3638 |
Determines whether [contains] [the specified item]. |
3639 |
</summary>
|
3640 |
<param name="item">The item.</param> |
3641 |
<returns>
|
3642 |
<c>true</c> if [contains] [the specified item]; otherwise, <c>false</c>. |
3643 |
</returns>
|
3644 |
</member>
|
3645 |
<member name="M:RestSharp.JsonObject.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)"> |
3646 |
<summary>
|
3647 |
Copies to. |
3648 |
</summary>
|
3649 |
<param name="array">The array.</param> |
3650 |
<param name="arrayIndex">Index of the array.</param> |
3651 |
</member>
|
3652 |
<member name="M:RestSharp.JsonObject.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> |
3653 |
<summary>
|
3654 |
Removes the specified item. |
3655 |
</summary>
|
3656 |
<param name="item">The item.</param> |
3657 |
<returns></returns> |
3658 |
</member>
|
3659 |
<member name="M:RestSharp.JsonObject.GetEnumerator"> |
3660 |
<summary>
|
3661 |
Gets the enumerator. |
3662 |
</summary>
|
3663 |
<returns></returns> |
3664 |
</member>
|
3665 |
<member name="M:RestSharp.JsonObject.System#Collections#IEnumerable#GetEnumerator"> |
3666 |
<summary>
|
3667 |
Returns an enumerator that iterates through a collection. |
3668 |
</summary>
|
3669 |
<returns>
|
3670 |
An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. |
3671 |
</returns>
|
3672 |
</member>
|
3673 |
<member name="M:RestSharp.JsonObject.ToString"> |
3674 |
<summary>
|
3675 |
Returns a json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. |
3676 |
</summary>
|
3677 |
<returns>
|
3678 |
A json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. |
3679 |
</returns>
|
3680 |
</member>
|
3681 |
<member name="P:RestSharp.JsonObject.Item(System.Int32)"> |
3682 |
<summary>
|
3683 |
Gets the <see cref="T:System.Object"/> at the specified index. |
3684 |
</summary>
|
3685 |
<value></value> |
3686 |
</member>
|
3687 |
<member name="P:RestSharp.JsonObject.Keys"> |
3688 |
<summary>
|
3689 |
Gets the keys. |
3690 |
</summary>
|
3691 |
<value>The keys.</value> |
3692 |
</member>
|
3693 |
<member name="P:RestSharp.JsonObject.Values"> |
3694 |
<summary>
|
3695 |
Gets the values. |
3696 |
</summary>
|
3697 |
<value>The values.</value> |
3698 |
</member>
|
3699 |
<member name="P:RestSharp.JsonObject.Item(System.String)"> |
3700 |
<summary>
|
3701 |
Gets or sets the <see cref="T:System.Object"/> with the specified key. |
3702 |
</summary>
|
3703 |
<value></value> |
3704 |
</member>
|
3705 |
<member name="P:RestSharp.JsonObject.Count"> |
3706 |
<summary>
|
3707 |
Gets the count. |
3708 |
</summary>
|
3709 |
<value>The count.</value> |
3710 |
</member>
|
3711 |
<member name="P:RestSharp.JsonObject.IsReadOnly"> |
3712 |
<summary>
|
3713 |
Gets a value indicating whether this instance is read only. |
3714 |
</summary>
|
3715 |
<value>
|
3716 |
<c>true</c> if this instance is read only; otherwise, <c>false</c>. |
3717 |
</value>
|
3718 |
</member>
|
3719 |
<member name="T:RestSharp.SimpleJson"> |
3720 |
<summary>
|
3721 |
This class encodes and decodes JSON strings. |
3722 |
Spec. details, see http://www.json.org/ |
3723 |
|
3724 |
JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). |
3725 |
All numbers are parsed to doubles. |
3726 |
</summary>
|
3727 |
</member>
|
3728 |
<member name="M:RestSharp.SimpleJson.DeserializeObject(System.String)"> |
3729 |
<summary>
|
3730 |
Parses the string json into a value |
3731 |
</summary>
|
3732 |
<param name="json">A JSON string.</param> |
3733 |
<returns>An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false</returns> |
3734 |
</member>
|
3735 |
<member name="M:RestSharp.SimpleJson.TryDeserializeObject(System.String,System.Object@)"> |
3736 |
<summary>
|
3737 |
Try parsing the json string into a value. |
3738 |
</summary>
|
3739 |
<param name="json"> |
3740 |
A JSON string. |
3741 |
</param>
|
3742 |
<param name="obj"> |
3743 |
The object. |
3744 |
</param>
|
3745 |
<returns>
|
3746 |
Returns true if successfull otherwise false. |
3747 |
</returns>
|
3748 |
</member>
|
3749 |
<member name="M:RestSharp.SimpleJson.SerializeObject(System.Object,RestSharp.IJsonSerializerStrategy)"> |
3750 |
<summary>
|
3751 |
Converts a IDictionary<string,object> / IList<object> object into a JSON string |
3752 |
</summary>
|
3753 |
<param name="json">A IDictionary<string,object> / IList<object></param> |
3754 |
<param name="jsonSerializerStrategy">Serializer strategy to use</param> |
3755 |
<returns>A JSON encoded string, or null if object 'json' is not serializable</returns> |
3756 |
</member>
|
3757 |
<member name="M:RestSharp.SimpleJson.IsNumeric(System.Object)"> |
3758 |
<summary>
|
3759 |
Determines if a given object is numeric in any way |
3760 |
(can be integer, double, null, etc). |
3761 |
</summary>
|
3762 |
</member>
|
3763 |
<member name="T:RestSharp.Validation.Require"> |
3764 |
<summary>
|
3765 |
Helper methods for validating required values |
3766 |
</summary>
|
3767 |
</member>
|
3768 |
<member name="M:RestSharp.Validation.Require.Argument(System.String,System.Object)"> |
3769 |
<summary>
|
3770 |
Require a parameter to not be null |
3771 |
</summary>
|
3772 |
<param name="argumentName">Name of the parameter</param> |
3773 |
<param name="argumentValue">Value of the parameter</param> |
3774 |
</member>
|
3775 |
<member name="T:RestSharp.Validation.Validate"> |
3776 |
<summary>
|
3777 |
Helper methods for validating values |
3778 |
</summary>
|
3779 |
</member>
|
3780 |
<member name="M:RestSharp.Validation.Validate.IsBetween(System.Int32,System.Int32,System.Int32)"> |
3781 |
<summary>
|
3782 |
Validate an integer value is between the specified values (exclusive of min/max) |
3783 |
</summary>
|
3784 |
<param name="value">Value to validate</param> |
3785 |
<param name="min">Exclusive minimum value</param> |
3786 |
<param name="max">Exclusive maximum value</param> |
3787 |
</member>
|
3788 |
<member name="M:RestSharp.Validation.Validate.IsValidLength(System.String,System.Int32)"> |
3789 |
<summary>
|
3790 |
Validate a string length |
3791 |
</summary>
|
3792 |
<param name="value">String to be validated</param> |
3793 |
<param name="maxSize">Maximum length of the string</param> |
3794 |
</member>
|
3795 |
<member name="P:RestSharp.RestResponseCookie.Comment"> |
3796 |
<summary>
|
3797 |
Comment of the cookie |
3798 |
</summary>
|
3799 |
</member>
|
3800 |
<member name="P:RestSharp.RestResponseCookie.CommentUri"> |
3801 |
<summary>
|
3802 |
Comment of the cookie |
3803 |
</summary>
|
3804 |
</member>
|
3805 |
<member name="P:RestSharp.RestResponseCookie.Discard"> |
3806 |
<summary>
|
3807 |
Indicates whether the cookie should be discarded at the end of the session |
3808 |
</summary>
|
3809 |
</member>
|
3810 |
<member name="P:RestSharp.RestResponseCookie.Domain"> |
3811 |
<summary>
|
3812 |
Domain of the cookie |
3813 |
</summary>
|
3814 |
</member>
|
3815 |
<member name="P:RestSharp.RestResponseCookie.Expired"> |
3816 |
<summary>
|
3817 |
Indicates whether the cookie is expired |
3818 |
</summary>
|
3819 |
</member>
|
3820 |
<member name="P:RestSharp.RestResponseCookie.Expires"> |
3821 |
<summary>
|
3822 |
Date and time that the cookie expires |
3823 |
</summary>
|
3824 |
</member>
|
3825 |
<member name="P:RestSharp.RestResponseCookie.HttpOnly"> |
3826 |
<summary>
|
3827 |
Indicates that this cookie should only be accessed by the server |
3828 |
</summary>
|
3829 |
</member>
|
3830 |
<member name="P:RestSharp.RestResponseCookie.Name"> |
3831 |
<summary>
|
3832 |
Name of the cookie |
3833 |
</summary>
|
3834 |
</member>
|
3835 |
<member name="P:RestSharp.RestResponseCookie.Path"> |
3836 |
<summary>
|
3837 |
Path of the cookie |
3838 |
</summary>
|
3839 |
</member>
|
3840 |
<member name="P:RestSharp.RestResponseCookie.Port"> |
3841 |
<summary>
|
3842 |
Port of the cookie |
3843 |
</summary>
|
3844 |
</member>
|
3845 |
<member name="P:RestSharp.RestResponseCookie.Secure"> |
3846 |
<summary>
|
3847 |
Indicates that the cookie should only be sent over secure channels |
3848 |
</summary>
|
3849 |
</member>
|
3850 |
<member name="P:RestSharp.RestResponseCookie.TimeStamp"> |
3851 |
<summary>
|
3852 |
Date and time the cookie was created |
3853 |
</summary>
|
3854 |
</member>
|
3855 |
<member name="P:RestSharp.RestResponseCookie.Value"> |
3856 |
<summary>
|
3857 |
Value of the cookie |
3858 |
</summary>
|
3859 |
</member>
|
3860 |
<member name="P:RestSharp.RestResponseCookie.Version"> |
3861 |
<summary>
|
3862 |
Version of the cookie |
3863 |
</summary>
|
3864 |
</member>
|
3865 |
</members>
|
3866 |
</doc>
|