Class HttpRequestOptions

Class HttpRequestOptions

Inheritance
System.Object
HttpRequestOptions
Namespace: MediaBrowser.Common.Net
Assembly: MediaBrowser.Common.dll
Syntax
public sealed class HttpRequestOptions

Properties

AcceptHeader

Gets or sets the accept header.

Declaration
public string AcceptHeader { get; set; }
Property Value
Type Description
System.String

The accept header.

AppendCharsetToMimeType

Declaration
public bool AppendCharsetToMimeType { get; set; }
Property Value
Type Description
System.Boolean

BufferContent

Declaration
public bool BufferContent { get; set; }
Property Value
Type Description
System.Boolean

CacheLength

Declaration
public TimeSpan CacheLength { get; set; }
Property Value
Type Description
System.TimeSpan

CacheMode

Declaration
public CacheMode CacheMode { get; set; }
Property Value
Type Description
CacheMode

CancellationToken

Gets or sets the cancellation token.

Declaration
public CancellationToken CancellationToken { get; set; }
Property Value
Type Description
System.Threading.CancellationToken

The cancellation token.

ConnectionContext

Declaration
public IDisposable ConnectionContext { get; set; }
Property Value
Type Description
System.IDisposable

ConvertUrlCredentialsToBasicAuth

Declaration
public bool ConvertUrlCredentialsToBasicAuth { get; set; }
Property Value
Type Description
System.Boolean

DecompressionMethod

Declaration
public CompressionMethod? DecompressionMethod { get; set; }
Property Value
Type Description
System.Nullable<CompressionMethod>

DownloadFilePath

Declaration
public string DownloadFilePath { get; set; }
Property Value
Type Description
System.String

EnableAutomaticTimeouts

Declaration
public bool EnableAutomaticTimeouts { get; set; }
Property Value
Type Description
System.Boolean

EnableDefaultUserAgent

Declaration
public bool EnableDefaultUserAgent { get; set; }
Property Value
Type Description
System.Boolean

EnableHttpCompression

Gets or sets a value indicating whether [enable HTTP compression].

Declaration
public bool EnableHttpCompression { get; set; }
Property Value
Type Description
System.Boolean

true if [enable HTTP compression]; otherwise, false.

EnableKeepAlive

Declaration
public bool EnableKeepAlive { get; set; }
Property Value
Type Description
System.Boolean

FileBufferSize

Declaration
public int? FileBufferSize { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

FileOpenOptions

Declaration
public FileOpenOptions FileOpenOptions { get; set; }
Property Value
Type Description
FileOpenOptions

FileShareMode

Declaration
public FileShareMode FileShareMode { get; set; }
Property Value
Type Description
FileShareMode

Host

Gets or sets the host.

Declaration
public string Host { get; set; }
Property Value
Type Description
System.String

The host.

LogErrorResponseBody

Declaration
public bool LogErrorResponseBody { get; set; }
Property Value
Type Description
System.Boolean

LogErrors

Declaration
public bool LogErrors { get; set; }
Property Value
Type Description
System.Boolean

LogRequest

Declaration
public bool LogRequest { get; set; }
Property Value
Type Description
System.Boolean

LogRequestAsDebug

Declaration
public bool LogRequestAsDebug { get; set; }
Property Value
Type Description
System.Boolean

LogResponse

Declaration
public bool LogResponse { get; set; }
Property Value
Type Description
System.Boolean

LogResponseHeaders

Declaration
public bool LogResponseHeaders { get; set; }
Property Value
Type Description
System.Boolean

LogUrl

Declaration
[Obsolete("Deprecated. Use LogUrlPrefix for prefixing or Sanitation for removing sensitive data.")]
public string LogUrl { get; set; }
Property Value
Type Description
System.String

LogUrlPrefix

Declaration
public string LogUrlPrefix { get; set; }
Property Value
Type Description
System.String

Progress

Gets or sets the progress.

Declaration
public IProgress<double> Progress { get; set; }
Property Value
Type Description
System.IProgress<System.Double>

The progress.

Referer

Gets or sets the referrer.

Declaration
public string Referer { get; set; }
Property Value
Type Description
System.String

The referrer.

RequestContent

Declaration
public ReadOnlyMemory<char> RequestContent { get; set; }
Property Value
Type Description
System.ReadOnlyMemory<System.Char>

RequestContentBytes

Declaration
public ReadOnlyMemory<byte> RequestContentBytes { get; set; }
Property Value
Type Description
System.ReadOnlyMemory<System.Byte>

RequestContentType

Declaration
public string RequestContentType { get; set; }
Property Value
Type Description
System.String

RequestHeaders

Declaration
public Dictionary<string, string> RequestHeaders { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

RequestHttpContent

Declaration
public HttpContent RequestHttpContent { get; set; }
Property Value
Type Description
System.Net.Http.HttpContent

Sanitation

Declaration
public UrlSanitationOptions Sanitation { get; }
Property Value
Type Description
UrlSanitationOptions

SingleTcpConnection

Declaration
public bool SingleTcpConnection { get; set; }
Property Value
Type Description
System.Boolean

ThrowOnErrorResponse

Declaration
public bool ThrowOnErrorResponse { get; set; }
Property Value
Type Description
System.Boolean

TimeoutMs

Declaration
public int TimeoutMs { get; set; }
Property Value
Type Description
System.Int32

Url

Gets or sets the URL.

Declaration
public string Url { get; set; }
Property Value
Type Description
System.String

The URL.

UserAgent

Gets or sets the user agent.

Declaration
public string UserAgent { get; set; }
Property Value
Type Description
System.String

The user agent.

Methods

SetPostData(IDictionary<String, String>)

Declaration
public void SetPostData(IDictionary<string, string> values)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.String> values

Extension Methods