RestSharp.xml
|
<?xml version="1.0"?> <doc> <assembly> <name>RestSharp</name> </assembly> <members> <member name="T:RestSharp.Authenticators.HttpBasicAuthenticator"> <summary> Allows "basic access authentication" for HTTP requests. </summary> <remarks> Encoding can be specified depending on what your server expect (see https://stackoverflow.com/a/7243567). UTF-8 is used by default but some servers might expect ISO-8859-1 encoding. </remarks> </member> <member name="T:RestSharp.Authenticators.JwtAuthenticator"> <summary> JSON WEB TOKEN (JWT) Authenticator class. <remarks>https://tools.ietf.org/html/draft-ietf-oauth-json-web-token</remarks> </summary> </member> <member name="M:RestSharp.Authenticators.JwtAuthenticator.SetBearerToken(System.String)"> <summary> Set the new bearer token so the request gets the new header value </summary> <param name="accessToken"></param> </member> <member name="T:RestSharp.Authenticators.NtlmAuthenticator"> <summary> Tries to Authenticate with the credentials of the currently logged in user, or impersonate a user </summary> </member> <member name="M:RestSharp.Authenticators.NtlmAuthenticator.#ctor"> <summary> Authenticate with the credentials of the currently logged in user </summary> </member> <member name="M:RestSharp.Authenticators.NtlmAuthenticator.#ctor(System.String,System.String)"> <summary> Authenticate by impersonation </summary> <param name="username"></param> <param name="password"></param> </member> <member name="M:RestSharp.Authenticators.NtlmAuthenticator.#ctor(System.Net.ICredentials)"> <summary> Authenticate by impersonation, using an existing <c>ICredentials</c> instance </summary> <param name="credentials"></param> </member> <member name="F:RestSharp.Authenticators.OAuth.OAuthTools.Encoding"> <summary> All text parameters are UTF-8 encoded (per section 5.1). </summary> </member> <member name="F:RestSharp.Authenticators.OAuth.OAuthTools.UriRfc3986CharsToEscape"> <summary> The set of characters that are unreserved in RFC 2396 but are NOT unreserved in RFC 3986. </summary> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetNonce"> <summary> Generates a random 16-byte lowercase alphanumeric string. </summary> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp"> <summary> Generates a timestamp based on the current elapsed seconds since '01/01/1970 0000 GMT" </summary> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetTimestamp(System.DateTime)"> <summary> Generates a timestamp based on the elapsed seconds of a given time since '01/01/1970 0000 GMT" </summary> <param name="dateTime">A specified point in time.</param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeRelaxed(System.String)"> <summary> URL encodes a string based on section 5.1 of the OAuth spec. Namely, percent encoding with [RFC3986], avoiding unreserved characters, upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. </summary> <param name="value">The value to escape.</param> <returns>The escaped value.</returns> <remarks> The <see cref="M:System.Uri.EscapeDataString(System.String)" /> method is <i>supposed</i> to take on RFC 3986 behavior if certain elements are present in a .config file. Even if this actually worked (which in my experiments it <i>doesn't</i>), we can't rely on every host actually having this configuration element present. </remarks> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.UrlEncodeStrict(System.String)"> <summary> URL encodes a string based on section 5.1 of the OAuth spec. Namely, percent encoding with [RFC3986], avoiding unreserved characters, upper-casing hexadecimal characters, and UTF-8 encoding for text value pairs. </summary> <param name="value"></param> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.NormalizeRequestParameters(RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Sorts a collection of key-value pairs by name, and then value if equal, concatenating them into a single string. This string should be encoded prior to, or after normalization is run. </summary> <param name="parameters"></param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.SortParametersExcludingSignature(RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Sorts a <see cref="T:RestSharp.Authenticators.OAuth.WebPairCollection" /> by name, and then value if equal. </summary> <param name="parameters">A collection of parameters to sort</param> <returns>A sorted parameter collection</returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConstructRequestUrl(System.Uri)"> <summary> Creates a request URL suitable for making OAuth requests. Resulting URLs must exclude port 80 or port 443 when accompanied by HTTP and HTTPS, respectively. Resulting URLs must be lower case. </summary> <param name="url">The original request URL</param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.ConcatenateRequestElements(System.String,System.String,RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Creates a request elements concatenation value to send with a request. This is also known as the signature base. </summary> <param name="method">The request HTTP method type</param> <param name="url">The request URL</param> <param name="parameters">The request parameters</param> <returns>A signature base string</returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,System.String,System.String)"> <summary> Creates a signature value given a signature base and the consumer secret. This method is used when the token secret is currently unknown. </summary> <param name="signatureMethod">The hashing method</param> <param name="signatureBase">The signature base</param> <param name="consumerSecret">The consumer key</param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String)"> <summary> Creates a signature value given a signature base and the consumer secret. This method is used when the token secret is currently unknown. </summary> <param name="signatureMethod">The hashing method</param> <param name="signatureTreatment">The treatment to use on a signature value</param> <param name="signatureBase">The signature base</param> <param name="consumerSecret">The consumer key</param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthTools.GetSignature(RestSharp.Authenticators.OAuth.OAuthSignatureMethod,RestSharp.Authenticators.OAuth.OAuthSignatureTreatment,System.String,System.String,System.String)"> <summary> Creates a signature value given a signature base and the consumer secret and a known token secret. </summary> <param name="signatureMethod">The hashing method</param> <param name="signatureTreatment">The treatment to use on a signature value</param> <param name="signatureBase">The signature base</param> <param name="consumerSecret">The consumer secret</param> <param name="tokenSecret">The token secret</param> <returns></returns> </member> <member name="T:RestSharp.Authenticators.OAuth.OAuthWorkflow"> <summary> A class to encapsulate OAuth authentication flow. </summary> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildRequestTokenInfo(System.String,RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Generates an OAuth signature to pass to an <see cref="T:RestSharp.Authenticators.IAuthenticator" /> for the purpose of requesting an unauthorized request token. </summary> <param name="method">The HTTP method for the intended request</param> <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildAccessTokenSignature(System.String,RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Generates an OAuth signature to pass to the <see cref="T:RestSharp.Authenticators.IAuthenticator" /> for the purpose of exchanging a request token for an access token authorized by the user at the Service Provider site. </summary> <param name="method">The HTTP method for the intended request</param> <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> </member> <member name="M:RestSharp.Authenticators.OAuth.OAuthWorkflow.BuildClientAuthAccessTokenSignature(System.String,RestSharp.Authenticators.OAuth.WebPairCollection)"> <summary> Generates an OAuth signature to pass to an <see cref="T:RestSharp.Authenticators.IAuthenticator" /> for the purpose of exchanging user credentials for an access token authorized by the user at the Service Provider site. </summary> <param name="method">The HTTP method for the intended request</param> <param name="parameters">Any existing, non-OAuth query parameters desired in the request</param> </member> <member name="T:RestSharp.Authenticators.OAuth1Authenticator"> <seealso href="http://tools.ietf.org/html/rfc5849">RFC: The OAuth 1.0 Protocol</seealso> </member> <member name="M:RestSharp.Authenticators.OAuth1Authenticator.ForAccessTokenRefresh(System.String,System.String,System.String,System.String,System.String)"> <summary> </summary> <param name="consumerKey"></param> <param name="consumerSecret"></param> <param name="token"></param> <param name="tokenSecret"></param> <param name="sessionHandle"></param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth1Authenticator.ForAccessTokenRefresh(System.String,System.String,System.String,System.String,System.String,System.String)"> <summary> </summary> <param name="consumerKey"></param> <param name="consumerSecret"></param> <param name="token"></param> <param name="tokenSecret"></param> <param name="verifier"></param> <param name="sessionHandle"></param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth1Authenticator.ForClientAuthentication(System.String,System.String,System.String,System.String,RestSharp.Authenticators.OAuth.OAuthSignatureMethod)"> <summary> </summary> <param name="consumerKey"></param> <param name="consumerSecret"></param> <param name="username"></param> <param name="password"></param> <param name="signatureMethod"></param> <returns></returns> </member> <member name="M:RestSharp.Authenticators.OAuth1Authenticator.ForProtectedResource(System.String,System.String,System.String,System.String,RestSharp.Authenticators.OAuth.OAuthSignatureMethod)"> <summary> </summary> <param name="consumerKey"></param> <param name="consumerSecret"></param> <param name="accessToken"></param> <param name="accessTokenSecret"></param> <param name="signatureMethod"></param> <returns></returns> </member> <member name="T:RestSharp.Authenticators.OAuth2Authenticator"> <summary> Base class for OAuth 2 Authenticators. </summary> <remarks> Since there are many ways to authenticate in OAuth2, this is used as a base class to differentiate between other authenticators. Any other OAuth2 authenticators must derive from this abstract class. </remarks> </member> <member name="M:RestSharp.Authenticators.OAuth2Authenticator.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2Authenticator" /> class. </summary> <param name="accessToken"> The access token. </param> </member> <member name="P:RestSharp.Authenticators.OAuth2Authenticator.AccessToken"> <summary> Gets the access token. </summary> </member> <member name="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator"> <summary> The OAuth 2 authenticator using the authorization request header field. </summary> <remarks> Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.1 </remarks> </member> <member name="M:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator" /> class. </summary> <param name="accessToken"> The access token. </param> </member> <member name="M:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2AuthorizationRequestHeaderAuthenticator" /> class. </summary> <param name="accessToken"> The access token. </param> <param name="tokenType"> The token type. </param> </member> <member name="T:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator"> <summary> The OAuth 2 authenticator using URI query parameter. </summary> <remarks> Based on http://tools.ietf.org/html/draft-ietf-oauth-v2-10#section-5.1.2 </remarks> </member> <member name="M:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:RestSharp.Authenticators.OAuth2UriQueryParameterAuthenticator" /> class. </summary> <param name="accessToken"> The access token. </param> </member> <member name="T:RestSharp.ParameterType"> <summary> Types of parameters that can be added to requests </summary> </member> <member name="F:RestSharp.ParameterType.Cookie"> <summary> Cookie parameter </summary> </member> <member name="T:RestSharp.DataFormat"> <summary> Data formats </summary> </member> <member name="T:RestSharp.Method"> <summary> HTTP method to use when making requests </summary> </member> <member name="T:RestSharp.DateFormat"> <summary> Format strings for commonly-used date formats </summary> </member> <member name="F:RestSharp.DateFormat.ISO_8601"> <summary> .NET format string for ISO 8601 date format </summary> </member> <member name="F:RestSharp.DateFormat.ROUND_TRIP"> <summary> .NET format string for roundtrip date format </summary> </member> <member name="T:RestSharp.ResponseStatus"> <summary> Status for responses (surprised?) </summary> </member> <member name="T:RestSharp.Extensions.MiscExtensions"> <summary> Extension method overload! </summary> </member> <member name="M:RestSharp.Extensions.MiscExtensions.SaveAs(System.Byte[],System.String)"> <summary> Save a byte array to a file </summary> <param name="input">Bytes to save</param> <param name="path">Full path to save file to</param> </member> <member name="M:RestSharp.Extensions.MiscExtensions.ReadAsBytes(System.IO.Stream)"> <summary> Read a stream into a byte array </summary> <param name="input">Stream to read</param> <returns>byte[]</returns> </member> <member name="M:RestSharp.Extensions.MiscExtensions.CopyTo(System.IO.Stream,System.IO.Stream)"> <summary> Copies bytes from one stream to another </summary> <param name="input">The input stream.</param> <param name="output">The output stream.</param> </member> <member name="T:RestSharp.Extensions.ReflectionExtensions"> <summary> Reflection extensions </summary> </member> <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Reflection.MemberInfo)"> <summary> Retrieve an attribute from a member (property) </summary> <typeparam name="T">Type of attribute to retrieve</typeparam> <param name="prop">Member to retrieve attribute from</param> <returns></returns> </member> <member name="M:RestSharp.Extensions.ReflectionExtensions.GetAttribute``1(System.Type)"> <summary> Retrieve an attribute from a type </summary> <typeparam name="T">Type of attribute to retrieve</typeparam> <param name="type">Type to retrieve attribute from</param> <returns></returns> </member> <member name="M:RestSharp.Extensions.ReflectionExtensions.IsSubclassOfRawGeneric(System.Type,System.Type)"> <summary> Checks a type to see if it derives from a raw generic (e.g. List[[]]) </summary> <param name="toCheck"></param> <param name="generic"></param> <returns></returns> </member> <member name="M:RestSharp.Extensions.ReflectionExtensions.FindEnumValue(System.Type,System.String,System.Globalization.CultureInfo)"> <summary> Find a value from a System.Enum by trying several possible variants of the string value of the enum. </summary> <param name="type">Type of enum</param> <param name="value">Value for which to search</param> <param name="culture">The culture used to calculate the name variants</param> <returns></returns> </member> <member name="M:RestSharp.Extensions.ResponseStatusExtensions.ToWebException(RestSharp.ResponseStatus)"> <summary> Convert a <see cref="T:RestSharp.ResponseStatus" /> to a <see cref="T:System.Net.WebException" /> instance. </summary> <param name="responseStatus">The response status.</param> <returns></returns> <exception cref="T:System.ArgumentOutOfRangeException">responseStatus</exception> </member> <member name="M:RestSharp.Extensions.RSACryptoServiceProviderExtensions.FromXmlString2(System.Security.Cryptography.RSACryptoServiceProvider,System.String)"> <summary> Imports the specified XML String into the crypto service provider </summary> <remarks> .NET Core 2.0 doesn't provide an implementation of RSACryptoServiceProvider.FromXmlString/ToXmlString, so we have to do it ourselves. Source: https://gist.github.com/Jargon64/5b172c452827e15b21882f1d76a94be4/ </remarks> </member> <member name="M:RestSharp.Extensions.StringEncodingExtensions.AsString(System.Byte[],System.String)"> <summary> Converts a byte array to a string, using its byte order mark to convert it to the right encoding. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx </summary> <param name="buffer">An array of bytes to convert</param> <param name="encoding">Content encoding. Will fallback to UTF8 if not a valid encoding.</param> <returns>The byte as a string.</returns> </member> <member name="M:RestSharp.Extensions.StringEncodingExtensions.AsString(System.Byte[])"> <summary> Converts a byte array to a string, using its byte order mark to convert it to the right encoding. http://www.shrinkrays.net/code-snippets/csharp/an-extension-method-for-converting-a-byte-array-to-a-string.aspx </summary> <param name="buffer">An array of bytes to convert</param> <returns>The byte as a string using UTF8.</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.UrlEncode(System.String)"> <summary> Uses Uri.EscapeDataString() based on recommendations on MSDN http://blogs.msdn.com/b/yangxind/archive/2006/11/09/don-t-use-net-system-uri-unescapedatastring-in-url-decoding.aspx </summary> </member> <member name="M:RestSharp.Extensions.StringExtensions.HasValue(System.String)"> <summary> Check that a string is not null or empty </summary> <param name="input">String to check</param> <returns>bool</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.RemoveUnderscoresAndDashes(System.String)"> <summary> Remove underscores from a string </summary> <param name="input">String to process</param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.ParseJsonDate(System.String,System.Globalization.CultureInfo)"> <summary> Parses most common JSON date formats </summary> <param name="input">JSON value to parse</param> <param name="culture"></param> <returns>DateTime</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Globalization.CultureInfo)"> <summary> Converts a string to pascal case </summary> <param name="lowercaseAndUnderscoredWord">String to convert</param> <param name="culture"></param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.ToPascalCase(System.String,System.Boolean,System.Globalization.CultureInfo)"> <summary> Converts a string to pascal case with the option to remove underscores </summary> <param name="text">String to convert</param> <param name="removeUnderscores">Option to remove underscores</param> <param name="culture"></param> <returns></returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.ToCamelCase(System.String,System.Globalization.CultureInfo)"> <summary> Converts a string to camel case </summary> <param name="lowercaseAndUnderscoredWord">String to convert</param> <param name="culture"></param> <returns>String</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.MakeInitialLowerCase(System.String,System.Globalization.CultureInfo)"> <summary> Convert the first letter of a string to lower case </summary> <param name="word">String to convert</param> <param name="culture"></param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscores(System.String)"> <summary> Add underscores to a pascal-cased string </summary> <param name="pascalCasedWord">String to convert</param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.AddDashes(System.String)"> <summary> Add dashes to a pascal-cased string </summary> <param name="pascalCasedWord">String to convert</param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.IsUpperCase(System.String)"> <summary> Checks to see if a string is all uppper case </summary> <param name="inputString">String to check</param> <returns>bool</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.AddUnderscorePrefix(System.String)"> <summary> Add an underscore prefix to a pascal-cased string </summary> <param name="pascalCasedWord"></param> <returns></returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.AddSpaces(System.String)"> <summary> Add spaces to a pascal-cased string </summary> <param name="pascalCasedWord">String to convert</param> <returns>string</returns> </member> <member name="M:RestSharp.Extensions.StringExtensions.GetNameVariants(System.String,System.Globalization.CultureInfo)"> <summary> Return possible variants of a name for name matching. </summary> <param name="name">String to convert</param> <param name="culture">The culture to use for conversion</param> <returns>IEnumerable<string></returns> </member> <member name="T:RestSharp.Extensions.XmlExtensions"> <summary> XML Extension Methods </summary> </member> <member name="M:RestSharp.Extensions.XmlExtensions.AsNamespaced(System.String,System.String)"> <summary> Returns the name of an element with the namespace if specified </summary> <param name="name">Element name</param> <param name="namespace">XML Namespace</param> <returns></returns> </member> <member name="T:RestSharp.FileParameter"> <summary> Container for files to be uploaded with requests </summary> </member> <member name="P:RestSharp.FileParameter.ContentLength"> <summary> The length of data to be sent </summary> </member> <member name="P:RestSharp.FileParameter.Writer"> <summary> Provides raw data for file </summary> </member> <member name="P:RestSharp.FileParameter.FileName"> <summary> Name of the file to use when uploading </summary> </member> <member name="P:RestSharp.FileParameter.ContentType"> <summary> MIME content type of file </summary> </member> <member name="P:RestSharp.FileParameter.Name"> <summary> Name of the parameter </summary> </member> <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String,System.String)"> <summary> Creates a file parameter from an array of bytes. </summary> <param name="name">The parameter name to use in the request.</param> <param name="data">The data to use as the file's contents.</param> <param name="filename">The filename to use in the request.</param> <param name="contentType">The content type to use in the request.</param> <returns>The <see cref="T:RestSharp.FileParameter" /></returns> </member> <member name="M:RestSharp.FileParameter.Create(System.String,System.Byte[],System.String)"> <summary> Creates a file parameter from an array of bytes. </summary> <param name="name">The parameter name to use in the request.</param> <param name="data">The data to use as the file's contents.</param> <param name="filename">The filename to use in the request.</param> <returns>The <see cref="T:RestSharp.FileParameter" /> using the default content type.</returns> </member> <member name="M:RestSharp.FileParameter.Create(System.String,System.Action{System.IO.Stream},System.Int64,System.String,System.String)"> <summary> Creates a file parameter from an array of bytes. </summary> <param name="name">The parameter name to use in the request.</param> <param name="writer">Delegate that will be called with the request stream so you can write to it..</param> <param name="contentLength">The length of the data that will be written by te writer.</param> <param name="fileName">The filename to use in the request.</param> <param name="contentType">Optional: parameter content type</param> <returns>The <see cref="T:RestSharp.FileParameter" /> using the default content type.</returns> </member> <member name="T:RestSharp.Http"> <summary> HttpWebRequest wrapper (async methods) </summary> <summary> HttpWebRequest wrapper </summary> <summary> HttpWebRequest wrapper (sync methods) </summary> </member> <member name="M:RestSharp.Http.AsPostAsync(System.Action{RestSharp.HttpResponse},System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.Http.AsGetAsync(System.Action{RestSharp.HttpResponse},System.String)"> <inheritdoc /> </member> <member name="P:RestSharp.Http.HasParameters"> <summary> True if this HTTP request has any HTTP parameters </summary> </member> <member name="P:RestSharp.Http.HasCookies"> <summary> True if this HTTP request has any HTTP cookies </summary> </member> <member name="P:RestSharp.Http.HasBody"> <summary> True if a request body has been specified </summary> </member> <member name="P:RestSharp.Http.HasFiles"> <summary> True if files have been set to be uploaded </summary> </member> <member name="P:RestSharp.Http.AutomaticDecompression"> <inheritdoc /> </member> <member name="P:RestSharp.Http.AlwaysMultipartFormData"> <summary> Always send a multipart/form-data request - even when no Files are present. </summary> </member> <member name="P:RestSharp.Http.UserAgent"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Timeout"> <inheritdoc /> </member> <member name="P:RestSharp.Http.ReadWriteTimeout"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Credentials"> <inheritdoc /> </member> <member name="P:RestSharp.Http.CookieContainer"> <inheritdoc /> </member> <member name="P:RestSharp.Http.AdvancedResponseWriter"> <inheritdoc /> </member> <member name="P:RestSharp.Http.ResponseWriter"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Files"> <inheritdoc /> </member> <member name="P:RestSharp.Http.FollowRedirects"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Pipelined"> <inheritdoc /> </member> <member name="P:RestSharp.Http.ClientCertificates"> <inheritdoc /> </member> <member name="P:RestSharp.Http.MaxRedirects"> <inheritdoc /> </member> <member name="P:RestSharp.Http.UseDefaultCredentials"> <inheritdoc /> </member> <member name="P:RestSharp.Http.ConnectionGroupName"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Encoding"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Headers"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Parameters"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Cookies"> <inheritdoc /> </member> <member name="P:RestSharp.Http.RequestBody"> <inheritdoc /> </member> <member name="P:RestSharp.Http.RequestContentType"> <inheritdoc /> </member> <member name="P:RestSharp.Http.RequestBodyBytes"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Url"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Host"> <inheritdoc /> </member> <member name="P:RestSharp.Http.AllowedDecompressionMethods"> <inheritdoc /> </member> <member name="P:RestSharp.Http.PreAuthenticate"> <inheritdoc /> </member> <member name="P:RestSharp.Http.UnsafeAuthenticatedConnectionSharing"> <inheritdoc /> </member> <member name="P:RestSharp.Http.Proxy"> <inheritdoc /> </member> <member name="P:RestSharp.Http.CachePolicy"> <inheritdoc /> </member> <member name="P:RestSharp.Http.RemoteCertificateValidationCallback"> <inheritdoc /> <summary> Callback function for handling the validation of remote certificates. </summary> </member> <member name="P:RestSharp.Http.WebRequestConfigurator"> <inheritdoc /> </member> <member name="M:RestSharp.Http.Post"> <summary> Execute a POST request </summary> </member> <member name="M:RestSharp.Http.Put"> <summary> Execute a PUT request </summary> </member> <member name="M:RestSharp.Http.Get"> <summary> Execute a GET request </summary> </member> <member name="M:RestSharp.Http.Head"> <summary> Execute a HEAD request </summary> </member> <member name="M:RestSharp.Http.Options"> <summary> Execute an OPTIONS request </summary> </member> <member name="M:RestSharp.Http.Delete"> <summary> Execute a DELETE request </summary> </member> <member name="M:RestSharp.Http.Patch"> <summary> Execute a PATCH request </summary> </member> <member name="M:RestSharp.Http.Merge"> <summary> Execute a MERGE request </summary> </member> <member name="M:RestSharp.Http.AsGet(System.String)"> <summary> Execute a GET-style request with the specified HTTP Method. </summary> <param name="httpMethod">The HTTP method to execute.</param> <returns></returns> </member> <member name="M:RestSharp.Http.AsPost(System.String)"> <summary> Execute a POST-style request with the specified HTTP Method. </summary> <param name="httpMethod">The HTTP method to execute.</param> <returns></returns> </member> <member name="T:RestSharp.HttpCookie"> <summary> Representation of an HTTP cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Comment"> <summary> Comment of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.CommentUri"> <summary> Comment of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Discard"> <summary> Indicates whether the cookie should be discarded at the end of the session </summary> </member> <member name="P:RestSharp.HttpCookie.Domain"> <summary> Domain of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Expired"> <summary> Indicates whether the cookie is expired </summary> </member> <member name="P:RestSharp.HttpCookie.Expires"> <summary> Date and time that the cookie expires </summary> </member> <member name="P:RestSharp.HttpCookie.HttpOnly"> <summary> Indicates that this cookie should only be accessed by the server </summary> </member> <member name="P:RestSharp.HttpCookie.Name"> <summary> Name of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Path"> <summary> Path of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Port"> <summary> Port of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Secure"> <summary> Indicates that the cookie should only be sent over secure channels </summary> </member> <member name="P:RestSharp.HttpCookie.TimeStamp"> <summary> Date and time the cookie was created </summary> </member> <member name="P:RestSharp.HttpCookie.Value"> <summary> Value of the cookie </summary> </member> <member name="P:RestSharp.HttpCookie.Version"> <summary> Version of the cookie </summary> </member> <member name="T:RestSharp.HttpFile"> <summary> Container for HTTP file </summary> </member> <member name="P:RestSharp.HttpFile.ContentLength"> <summary> The length of data to be sent </summary> </member> <member name="P:RestSharp.HttpFile.Writer"> <summary> Provides raw data for file </summary> </member> <member name="P:RestSharp.HttpFile.FileName"> <summary> Name of the file to use when uploading </summary> </member> <member name="P:RestSharp.HttpFile.ContentType"> <summary> MIME content type of file </summary> </member> <member name="P:RestSharp.HttpFile.Name"> <summary> Name of the parameter </summary> </member> <member name="T:RestSharp.HttpHeader"> <summary> Representation of an HTTP header </summary> </member> <member name="M:RestSharp.HttpHeader.#ctor(System.String,System.String)"> <summary> Creates a new instance of HttpHeader </summary> <param name="name">Header name</param> <param name="value">Header value</param> </member> <member name="M:RestSharp.HttpHeader.#ctor(System.String,System.Object)"> <summary> Creates a new instance of HttpHeader with value conversion </summary> <param name="name">Header name</param> <param name="value">Header value, which has to implement ToString() properly</param> </member> <member name="M:RestSharp.HttpHeader.#ctor"> <summary> Creates a new instance of HttpHeader. Remember to assign properties! </summary> </member> <member name="P:RestSharp.HttpHeader.Name"> <summary> Name of the header </summary> </member> <member name="P:RestSharp.HttpHeader.Value"> <summary> Value of the header </summary> </member> <member name="T:RestSharp.HttpParameter"> <summary> Representation of an HTTP parameter (QueryString or Form value) </summary> </member> <member name="M:RestSharp.HttpParameter.#ctor(System.String,System.String,System.String)"> <summary> Creates a new instance of HttpParameter </summary> <param name="name">Header name</param> <param name="value">Header value</param> <param name="contentType">Parameter content type</param> </member> <member name="M:RestSharp.HttpParameter.#ctor(System.String,System.Object,System.String)"> <summary> Creates a new instance of HttpParameter with value conversion </summary> <param name="name">Header name</param> <param name="value">Header value, which has to implement ToString() properly</param> <param name="contentType">Parameter content type</param> </member> <member name="P:RestSharp.HttpParameter.Name"> <summary> Name of the parameter </summary> </member> <member name="P:RestSharp.HttpParameter.Value"> <summary> Value of the parameter </summary> </member> <member name="P:RestSharp.HttpParameter.ContentType"> <summary> Content-Type of the parameter </summary> </member> <member name="T:RestSharp.HttpResponse"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ContentType"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ContentLength"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ContentEncoding"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.Content"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.StatusCode"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.StatusDescription"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.RawBytes"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ResponseUri"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.Server"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.Headers"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.Cookies"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ResponseStatus"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ErrorMessage"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ErrorException"> <inheritdoc /> </member> <member name="P:RestSharp.HttpResponse.ProtocolVersion"> <inheritdoc /> </member> <member name="P:RestSharp.IHttp.ResponseWriter"> <summary> The delegate to use to write the response instead of reading into RawBytes </summary> </member> <member name="P:RestSharp.IHttp.AdvancedResponseWriter"> <summary> The delegate to use to write the response instead of reading into RawBytes Here you can also check the request details </summary> </member> <member name="P:RestSharp.IHttp.CookieContainer"> <summary> The <see cref="T:System.Net.CookieContainer"/> to be used for the request </summary> </member> <member name="P:RestSharp.IHttp.Credentials"> <summary> <see cref="T:System.Net.ICredentials"/> to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.AutomaticDecompression"> <summary> Enable or disable automatic gzip/deflate decompression </summary> </member> <member name="P:RestSharp.IHttp.AlwaysMultipartFormData"> <summary> Always send a multipart/form-data request - even when no Files are present. </summary> </member> <member name="P:RestSharp.IHttp.UserAgent"> <summary> </summary> </member> <member name="P:RestSharp.IHttp.Timeout"> <summary> Timeout in milliseconds to be used for the request </summary> </member> <member name="P:RestSharp.IHttp.ReadWriteTimeout"> <summary> The number of milliseconds before the writing or reading times out. </summary> </member> <member name="P:RestSharp.IHttp.FollowRedirects"> <summary> Whether or not HTTP 3xx response redirects should be automatically followed </summary> </member> <member name="P:RestSharp.IHttp.Pipelined"> <summary> Whether or not to use pipelined connections </summary> </member> <member name="P:RestSharp.IHttp.ClientCertificates"> <summary> X509CertificateCollection to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.MaxRedirects"> <summary> Maximum number of automatic redirects to follow if FollowRedirects is true </summary> </member> <member name="P:RestSharp.IHttp.UseDefaultCredentials"> <summary> Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) will be sent along to the server. </summary> </member> <member name="P:RestSharp.IHttp.Encoding"> <summary> Encoding for the request, UTF8 is the default </summary> </member> <member name="P:RestSharp.IHttp.Headers"> <summary> HTTP headers to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.Parameters"> <summary> HTTP parameters (QueryString or Form values) to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.Files"> <summary> Collection of files to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.Cookies"> <summary> HTTP cookies to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.RequestBody"> <summary> Request body to be sent with request </summary> </member> <member name="P:RestSharp.IHttp.RequestContentType"> <summary> Content type of the request body. </summary> </member> <member name="P:RestSharp.IHttp.PreAuthenticate"> <summary> Flag to send authorisation header with the HttpWebRequest </summary> </member> <member name="P:RestSharp.IHttp.UnsafeAuthenticatedConnectionSharing"> <summary> Flag to reuse same connection in the HttpWebRequest </summary> </member> <member name="P:RestSharp.IHttp.CachePolicy"> <summary> Caching policy for requests created with this wrapper. </summary> </member> <member name="P:RestSharp.IHttp.ConnectionGroupName"> <summary> The ConnectionGroupName property enables you to associate a request with a connection group. </summary> </member> <member name="P:RestSharp.IHttp.RequestBodyBytes"> <summary> An alternative to RequestBody, for when the caller already has the byte array. </summary> </member> <member name="P:RestSharp.IHttp.Url"> <summary> URL to call for this request </summary> </member> <member name="P:RestSharp.IHttp.Host"> <summary> Explicit Host header value to use in requests independent from the request URI. If null, default host value extracted from URI is used. </summary> </member> <member name="P:RestSharp.IHttp.FormBoundary"> <summary> Boundary that will be used for multipart/form-data requests </summary> </member> <member name="P:RestSharp.IHttp.AllowedDecompressionMethods"> <summary> List of allowed decompression methods </summary> </member> <member name="P:RestSharp.IHttp.Proxy"> <summary> Proxy info to be sent with request </summary> </member> <member name="M:RestSharp.IHttp.AsPostAsync(System.Action{RestSharp.HttpResponse},System.String)"> <summary> Execute an async POST-style request with the specified HTTP Method. </summary> <param name="action"></param> <param name="httpMethod">The HTTP method to execute.</param> <returns></returns> </member> <member name="M:RestSharp.IHttp.AsGetAsync(System.Action{RestSharp.HttpResponse},System.String)"> <summary> Execute an async GET-style request with the specified HTTP Method. </summary> <param name="action"></param> <param name="httpMethod">The HTTP method to execute.</param> <returns></returns> </member> <member name="T:RestSharp.IHttpResponse"> <summary> HTTP response data </summary> </member> <member name="P:RestSharp.IHttpResponse.ContentType"> <summary> MIME content type of response </summary> </member> <member name="P:RestSharp.IHttpResponse.ContentLength"> <summary> Length in bytes of the response content </summary> </member> <member name="P:RestSharp.IHttpResponse.ContentEncoding"> <summary> Encoding of the response content </summary> </member> <member name="P:RestSharp.IHttpResponse.Content"> <summary> String representation of response content </summary> </member> <member name="P:RestSharp.IHttpResponse.StatusCode"> <summary> HTTP response status code </summary> </member> <member name="P:RestSharp.IHttpResponse.StatusDescription"> <summary> Description of HTTP status returned </summary> </member> <member name="P:RestSharp.IHttpResponse.RawBytes"> <summary> Response content </summary> </member> <member name="P:RestSharp.IHttpResponse.ResponseUri"> <summary> The URL that actually responded to the content (different from request if redirected) </summary> </member> <member name="P:RestSharp.IHttpResponse.Server"> <summary> HttpWebResponse.Server </summary> </member> <member name="P:RestSharp.IHttpResponse.Headers"> <summary> Headers returned by server with the response </summary> </member> <member name="P:RestSharp.IHttpResponse.Cookies"> <summary> Cookies returned by server with the response </summary> </member> <member name="P:RestSharp.IHttpResponse.ResponseStatus"> <summary> Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead </summary> </member> <member name="P:RestSharp.IHttpResponse.ErrorMessage"> <summary> Transport or other non-HTTP error generated while attempting request </summary> </member> <member name="P:RestSharp.IHttpResponse.ErrorException"> <summary> Exception thrown when error is encountered. </summary> </member> <member name="P:RestSharp.IHttpResponse.ProtocolVersion"> <summary> The HTTP protocol version (1.0, 1.1, etc) </summary> <remarks>Only set when underlying framework supports it.</remarks> </member> <member name="M:RestSharp.IRestClient.UseSerializer(System.Func{RestSharp.Serialization.IRestSerializer})"> <summary> Replace the default serializer with a custom one </summary> <param name="serializerFactory">Function that returns the serializer instance</param> </member> <member name="M:RestSharp.IRestClient.UseSerializer``1"> <summary> Replace the default serializer with a custom one </summary> <typeparam name="T">The type that implements <see cref="T:RestSharp.Serialization.IRestSerializer"/></typeparam> <returns></returns> </member> <member name="P:RestSharp.IRestClient.ThrowOnDeserializationError"> <summary> Modifies the default behavior of RestSharp to swallow exceptions. When set to <code>true</code>, a <see cref="T:RestSharp.DeserializationException"/> will be thrown in case RestSharp fails to deserialize the response. </summary> </member> <member name="P:RestSharp.IRestClient.FailOnDeserializationError"> <summary> Modifies the default behavior of RestSharp to swallow exceptions. When set to <code>true</code>, RestSharp will consider the request as unsuccessful in case it fails to deserialize the response. </summary> </member> <member name="P:RestSharp.IRestClient.ThrowOnAnyError"> <summary> Modifies the default behavior of RestSharp to swallow exceptions. When set to <code>true</code>, exceptions will be re-thrown. </summary> </member> <member name="P:RestSharp.IRestClient.PreAuthenticate"> <summary> Flag to send authorisation header with the HttpWebRequest </summary> </member> <member name="P:RestSharp.IRestClient.UnsafeAuthenticatedConnectionSharing"> <summary> Flag to reuse same connection in the HttpWebRequest </summary> </member> <member name="P:RestSharp.IRestClient.DefaultParameters"> <summary> A list of parameters that will be set for all requests made by the RestClient instance. </summary> </member> <member name="P:RestSharp.IRestClient.BaseHost"> <summary> Explicit Host header value to use in requests independent from the request URI. If null, default host value extracted from URI is used. </summary> </member> <member name="P:RestSharp.IRestClient.AllowMultipleDefaultParametersWithSameName"> <summary> By default, RestSharp doesn't allow multiple parameters to have the same name. This properly allows to override the default behavior. </summary> </member> <member name="P:RestSharp.IRestClient.ClientCertificates"> <summary> X509CertificateCollection to be sent with request </summary> </member> <member name="P:RestSharp.IRestClient.RemoteCertificateValidationCallback"> <summary> Callback function for handling the validation of remote certificates. Useful for certificate pinning and overriding certificate errors in the scope of a request. </summary> </member> <member name="M:RestSharp.IRestClient.UseUrlEncoder(System.Func{System.String,System.String})"> <summary> Allows to use a custom way to encode URL parameters </summary> <param name="encoder">A delegate to encode URL parameters</param> <example>client.UseUrlEncoder(s => HttpUtility.UrlEncode(s));</example> <returns></returns> </member> <member name="M:RestSharp.IRestClient.UseQueryEncoder(System.Func{System.String,System.Text.Encoding,System.String})"> <summary> Allows to use a custom way to encode query parameters </summary> <param name="queryEncoder">A delegate to encode query parameters</param> <example>client.UseUrlEncoder((s, encoding) => HttpUtility.UrlEncode(s, encoding));</example> <returns></returns> </member> <member name="M:RestSharp.IRestClient.Execute(RestSharp.IRestRequest)"> <summary> Executes the given request and returns an untyped response. </summary> <param name="request">Pre-configured request instance.</param> <returns>Untyped response.</returns> </member> <member name="M:RestSharp.IRestClient.Execute(RestSharp.IRestRequest,RestSharp.Method)"> <summary> Executes the given request and returns an untyped response. Allows to specify the HTTP method (GET, POST, etc) so you won't need to set it on the request. </summary> <param name="request">Pre-configured request instance.</param> <param name="httpMethod">The HTTP method (GET, POST, etc) to be used when making the request.</param> <returns>Untyped response.</returns> </member> <member name="M:RestSharp.IRestClient.Execute``1(RestSharp.IRestRequest)"> <summary> Executes the given request and returns a typed response. RestSharp will deserialize the response and it will be available in the <code>Data</code> property of the response instance. </summary> <param name="request">Pre-configured request instance.</param> <returns>Typed response.</returns> </member> <member name="M:RestSharp.IRestClient.Execute``1(RestSharp.IRestRequest,RestSharp.Method)"> <summary> Executes the given request and returns a typed response. RestSharp will deserialize the response and it will be available in the <code>Data</code> property of the response instance. Allows to specify the HTTP method (GET, POST, etc) so you won't need to set it on the request. </summary> <param name="request">Pre-configured request instance.</param> <param name="httpMethod">The HTTP method (GET, POST, etc) to be used when making the request.</param> <returns>Typed response.</returns> </member> <member name="M:RestSharp.IRestClient.DownloadData(RestSharp.IRestRequest)"> <summary> A specialized method to download files. </summary> <param name="request">Pre-configured request instance.</param> <returns>The downloaded file.</returns> </member> <member name="M:RestSharp.IRestClient.DownloadData(RestSharp.IRestRequest,System.Boolean)"> <summary> Executes the specified request and downloads the response data </summary> <param name="request">Request to execute</param> <param name="throwOnError">Throw an exception if download fails.</param> <returns>Response data</returns> </member> <member name="M:RestSharp.IRestClient.ConfigureWebRequest(System.Action{System.Net.HttpWebRequest})"> <summary> Add a delegate to apply custom configuration to HttpWebRequest before making a call </summary> <param name="configurator">Configuration delegate for HttpWebRequest</param> </member> <member name="M:RestSharp.IRestClient.AddHandler(System.String,System.Func{RestSharp.Deserializers.IDeserializer})"> <summary> Adds or replaces a deserializer for the specified content type </summary> <param name="contentType">Content type for which the deserializer will be replaced</param> <param name="deserializerFactory">Custom deserializer factory</param> </member> <member name="M:RestSharp.IRestClient.RemoveHandler(System.String)"> <summary> Removes custom deserialzier for the specified content type </summary> <param name="contentType">Content type for which deserializer needs to be removed</param> </member> <member name="M:RestSharp.IRestClient.ClearHandlers"> <summary> Remove deserializers for all content types </summary> </member> <member name="M:RestSharp.IRestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsync``1(RestSharp.IRestRequest,RestSharp.Method,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsync(RestSharp.IRestRequest,RestSharp.Method,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a GET-style request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a POST-style request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a GET-style request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.IRestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a GET-style request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,RestSharp.Method)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken,RestSharp.Method)"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> <param name="httpMethod">Override the request method</param> </member> <member name="M:RestSharp.IRestClient.ExecuteTaskAsync(RestSharp.IRestRequest)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostTaskAsync(RestSharp.IRestRequest)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.IRestClient.ExecutePostTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.IRestClient.AddHandler(System.String,RestSharp.Deserializers.IDeserializer)"> <summary> Adds or replaces a deserializer for the specified content type </summary> <param name="contentType">Content type for which the deserializer will be replaced</param> <param name="deserializer">Custom deserializer</param> </member> <member name="P:RestSharp.IRestRequest.AlwaysMultipartFormData"> <summary> Always send a multipart/form-data request - even when no Files are present. </summary> </member> <member name="P:RestSharp.IRestRequest.JsonSerializer"> <summary> Serializer to use when writing JSON request bodies. Used if RequestFormat is Json. By default the included JsonSerializer is used (currently using SimpleJson default serialization). </summary> </member> <member name="P:RestSharp.IRestRequest.XmlSerializer"> <summary> Serializer to use when writing XML request bodies. Used if RequestFormat is Xml. By default the included XmlSerializer is used. </summary> </member> <member name="P:RestSharp.IRestRequest.AdvancedResponseWriter"> <summary> Set this to handle the response stream yourself, based on the response details </summary> </member> <member name="P:RestSharp.IRestRequest.ResponseWriter"> <summary> Set this to write response to Stream rather than reading into memory. </summary> </member> <member name="P:RestSharp.IRestRequest.Parameters"> <summary> Container of all HTTP parameters to be passed with the request. See AddParameter() for explanation of the types of parameters that can be passed </summary> </member> <member name="P:RestSharp.IRestRequest.Files"> <summary> Container of all the files to be uploaded with the request. </summary> </member> <member name="P:RestSharp.IRestRequest.Method"> <summary> Determines what HTTP method to use for this request. Supported methods: GET, POST, PUT, DELETE, HEAD, OPTIONS Default is GET </summary> </member> <member name="P:RestSharp.IRestRequest.Resource"> <summary> The Resource URL to make the request against. Tokens are substituted with UrlSegment parameters and match by name. Should not include the scheme or domain. Do not include leading slash. Combined with RestClient.BaseUrl to assemble final URL: {BaseUrl}/{Resource} (BaseUrl is scheme + domain, e.g. http://example.com) </summary> <example> // example for url token replacement request.Resource = "Products/{ProductId}"; request.AddParameter("ProductId", 123, ParameterType.UrlSegment); </example> </member> <member name="P:RestSharp.IRestRequest.RequestFormat"> <summary> Serializer to use when writing request bodies. </summary> </member> <member name="P:RestSharp.IRestRequest.RootElement"> <summary> Used by the default deserializers to determine where to start deserializing from. Can be used to skip container or root elements that do not have corresponding deserialzation targets. </summary> </member> <member name="P:RestSharp.IRestRequest.DateFormat"> <summary> Used by the default deserializers to explicitly set which date format string to use when parsing dates. </summary> </member> <member name="P:RestSharp.IRestRequest.XmlNamespace"> <summary> Used by XmlDeserializer. If not specified, XmlDeserializer will flatten response by removing namespaces from element names. </summary> </member> <member name="P:RestSharp.IRestRequest.Credentials"> <summary> In general you would not need to set this directly. Used by the NtlmAuthenticator. </summary> </member> <member name="P:RestSharp.IRestRequest.Timeout"> <summary> Timeout in milliseconds to be used for the request. This timeout value overrides a timeout set on the RestClient. </summary> </member> <member name="P:RestSharp.IRestRequest.ReadWriteTimeout"> <summary> The number of milliseconds before the writing or reading times out. This timeout value overrides a timeout set on the RestClient. </summary> </member> <member name="P:RestSharp.IRestRequest.Attempts"> <summary> How many attempts were made to send this Request? </summary> <remarks> This number is incremented each time the RestClient sends the request. </remarks> </member> <member name="P:RestSharp.IRestRequest.UseDefaultCredentials"> <summary> Determine whether or not the "default credentials" (e.g. the user account under which the current process is running) will be sent along to the server. The default is false. </summary> </member> <member name="P:RestSharp.IRestRequest.AllowedDecompressionMethods"> <summary> List of allowed decompression methods </summary> </member> <member name="P:RestSharp.IRestRequest.OnBeforeDeserialization"> <summary> When supplied, the function will be called before calling the deserializer </summary> </member> <member name="P:RestSharp.IRestRequest.OnBeforeRequest"> <summary> When supplied, the function will be called before making a request </summary> </member> <member name="P:RestSharp.IRestRequest.Body"> <summary> Serialized request body to be accessed in authenticators </summary> </member> <member name="M:RestSharp.IRestRequest.AddFile(System.String,System.String,System.String)"> <summary> Adds a file to the Files collection to be included with a POST or PUT request (other methods do not support file uploads). </summary> <param name="name">The parameter name to use in the request</param> <param name="path">Full path to file to upload</param> <param name="contentType">The MIME type of the file to upload</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddFile(System.String,System.Byte[],System.String,System.String)"> <summary> Adds the bytes to the Files collection with the specified file name and content type </summary> <param name="name">The parameter name to use in the request</param> <param name="bytes">The file data</param> <param name="fileName">The file name to use for the uploaded file</param> <param name="contentType">The MIME type of the file to upload</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String,System.Int64,System.String)"> <summary> Adds the bytes to the Files collection with the specified file name and content type </summary> <param name="name">The parameter name to use in the request</param> <param name="writer">A function that writes directly to the stream. Should NOT close the stream.</param> <param name="fileName">The file name to use for the uploaded file</param> <param name="contentLength">The length (in bytes) of the file content.</param> <param name="contentType">The MIME type of the file to upload</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddFileBytes(System.String,System.Byte[],System.String,System.String)"> <summary> Add bytes to the Files collection as if it was a file of specific type </summary> <param name="name">A form parameter name</param> <param name="bytes">The file data</param> <param name="filename">The file name to use for the uploaded file</param> <param name="contentType">Specific content type. Es: application/x-gzip </param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddBody(System.Object,System.String)"> <summary> Serializes obj to format specified by RequestFormat, but passes XmlNamespace if using the default XmlSerializer The default format is XML. Change RequestFormat if you wish to use a different serialization format. </summary> <param name="obj">The object to serialize</param> <param name="xmlNamespace">The XML namespace to use when serializing</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddBody(System.Object)"> <summary> Serializes obj to data format specified by RequestFormat and adds it to the request body. The default format is XML. Change RequestFormat if you wish to use a different serialization format. </summary> <param name="obj">The object to serialize</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddJsonBody(System.Object)"> <summary> Instructs RestSharp to send a given object in the request body, serialized as JSON. </summary> <param name="obj">The object to serialize</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddJsonBody(System.Object,System.String)"> <summary> Instructs RestSharp to send a given object in the request body, serialized as JSON. Allows specifying a custom content type. Usually, this method is used to support PATCH requests that require application/json-patch+json content type. </summary> <param name="obj">The object to serialize</param> <param name="contentType">Custom content type to override the default application/json</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object)"> <summary> Instructs RestSharp to send a given object in the request body, serialized as XML. </summary> <param name="obj">The object to serialize</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddXmlBody(System.Object,System.String)"> <summary> Instructs RestSharp to send a given object in the request body, serialized as XML but passes XmlNamespace if using the default XmlSerializer. </summary> <param name="obj">The object to serialize</param> <param name="xmlNamespace">The XML namespace to use when serializing</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddObject(System.Object,System.String[])"> <summary> Calls AddParameter() for all public, readable properties specified in the includedProperties list </summary> <example> request.AddObject(product, "ProductId", "Price", ...); </example> <param name="obj">The object with properties to add as parameters</param> <param name="includedProperties">The names of the properties to include</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddObject(System.Object)"> <summary> Calls AddParameter() for all public, readable properties of obj </summary> <param name="obj">The object with properties to add as parameters</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddParameter(RestSharp.Parameter)"> <summary> Add the parameter to the request </summary> <param name="p">Parameter to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object)"> <summary> Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)"> <summary> Adds a parameter to the request. There are five types of parameters: - GetOrPost: Either a QueryString value or encoded form value based on method - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - RequestBody: Used by AddBody() (not recommended to use directly) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <param name="type">The type of parameter to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> <summary> Adds a parameter to the request. There are five types of parameters: - GetOrPost: Either a QueryString value or encoded form value based on method - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - Cookie: Adds the name/value pair to the HTTP request's Cookies collection - RequestBody: Used by AddBody() (not recommended to use directly) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <param name="contentType">Content-Type of the parameter</param> <param name="type">The type of parameter to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateParameter(RestSharp.Parameter)"> <summary> Adds a parameter to the request or updates it with the given argument, if the parameter already exists in the request. </summary> <param name="parameter">Parameter to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateParameters(System.Collections.Generic.IEnumerable{RestSharp.Parameter})"> <summary> Add or update parameters to the request </summary> <param name="parameters">Collection of parameters to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateParameter(System.String,System.Object)"> <summary> Adds a HTTP parameter to the request (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateParameter(System.String,System.Object,RestSharp.ParameterType)"> <summary> Adds a parameter to the request. There are five types of parameters: - GetOrPost: Either a QueryString value or encoded form value based on method - HttpHeader: Adds the name/value pair to the HTTP request Headers collection - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - Cookie: Adds the name/value pair to the HTTP request Cookies collection - RequestBody: Used by AddBody() (not recommended to use directly) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <param name="type">The type of parameter to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> <summary> Adds a parameter to the request. There are five types of parameters: - GetOrPost: Either a QueryString value or encoded form value based on method - HttpHeader: Adds the name/value pair to the HTTP request Headers collection - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - Cookie: Adds the name/value pair to the HTTP request Cookies collection - RequestBody: Used by AddBody() (not recommended to use directly) </summary> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <param name="contentType">Content-Type of the parameter</param> <param name="type">The type of parameter to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddHeader(System.String,System.String)"> <summary> Shortcut to AddParameter(name, value, HttpHeader) overload </summary> <param name="name">Name of the header to add</param> <param name="value">Value of the header to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateHeader(System.String,System.String)"> <summary> Shortcut to AddOrUpdateParameter(name, value, HttpHeader) overload </summary> <param name="name">Name of the header to add or update</param> <param name="value">Value of the header to add or update</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddHeaders(System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <summary> Uses AddHeader(name, value) in a convenient way to pass in multiple headers at once. </summary> <param name="headers">Key/Value pairs containing the name: value of the headers</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddOrUpdateHeaders(System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <summary> Uses AddOrUpdateHeader(name, value) in a convenient way to pass in multiple headers at once. </summary> <param name="headers">Key/Value pairs containing the name: value of the headers</param> <returns>This request</returns> </member> <member name="M:RestSharp.IRestRequest.AddCookie(System.String,System.String)"> <summary> Shortcut to AddParameter(name, value, Cookie) overload </summary> <param name="name">Name of the cookie to add</param> <param name="value">Value of the cookie to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.String)"> <summary> Shortcut to AddParameter(name, value, UrlSegment) overload </summary> <param name="name">Name of the segment to add</param> <param name="value">Value of the segment to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.String,System.Boolean)"> <summary> Shortcut to AddParameter(name, value, UrlSegment) overload </summary> <param name="name">Name of the segment to add</param> <param name="value">Value of the segment to add</param> <param name="encode">Specify false if the value should not be encoded</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddUrlSegment(System.String,System.Object)"> <summary> Shortcut to AddParameter(name, value, UrlSegment) overload </summary> <param name="name">Name of the segment to add</param> <param name="value">Value of the segment to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddQueryParameter(System.String,System.String)"> <summary> Shortcut to AddParameter(name, value, QueryString) overload </summary> <param name="name">Name of the parameter to add</param> <param name="value">Value of the parameter to add</param> <returns></returns> </member> <member name="M:RestSharp.IRestRequest.AddQueryParameter(System.String,System.String,System.Boolean)"> <summary> Shortcut to AddParameter(name, value, QueryString) overload </summary> <param name="name">Name of the parameter to add</param> <param name="value">Value of the parameter to add</param> <param name="encode">Whether parameter should be encoded or not</param> <returns></returns> </member> <member name="T:RestSharp.IRestResponse"> <summary> Container for data sent back from API </summary> </member> <member name="P:RestSharp.IRestResponse.Request"> <summary> The RestRequest that was made to get this RestResponse </summary> <remarks> Mainly for debugging if ResponseStatus is not OK </remarks> </member> <member name="P:RestSharp.IRestResponse.ContentType"> <summary> MIME content type of response </summary> </member> <member name="P:RestSharp.IRestResponse.ContentLength"> <summary> Length in bytes of the response content </summary> </member> <member name="P:RestSharp.IRestResponse.ContentEncoding"> <summary> Encoding of the response content </summary> </member> <member name="P:RestSharp.IRestResponse.Content"> <summary> String representation of response content </summary> </member> <member name="P:RestSharp.IRestResponse.StatusCode"> <summary> HTTP response status code </summary> </member> <member name="P:RestSharp.IRestResponse.IsSuccessful"> <summary> Whether or not the response status code indicates success </summary> </member> <member name="P:RestSharp.IRestResponse.StatusDescription"> <summary> Description of HTTP status returned </summary> </member> <member name="P:RestSharp.IRestResponse.RawBytes"> <summary> Response content </summary> </member> <member name="P:RestSharp.IRestResponse.ResponseUri"> <summary> The URL that actually responded to the content (different from request if redirected) </summary> </member> <member name="P:RestSharp.IRestResponse.Server"> <summary> HttpWebResponse.Server </summary> </member> <member name="P:RestSharp.IRestResponse.Cookies"> <summary> Cookies returned by server with the response </summary> </member> <member name="P:RestSharp.IRestResponse.Headers"> <summary> Headers returned by server with the response </summary> </member> <member name="P:RestSharp.IRestResponse.ResponseStatus"> <summary> Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead </summary> </member> <member name="P:RestSharp.IRestResponse.ErrorMessage"> <summary> Transport or other non-HTTP error generated while attempting request </summary> </member> <member name="P:RestSharp.IRestResponse.ErrorException"> <summary> Exceptions thrown during the request, if any. </summary> <remarks> Will contain only network transport or framework exceptions thrown during the request. HTTP protocol errors are handled by RestSharp and will not appear here. </remarks> </member> <member name="P:RestSharp.IRestResponse.ProtocolVersion"> <summary> The HTTP protocol version (1.0, 1.1, etc) </summary> <remarks>Only set when underlying framework supports it.</remarks> </member> <member name="T:RestSharp.IRestResponse`1"> <summary> Container for data sent back from API including deserialized data </summary> <typeparam name="T">Type of data to deserialize to</typeparam> </member> <member name="P:RestSharp.IRestResponse`1.Data"> <summary> Deserialized entity data </summary> </member> <member name="T:RestSharp.RestClient"> <summary> Client to translate RestRequests into Http requests and process response result </summary> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken,RestSharp.Method)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> <param name="httpMethod">Override the request method</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},RestSharp.Method)"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> <param name="httpMethod">HTTP call method (GET, PUT, etc)</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle})"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsyncGet(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a GET-style request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsyncPost(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse,RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a POST-style request and callback asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle.</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},RestSharp.Method)"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> <param name="httpMethod">Override the request http method</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle})"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsyncGet``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a GET-style request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsyncPost``1(RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0},RestSharp.RestRequestAsyncHandle},System.String)"> <summary> Executes a POST-style request and callback asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> <param name="httpMethod">The HTTP method to execute</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken,RestSharp.Method)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> <param name="httpMethod">Override the request method</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,RestSharp.Method)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostTaskAsync(RestSharp.IRestRequest)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteTaskAsync(RestSharp.IRestRequest)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetTaskAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="token">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">The cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteGetAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a GET-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecutePostAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes a POST-style asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,RestSharp.Method,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync``1(RestSharp.IRestRequest,RestSharp.Method,System.Threading.CancellationToken)"> <summary> Executes the request asynchronously, authenticating if needed </summary> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="httpMethod">Override the request method</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:RestSharp.RestClient.ExecuteAsync(RestSharp.IRestRequest,System.Threading.CancellationToken)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.#ctor"> <summary> Default constructor that registers default content handlers </summary> </member> <member name="M:RestSharp.RestClient.#ctor(System.Uri)"> <inheritdoc /> <summary> Sets the BaseUrl property for requests made by this client instance </summary> <param name="baseUrl"></param> </member> <member name="M:RestSharp.RestClient.#ctor(System.String)"> <inheritdoc /> <summary> Sets the BaseUrl property for requests made by this client instance </summary> <param name="baseUrl"></param> </member> <member name="M:RestSharp.RestClient.UseSerializer(RestSharp.Serialization.IRestSerializer)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.UseUrlEncoder(System.Func{System.String,System.String})"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.UseQueryEncoder(System.Func{System.String,System.Text.Encoding,System.String})"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.AutomaticDecompression"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.MaxRedirects"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.ClientCertificates"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.Proxy"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.CachePolicy"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.Pipelined"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.FollowRedirects"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.CookieContainer"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.UserAgent"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.Timeout"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.ReadWriteTimeout"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.UseSynchronizationContext"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.Authenticator"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.BaseUrl"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.Encoding"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.PreAuthenticate"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.ThrowOnDeserializationError"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.FailOnDeserializationError"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.ThrowOnAnyError"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.UnsafeAuthenticatedConnectionSharing"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.ConnectionGroupName"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.RemoteCertificateValidationCallback"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.DefaultParameters"> <inheritdoc /> </member> <member name="P:RestSharp.RestClient.BaseHost"> <inheritdoc />> </member> <member name="P:RestSharp.RestClient.AllowMultipleDefaultParametersWithSameName"> <inheritdoc />> </member> <member name="M:RestSharp.RestClient.AddHandler(System.String,System.Func{RestSharp.Deserializers.IDeserializer})"> <inheritdoc />> </member> <member name="M:RestSharp.RestClient.AddHandler(System.String,RestSharp.Deserializers.IDeserializer)"> <inheritdoc />> </member> <member name="M:RestSharp.RestClient.RemoveHandler(System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ClearHandlers"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.Deserialize``1(RestSharp.IRestResponse)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ConfigureWebRequest(System.Action{System.Net.HttpWebRequest})"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.BuildUri(RestSharp.IRestRequest)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.UseSerializer(System.Func{RestSharp.Serialization.IRestSerializer})"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.UseSerializer``1"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.DownloadData(RestSharp.IRestRequest)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.DownloadData(RestSharp.IRestRequest,System.Boolean)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.Execute(RestSharp.IRestRequest,RestSharp.Method)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.Execute(RestSharp.IRestRequest)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ExecuteAsGet(RestSharp.IRestRequest,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ExecuteAsPost(RestSharp.IRestRequest,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.Execute``1(RestSharp.IRestRequest,RestSharp.Method)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.Execute``1(RestSharp.IRestRequest)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ExecuteAsGet``1(RestSharp.IRestRequest,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClient.ExecuteAsPost``1(RestSharp.IRestRequest,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestClientExtensions.ExecuteAsync(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse})"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="client">The IRestClient this method extends</param> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion</param> </member> <member name="M:RestSharp.RestClientExtensions.ExecuteAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Action{RestSharp.IRestResponse{``0}})"> <summary> Executes the request and callback asynchronously, authenticating if needed </summary> <param name="client">The IRestClient this method extends</param> <typeparam name="T">Target deserialization type</typeparam> <param name="request">Request to be executed</param> <param name="callback">Callback function to be executed upon completion providing access to the async handle</param> </member> <member name="M:RestSharp.RestClientExtensions.ExecuteDynamic(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request and returns a response with the dynamic object as Data </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.GetAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using GET HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.PostAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using POST HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.PutAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using PUT HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.HeadAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using HEAD HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.OptionsAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using OPTIONS HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.PatchAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using PATCH HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.DeleteAsync``1(RestSharp.IRestClient,RestSharp.IRestRequest,System.Threading.CancellationToken)"> <summary> Execute the request using DELETE HTTP method. Exception will be thrown if the request does not succeed. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <param name="cancellationToken">Cancellation token</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Get``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using GET HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Post``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using POST HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Put``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using PUT HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Head``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using HEAD HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Options``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using OPTIONS HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Patch``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using PATCH HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Delete``1(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using DELETE HTTP method. The response data is deserialized to the Data property of the returned response object. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <typeparam name="T">Expected result type</typeparam> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Get(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using GET HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Post(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using POST HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Put(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using PUT HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Head(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using HEAD HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Options(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using OPTIONS HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Patch(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using PATCH HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.Delete(RestSharp.IRestClient,RestSharp.IRestRequest)"> <summary> Execute the request using DELETE HTTP method. </summary> <param name="client">RestClient instance</param> <param name="request">The request</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,RestSharp.Parameter)"> <summary> Add a parameter to use on every request made with this client instance </summary> <param name="restClient">The IRestClient instance</param> <param name="p">Parameter to add</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddOrUpdateDefaultParameter(RestSharp.IRestClient,RestSharp.Parameter)"> <summary> Add a new or update an existing parameter to use on every request made with this client instance </summary> <param name="restClient"></param> <param name="p"></param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.RemoveDefaultParameter(RestSharp.IRestClient,System.String)"> <summary> Removes a parameter from the default parameters that are used on every request made with this client instance </summary> <param name="restClient">The IRestClient instance</param> <param name="name">The name of the parameter that needs to be removed</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object)"> <summary> Adds a default HTTP parameter (QueryString for GET, DELETE, OPTIONS and HEAD; Encoded form for POST and PUT) Used on every request made by this client instance </summary> <param name="restClient">The IRestClient instance</param> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <returns>This request</returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultParameter(RestSharp.IRestClient,System.String,System.Object,RestSharp.ParameterType)"> <summary> Adds a default parameter to the request. There are four types of parameters: - GetOrPost: Either a QueryString value or encoded form value based on method - HttpHeader: Adds the name/value pair to the HTTP request's Headers collection - UrlSegment: Inserted into URL if there is a matching url token e.g. {AccountId} - RequestBody: Used by AddBody() (not recommended to use directly) Used on every request made by this client instance </summary> <param name="restClient">The IRestClient instance</param> <param name="name">Name of the parameter</param> <param name="value">Value of the parameter</param> <param name="type">The type of parameter to add</param> <returns>This request</returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultHeader(RestSharp.IRestClient,System.String,System.String)"> <summary> Adds a default header to the RestClient. Used on every request made by this client instance. </summary> <param name="restClient">The IRestClient instance</param> <param name="name">Name of the header to add</param> <param name="value">Value of the header to add</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultHeaders(RestSharp.IRestClient,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Adds default headers to the RestClient. Used on every request made by this client instance. </summary> <param name="restClient">The IRestClient instance</param> <param name="headers">Dictionary containing the Names and Values of the headers to add</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultUrlSegment(RestSharp.IRestClient,System.String,System.String)"> <summary> Adds a default URL segment parameter to the RestClient. Used on every request made by this client instance. </summary> <param name="restClient">The IRestClient instance</param> <param name="name">Name of the segment to add</param> <param name="value">Value of the segment to add</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.AddDefaultQueryParameter(RestSharp.IRestClient,System.String,System.String)"> <summary> Adds a default URL query parameter to the RestClient. Used on every request made by this client instance. </summary> <param name="restClient">The IRestClient instance</param> <param name="name">Name of the query parameter to add</param> <param name="value">Value of the query parameter to add</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.UseJson(RestSharp.RestClient)"> <summary> Sets the <see cref="T:RestSharp.RestClient"/> to only use JSON </summary> <param name="client">The client instance</param> <returns></returns> </member> <member name="M:RestSharp.RestClientExtensions.UseXml(RestSharp.RestClient)"> <summary> Sets the <see cref="T:RestSharp.RestClient"/> to only use XML </summary> <param name="client"></param> <returns></returns> </member> <member name="T:RestSharp.Parameter"> <summary> Parameter container for REST requests </summary> </member> <member name="P:RestSharp.Parameter.Name"> <summary> Name of the parameter </summary> </member> <member name="P:RestSharp.Parameter.Value"> <summary> Value of the parameter </summary> </member> <member name="P:RestSharp.Parameter.Type"> <summary> Type of the parameter </summary> </member> <member name="P:RestSharp.Parameter.DataFormat"> <summary> Body parameter data type </summary> </member> <member name="P:RestSharp.Parameter.ContentType"> <summary> MIME content type of the parameter </summary> </member> <member name="M:RestSharp.Parameter.ToString"> <summary> Return a human-readable representation of this parameter </summary> <returns>String</returns> </member> <member name="T:RestSharp.RestRequest"> <summary> Container for data used to make requests </summary> </member> <member name="M:RestSharp.RestRequest.#ctor"> <summary> Default constructor </summary> </member> <member name="M:RestSharp.RestRequest.#ctor(RestSharp.Method)"> <summary> Sets Method property to value of method </summary> <param name="method">Method to use for this request</param> </member> <member name="P:RestSharp.RestRequest.AllowedDecompressionMethods"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.AlwaysMultipartFormData"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.JsonSerializer"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.XmlSerializer"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Body"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.ResponseWriter"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.AdvancedResponseWriter"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.UseDefaultCredentials"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddFile(System.String,System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Byte[],System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddFile(System.String,System.Action{System.IO.Stream},System.String,System.Int64,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddFileBytes(System.String,System.Byte[],System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddBody(System.Object,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddBody(System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddJsonBody(System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddJsonBody(System.Object,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddXmlBody(System.Object,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddObject(System.Object,System.String[])"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddObject(System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddParameter(RestSharp.Parameter)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,RestSharp.ParameterType)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateParameter(RestSharp.Parameter)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateParameters(System.Collections.Generic.IEnumerable{RestSharp.Parameter})"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateParameter(System.String,System.Object)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateParameter(System.String,System.Object,RestSharp.ParameterType)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateParameter(System.String,System.Object,System.String,RestSharp.ParameterType)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddHeader(System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateHeader(System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddHeaders(System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddOrUpdateHeaders(System.Collections.Generic.ICollection{System.Collections.Generic.KeyValuePair{System.String,System.String}})"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddCookie(System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddQueryParameter(System.String,System.String)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddQueryParameter(System.String,System.String,System.Boolean)"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddDecompressionMethod(System.Net.DecompressionMethods)"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Parameters"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Files"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Method"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Resource"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.RequestFormat"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.RootElement"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.OnBeforeDeserialization"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.OnBeforeRequest"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.DateFormat"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.XmlNamespace"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Credentials"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Timeout"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.ReadWriteTimeout"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.IncreaseNumAttempts"> <inheritdoc /> </member> <member name="P:RestSharp.RestRequest.Attempts"> <inheritdoc /> </member> <member name="M:RestSharp.RestRequest.AddUrlSegment(System.String,System.Object)"> <inheritdoc /> </member> <member name="T:RestSharp.RestResponseBase"> <summary> Base class for common properties shared by RestResponse and RestResponse[[T]] </summary> </member> <member name="M:RestSharp.RestResponseBase.#ctor"> <summary> Default constructor </summary> </member> <member name="P:RestSharp.RestResponseBase.Request"> <summary> The RestRequest that was made to get this RestResponse </summary> <remarks> Mainly for debugging if ResponseStatus is not OK </remarks> </member> <member name="P:RestSharp.RestResponseBase.ContentType"> <summary> MIME content type of response </summary> </member> <member name="P:RestSharp.RestResponseBase.ContentLength"> <summary> Length in bytes of the response content </summary> </member> <member name="P:RestSharp.RestResponseBase.ContentEncoding"> <summary> Encoding of the response content </summary> </member> <member name="P:RestSharp.RestResponseBase.Content"> <summary> String representation of response content </summary> </member> <member name="P:RestSharp.RestResponseBase.StatusCode"> <summary> HTTP response status code </summary> </member> <member name="P:RestSharp.RestResponseBase.IsSuccessful"> <summary> Whether or not the response status code indicates success </summary> </member> <member name="P:RestSharp.RestResponseBase.StatusDescription"> <summary> Description of HTTP status returned </summary> </member> <member name="P:RestSharp.RestResponseBase.RawBytes"> <summary> Response content </summary> </member> <member name="P:RestSharp.RestResponseBase.ResponseUri"> <summary> The URL that actually responded to the content (different from request if redirected) </summary> </member> <member name="P:RestSharp.RestResponseBase.Server"> <summary> HttpWebResponse.Server </summary> </member> <member name="P:RestSharp.RestResponseBase.Cookies"> <summary> Cookies returned by server with the response </summary> </member> <member name="P:RestSharp.RestResponseBase.Headers"> <summary> Headers returned by server with the response </summary> </member> <member name="P:RestSharp.RestResponseBase.ResponseStatus"> <summary> Status of the request. Will return Error for transport errors. HTTP errors will still return ResponseStatus.Completed, check StatusCode instead </summary> </member> <member name="P:RestSharp.RestResponseBase.ErrorMessage"> <summary> Transport or other non-HTTP error generated while attempting request </summary> </member> <member name="P:RestSharp.RestResponseBase.ErrorException"> <summary> The exception thrown during the request, if any </summary> </member> <member name="P:RestSharp.RestResponseBase.ProtocolVersion"> <summary> The HTTP protocol version (1.0, 1.1, etc) </summary> <remarks>Only set when underlying framework supports it.</remarks> </member> <member name="M:RestSharp.RestResponseBase.DebuggerDisplay"> <summary> Assists with debugging responses by displaying in the debugger output </summary> <returns></returns> </member> <member name="T:RestSharp.RestResponse`1"> <summary> Container for data sent back from API including deserialized data </summary> <typeparam name="T">Type of data to deserialize to</typeparam> </member> <member name="P:RestSharp.RestResponse`1.Data"> <summary> Deserialized entity data </summary> </member> <member name="T:RestSharp.RestResponse"> <summary> Container for data sent back from API </summary> </member> <member name="P:RestSharp.RestResponseCookie.Comment"> <summary> Comment of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.CommentUri"> <summary> Comment of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Discard"> <summary> Indicates whether the cookie should be discarded at the end of the session </summary> </member> <member name="P:RestSharp.RestResponseCookie.Domain"> <summary> Domain of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Expired"> <summary> Indicates whether the cookie is expired </summary> </member> <member name="P:RestSharp.RestResponseCookie.Expires"> <summary> Date and time that the cookie expires </summary> </member> <member name="P:RestSharp.RestResponseCookie.HttpOnly"> <summary> Indicates that this cookie should only be accessed by the server </summary> </member> <member name="P:RestSharp.RestResponseCookie.Name"> <summary> Name of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Path"> <summary> Path of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Port"> <summary> Port of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Secure"> <summary> Indicates that the cookie should only be sent over secure channels </summary> </member> <member name="P:RestSharp.RestResponseCookie.TimeStamp"> <summary> Date and time the cookie was created </summary> </member> <member name="P:RestSharp.RestResponseCookie.Value"> <summary> Value of the cookie </summary> </member> <member name="P:RestSharp.RestResponseCookie.Version"> <summary> Version of the cookie </summary> </member> <member name="M:RestSharp.Serialization.Json.JsonSerializer.Serialize(System.Object)"> <summary> Serialize the object as JSON If the object is already a serialized string returns it's value </summary> <param name="obj">Object to serialize</param> <returns>JSON as String</returns> </member> <member name="P:RestSharp.Serialization.Json.JsonSerializer.ContentType"> <summary> Content type for serialized content </summary> </member> <member name="M:RestSharp.Serialization.Json.JsonSerializer.IsSerializedString(System.Object,System.String@)"> <summary> Determines if the object is already a serialized string. </summary> </member> <member name="P:RestSharp.Serialization.Xml.XmlSerilizationOptions.RootElement"> <summary> Name of the root element to use when serializing </summary> </member> <member name="P:RestSharp.Serialization.Xml.XmlSerilizationOptions.Namespace"> <summary> XML namespace to use when serializing </summary> </member> <member name="P:RestSharp.Serialization.Xml.XmlSerilizationOptions.DateFormat"> <summary> Format string to use when serializing dates </summary> </member> <member name="T:RestSharp.Deserializers.DeserializeAsAttribute"> <summary> Allows control how class and property names and values are deserialized by XmlAttributeDeserializer </summary> </member> <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Name"> <summary> The name to use for the serialized element </summary> </member> <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Attribute"> <summary> Sets if the property to Deserialize is an Attribute or Element (Default: false) </summary> </member> <member name="P:RestSharp.Deserializers.DeserializeAsAttribute.Content"> <summary> Sets if the property to Deserialize is a content of current Element (Default: false) </summary> </member> <member name="T:RestSharp.Deserializers.DotNetXmlDeserializer"> <summary> Wrapper for System.Xml.Serialization.XmlSerializer. </summary> </member> <member name="P:RestSharp.Deserializers.DotNetXmlDeserializer.Encoding"> <summary> Encoding for serialized content </summary> </member> <member name="P:RestSharp.Deserializers.DotNetXmlDeserializer.RootElement"> <summary> Name of the root element to use when serializing </summary> </member> <member name="P:RestSharp.Deserializers.DotNetXmlDeserializer.Namespace"> <summary> XML namespace to use when serializing </summary> </member> <member name="T:RestSharp.Serializers.SerializeAsAttribute"> <summary> Allows control how class and property names and values are serialized by XmlSerializer Currently not supported with the JsonSerializer When specified at the property level the class-level specification is overridden </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.Name"> <summary> The name to use for the serialized element </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.Attribute"> <summary> Sets the value to be serialized as an Attribute instead of an Element </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.Content"> <summary> Sets the value to be serialized as text content of current Element instead of an new Element </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.Culture"> <summary> The culture to use when serializing </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.NameStyle"> <summary> Transforms the casing of the name based on the selected value. </summary> </member> <member name="P:RestSharp.Serializers.SerializeAsAttribute.Index"> <summary> The order to serialize the element. Default is int.MaxValue. </summary> </member> <member name="M:RestSharp.Serializers.SerializeAsAttribute.TransformName(System.String)"> <summary> Called by the attribute when NameStyle is speficied </summary> <param name="input">The string to transform</param> <returns>String</returns> </member> <member name="T:RestSharp.Serializers.NameStyle"> <summary> Options for transforming casing of element names </summary> </member> <member name="T:RestSharp.Serializers.DotNetXmlSerializer"> <summary> Wrapper for System.Xml.Serialization.XmlSerializer. </summary> </member> <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor"> <summary> Default constructor, does not specify namespace </summary> </member> <member name="M:RestSharp.Serializers.DotNetXmlSerializer.#ctor(System.String)"> <inheritdoc /> <summary> Specify the namespaced to be used when serializing </summary> <param name="namespace">XML namespace</param> </member> <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Encoding"> <summary> Encoding for serialized content </summary> </member> <member name="M:RestSharp.Serializers.DotNetXmlSerializer.Serialize(System.Object)"> <summary> Serialize the object as XML </summary> <param name="obj">Object to serialize</param> <returns>XML as string</returns> </member> <member name="P:RestSharp.Serializers.DotNetXmlSerializer.RootElement"> <summary> Name of the root element to use when serializing </summary> </member> <member name="P:RestSharp.Serializers.DotNetXmlSerializer.Namespace"> <summary> XML namespace to use when serializing </summary> </member> <member name="P:RestSharp.Serializers.DotNetXmlSerializer.DateFormat"> <summary> Format string to use when serializing dates </summary> </member> <member name="P:RestSharp.Serializers.DotNetXmlSerializer.ContentType"> <summary> Content type for serialized content </summary> </member> <member name="T:RestSharp.Serializers.XmlSerializer"> <summary> Default XML Serializer </summary> </member> <member name="M:RestSharp.Serializers.XmlSerializer.#ctor"> <summary> Default constructor, does not specify namespace </summary> </member> <member name="M:RestSharp.Serializers.XmlSerializer.#ctor(System.String)"> <summary> Specify the namespaced to be used when serializing </summary> <param name="namespace">XML namespace</param> </member> <member name="M:RestSharp.Serializers.XmlSerializer.Serialize(System.Object)"> <summary> Serialize the object as XML </summary> <param name="obj">Object to serialize</param> <returns>XML as string</returns> </member> <member name="P:RestSharp.Serializers.XmlSerializer.RootElement"> <summary> Name of the root element to use when serializing </summary> </member> <member name="P:RestSharp.Serializers.XmlSerializer.Namespace"> <summary> XML namespace to use when serializing </summary> </member> <member name="P:RestSharp.Serializers.XmlSerializer.DateFormat"> <summary> Format string to use when serializing dates </summary> </member> <member name="P:RestSharp.Serializers.XmlSerializer.ContentType"> <summary> Content type for serialized content </summary> </member> <member name="M:RestSharp.Serializers.XmlSerializer.IsNumeric(System.Object)"> <summary> Determines if a given object is numeric in any way (can be integer, double, null, etc). </summary> </member> <member name="T:RestSharp.JsonArray"> <summary> Represents the json array. </summary> </member> <member name="M:RestSharp.JsonArray.#ctor"> <summary> Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class. </summary> </member> <member name="M:RestSharp.JsonArray.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:RestSharp.JsonArray"/> class. </summary> <param name="capacity">The capacity of the json array.</param> </member> <member name="M:RestSharp.JsonArray.ToString"> <summary> The json representation of the array. </summary> <returns>The json representation of the array.</returns> </member> <member name="T:RestSharp.JsonObject"> <summary> Represents the json object. </summary> </member> <member name="F:RestSharp.JsonObject._members"> <summary> The internal member dictionary. </summary> </member> <member name="M:RestSharp.JsonObject.#ctor"> <summary> Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>. </summary> </member> <member name="M:RestSharp.JsonObject.#ctor(System.Collections.Generic.IEqualityComparer{System.String})"> <summary> Initializes a new instance of <see cref="T:RestSharp.JsonObject"/>. </summary> <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> </member> <member name="P:RestSharp.JsonObject.Item(System.Int32)"> <summary> Gets the <see cref="T:System.Object"/> at the specified index. </summary> <value></value> </member> <member name="M:RestSharp.JsonObject.Add(System.String,System.Object)"> <summary> Adds the specified key. </summary> <param name="key">The key.</param> <param name="value">The value.</param> </member> <member name="M:RestSharp.JsonObject.ContainsKey(System.String)"> <summary> Determines whether the specified key contains key. </summary> <param name="key">The key.</param> <returns> <c>true</c> if the specified key contains key; otherwise, <c>false</c>. </returns> </member> <member name="P:RestSharp.JsonObject.Keys"> <summary> Gets the keys. </summary> <value>The keys.</value> </member> <member name="M:RestSharp.JsonObject.Remove(System.String)"> <summary> Removes the specified key. </summary> <param name="key">The key.</param> <returns></returns> </member> <member name="M:RestSharp.JsonObject.TryGetValue(System.String,System.Object@)"> <summary> Tries the get value. </summary> <param name="key">The key.</param> <param name="value">The value.</param> <returns></returns> </member> <member name="P:RestSharp.JsonObject.Values"> <summary> Gets the values. </summary> <value>The values.</value> </member> <member name="P:RestSharp.JsonObject.Item(System.String)"> <summary> Gets or sets the <see cref="T:System.Object"/> with the specified key. </summary> <value></value> </member> <member name="M:RestSharp.JsonObject.Add(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> <summary> Adds the specified item. </summary> <param name="item">The item.</param> </member> <member name="M:RestSharp.JsonObject.Clear"> <summary> Clears this instance. </summary> </member> <member name="M:RestSharp.JsonObject.Contains(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> <summary> Determines whether [contains] [the specified item]. </summary> <param name="item">The item.</param> <returns> <c>true</c> if [contains] [the specified item]; otherwise, <c>false</c>. </returns> </member> <member name="M:RestSharp.JsonObject.CopyTo(System.Collections.Generic.KeyValuePair{System.String,System.Object}[],System.Int32)"> <summary> Copies to. </summary> <param name="array">The array.</param> <param name="arrayIndex">Index of the array.</param> </member> <member name="P:RestSharp.JsonObject.Count"> <summary> Gets the count. </summary> <value>The count.</value> </member> <member name="P:RestSharp.JsonObject.IsReadOnly"> <summary> Gets a value indicating whether this instance is read only. </summary> <value> <c>true</c> if this instance is read only; otherwise, <c>false</c>. </value> </member> <member name="M:RestSharp.JsonObject.Remove(System.Collections.Generic.KeyValuePair{System.String,System.Object})"> <summary> Removes the specified item. </summary> <param name="item">The item.</param> <returns></returns> </member> <member name="M:RestSharp.JsonObject.GetEnumerator"> <summary> Gets the enumerator. </summary> <returns></returns> </member> <member name="M:RestSharp.JsonObject.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through a collection. </summary> <returns> An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. </returns> </member> <member name="M:RestSharp.JsonObject.ToString"> <summary> Returns a json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. </summary> <returns> A json <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>. </returns> </member> <member name="M:RestSharp.JsonObject.TryConvert(System.Dynamic.ConvertBinder,System.Object@)"> <summary> Provides implementation for type conversion operations. Classes derived from the <see cref="T:System.Dynamic.DynamicObject"/> class can override this method to specify dynamic behavior for operations that convert an object from one type to another. </summary> <param name="binder">Provides information about the conversion operation. The binder.Type property provides the type to which the object must be converted. For example, for the statement (String)sampleObject in C# (CType(sampleObject, Type) in Visual Basic), where sampleObject is an instance of the class derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, binder.Type returns the <see cref="T:System.String"/> type. The binder.Explicit property provides information about the kind of conversion that occurs. It returns true for explicit conversion and false for implicit conversion.</param> <param name="result">The result of the type conversion operation.</param> <returns> Alwasy returns true. </returns> </member> <member name="M:RestSharp.JsonObject.TryDeleteMember(System.Dynamic.DeleteMemberBinder)"> <summary> Provides the implementation for operations that delete an object member. This method is not intended for use in C# or Visual Basic. </summary> <param name="binder">Provides information about the deletion.</param> <returns> Alwasy returns true. </returns> </member> <member name="M:RestSharp.JsonObject.TryGetIndex(System.Dynamic.GetIndexBinder,System.Object[],System.Object@)"> <summary> Provides the implementation for operations that get a value by index. Classes derived from the <see cref="T:System.Dynamic.DynamicObject"/> class can override this method to specify dynamic behavior for indexing operations. </summary> <param name="binder">Provides information about the operation.</param> <param name="indexes">The indexes that are used in the operation. For example, for the sampleObject[3] operation in C# (sampleObject(3) in Visual Basic), where sampleObject is derived from the DynamicObject class, <paramref name="indexes"/> is equal to 3.</param> <param name="result">The result of the index operation.</param> <returns> Alwasy returns true. </returns> </member> <member name="M:RestSharp.JsonObject.TryGetMember(System.Dynamic.GetMemberBinder,System.Object@)"> <summary> Provides the implementation for operations that get member values. Classes derived from the <see cref="T:System.Dynamic.DynamicObject"/> class can override this method to specify dynamic behavior for operations such as getting a value for a property. </summary> <param name="binder">Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member on which the dynamic operation is performed. For example, for the Console.WriteLine(sampleObject.SampleProperty) statement, where sampleObject is an instance of the class derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.</param> <param name="result">The result of the get operation. For example, if the method is called for a property, you can assign the property value to <paramref name="result"/>.</param> <returns> Alwasy returns true. </returns> </member> <member name="M:RestSharp.JsonObject.TrySetIndex(System.Dynamic.SetIndexBinder,System.Object[],System.Object)"> <summary> Provides the implementation for operations that set a value by index. Classes derived from the <see cref="T:System.Dynamic.DynamicObject"/> class can override this method to specify dynamic behavior for operations that access objects by a specified index. </summary> <param name="binder">Provides information about the operation.</param> <param name="indexes">The indexes that are used in the operation. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, <paramref name="indexes"/> is equal to 3.</param> <param name="value">The value to set to the object that has the specified index. For example, for the sampleObject[3] = 10 operation in C# (sampleObject(3) = 10 in Visual Basic), where sampleObject is derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, <paramref name="value"/> is equal to 10.</param> <returns> true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown. </returns> </member> <member name="M:RestSharp.JsonObject.TrySetMember(System.Dynamic.SetMemberBinder,System.Object)"> <summary> Provides the implementation for operations that set member values. Classes derived from the <see cref="T:System.Dynamic.DynamicObject"/> class can override this method to specify dynamic behavior for operations such as setting a value for a property. </summary> <param name="binder">Provides information about the object that called the dynamic operation. The binder.Name property provides the name of the member to which the value is being assigned. For example, for the statement sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, binder.Name returns "SampleProperty". The binder.IgnoreCase property specifies whether the member name is case-sensitive.</param> <param name="value">The value to set to the member. For example, for sampleObject.SampleProperty = "Test", where sampleObject is an instance of the class derived from the <see cref="T:System.Dynamic.DynamicObject"/> class, the <paramref name="value"/> is "Test".</param> <returns> true if the operation is successful; otherwise, false. If this method returns false, the run-time binder of the language determines the behavior. (In most cases, a language-specific run-time exception is thrown.) </returns> </member> <member name="M:RestSharp.JsonObject.GetDynamicMemberNames"> <summary> Returns the enumeration of all dynamic member names. </summary> <returns> A sequence that contains dynamic member names. </returns> </member> <member name="T:RestSharp.SimpleJson"> <summary> This class encodes and decodes JSON strings. Spec. details, see http://www.json.org/ JSON uses Arrays and Objects. These correspond here to the datatypes JsonArray(IList<object>) and JsonObject(IDictionary<string,object>). All numbers are parsed to doubles. </summary> </member> <member name="M:RestSharp.SimpleJson.DeserializeObject(System.String)"> <summary> Parses the string json into a value </summary> <param name="json">A JSON string.</param> <returns>An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false</returns> </member> <member name="M:RestSharp.SimpleJson.DeserializeObject(System.Char[])"> <summary> Parses the char array json into a value </summary> <param name="json">A JSON char array.</param> <returns>An IList<object>, a IDictionary<string,object>, a double, a string, null, true, or false</returns> </member> <member name="M:RestSharp.SimpleJson.TryDeserializeObject(System.Char[],System.Object@)"> <summary> Try parsing the json string into a value. </summary> <param name="json"> A JSON string. </param> <param name="obj"> The object. </param> <returns> Returns true if successfull otherwise false. </returns> </member> <member name="M:RestSharp.SimpleJson.TryDeserializeObject(System.String,System.Object@)"> <summary> Try parsing the json string into a value. </summary> <param name="json"> A JSON string. </param> <param name="obj"> The object. </param> <returns> Returns true if successfull otherwise false. </returns> </member> <member name="M:RestSharp.SimpleJson.SerializeObject(System.Object,RestSharp.IJsonSerializerStrategy)"> <summary> Converts a IDictionary<string,object> / IList<object> object into a JSON string </summary> <param name="json">A IDictionary<string,object> / IList<object></param> <param name="jsonSerializerStrategy">Serializer strategy to use</param> <returns>A JSON encoded string, or null if object 'json' is not serializable</returns> </member> <member name="M:RestSharp.SimpleJson.IsNumeric(System.Object)"> <summary> Determines if a given object is numeric in any way (can be integer, double, null, etc). </summary> </member> <member name="T:RestSharp.Validation.Require"> <summary> Helper methods for validating required values </summary> </member> <member name="M:RestSharp.Validation.Require.Argument(System.String,System.Object)"> <summary> Require a parameter to not be null </summary> <param name="argumentName">Name of the parameter</param> <param name="argumentValue">Value of the parameter</param> </member> <member name="T:RestSharp.Validation.Validate"> <summary> Helper methods for validating values </summary> </member> <member name="M:RestSharp.Validation.Validate.IsBetween(System.Int32,System.Int32,System.Int32)"> <summary> Validate an integer value is between the specified values (exclusive of min/max) </summary> <param name="value">Value to validate</param> <param name="min">Exclusive minimum value</param> <param name="max">Exclusive maximum value</param> </member> <member name="M:RestSharp.Validation.Validate.IsValidLength(System.String,System.Int32)"> <summary> Validate a string length </summary> <param name="value">String to be validated</param> <param name="maxSize">Maximum length of the string</param> </member> </members> </doc> |