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