Interface IRequest

Namespace: MediaBrowser.Model.Services
Assembly: MediaBrowser.Model.dll
Syntax
public interface IRequest

Properties

AbsoluteUri

Declaration
string AbsoluteUri { get; }
Property Value
Type Description
System.String

Accept

The value of the Accept HTTP Request Header

Declaration
string Accept { get; }
Property Value
Type Description
System.String

AcceptTypes

Declaration
string[] AcceptTypes { get; }
Property Value
Type Description
System.String[]

Authorization

The value of the Authorization Header used to send the Api Key, null if not available

Declaration
string Authorization { get; }
Property Value
Type Description
System.String

CancellationToken

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

ConnectionId

Declaration
string ConnectionId { get; }
Property Value
Type Description
System.String

ContentLength

Declaration
long ContentLength { get; }
Property Value
Type Description
System.Int64

ContentType

The request ContentType

Declaration
string ContentType { get; }
Property Value
Type Description
System.String

Dto

The Request DTO, after it has been deserialized.

Declaration
object Dto { get; set; }
Property Value
Type Description
System.Object

Files

Access to the multi-part/formdata files posted on this request

Declaration
IHttpFile[] Files { get; }
Property Value
Type Description
IHttpFile[]

Headers

Declaration
QueryParamCollection Headers { get; }
Property Value
Type Description
QueryParamCollection

HttpMethod

The HTTP Verb

Declaration
string HttpMethod { get; }
Property Value
Type Description
System.String

InputStream

Declaration
Stream InputStream { get; }
Property Value
Type Description
System.IO.Stream

IsLocal

Declaration
bool IsLocal { get; }
Property Value
Type Description
System.Boolean

IsSecureConnection

e.g. is https or not

Declaration
bool IsSecureConnection { get; }
Property Value
Type Description
System.Boolean

IsSocketConnectionLocal

Declaration
bool IsSocketConnectionLocal { get; }
Property Value
Type Description
System.Boolean

PathInfo

Declaration
string PathInfo { get; }
Property Value
Type Description
System.String

Protocol

Declaration
string Protocol { get; }
Property Value
Type Description
System.String

QueryString

Declaration
QueryParamCollection QueryString { get; }
Property Value
Type Description
QueryParamCollection

RawUrl

Declaration
string RawUrl { get; }
Property Value
Type Description
System.String

RemoteIp

The Remote Ip as reported by X-Forwarded-For, X-Real-IP or Request.UserHostAddress

Declaration
IPAddress RemoteIp { get; }
Property Value
Type Description
System.Net.IPAddress

RemoteSocketPort

Declaration
int RemoteSocketPort { get; }
Property Value
Type Description
System.Int32

Response

Declaration
IResponse Response { get; }
Property Value
Type Description
IResponse

ResponseContentType

The expected Response ContentType for this request

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

UserAgent

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

Verb

The Verb / HttpMethod or Action for this request

Declaration
string Verb { get; }
Property Value
Type Description
System.String

XForwardedFor

The IP Address of the X-Forwarded-For header, null if null or empty

Declaration
string XForwardedFor { get; }
Property Value
Type Description
System.String

XForwardedPort

The Port number of the X-Forwarded-Port header, null if null or empty

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

XForwardedProtocol

The http or https scheme of the X-Forwarded-Proto header, null if null or empty

Declaration
string XForwardedProtocol { get; }
Property Value
Type Description
System.String

XRealIp

The value of the X-Real-IP header, null if null or empty

Declaration
string XRealIp { get; }
Property Value
Type Description
System.String

Methods

GetFormData()

Declaration
Task<QueryParamCollection> GetFormData()
Returns
Type Description
System.Threading.Tasks.Task<QueryParamCollection>

IsInLocalNetwork()

Declaration
bool IsInLocalNetwork()
Returns
Type Description
System.Boolean

IsInLocalNetwork(CancellationToken)

Declaration
Task<bool> IsInLocalNetwork(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Extension Methods