Sphyrnidae.Common.RequestData.RequestData Class Reference

More...

Inheritance diagram for Sphyrnidae.Common.RequestData.RequestData:

Public Member Functions
	RequestData (IHttpData data)
virtual async Task< string >	ContentData ()
	The raw content data of the request More...
virtual T	GetEndpointObject< T > ()
	Retrieves some object about the actual endpoint More...
virtual string	GetHeader (string name)
	Retrieves an HTTP Header from the request More...
virtual StringValues	GetHeaders (string name)
	The collection of HTTP Headers with the given name More...

Protected Member Functions
Endpoint	GetEndpoint ()

Properties
IHttpData	Data [get]
virtual Guid	Id [get]
virtual char	LoggingOrder = (char)33 [get, set]
virtual string	IpAddress [get, set]
virtual string	RemoteIpAddress [get]
virtual string	DisplayUrl [get]
virtual string	Route [get]
virtual string	HttpVerb [get]
virtual NameValueCollection	Headers [get]
virtual NameValueCollection????	QueryString [get]
virtual NameValueCollection???????	FormData [get]
virtual string	Browser [get]
Properties inherited from Sphyrnidae.Common.RequestData.IRequestData
Guid	Id [get]
	Gets the unique ID for the request More...
char	LoggingOrder [get, set]
	Order of things being logged More...
string	IpAddress [get, set]
	Ip Address of the end user/client More...
string	RemoteIpAddress [get]
	IP Address of the machine making this request (may not be the original) More...
string	DisplayUrl [get]
	The base URL of the request More...
string	Route [get]
	Route of an API Request More...
string	HttpVerb [get]
	The Http Verb for the request More...
NameValueCollection	Headers [get]
	Collection of Http Headers More...
NameValueCollection	QueryString [get]
	Collection of QueryString variables More...
NameValueCollection	FormData [get]
	Collection of Form variables More...
string	Browser [get]
	Name/Description of the client browser More...

Detailed Description

Constructor & Destructor Documentation

RequestData()

Sphyrnidae.Common.RequestData.RequestData.RequestData

(

IHttpData

data

)

Member Function Documentation

ContentData()

virtual async Task<string> Sphyrnidae.Common.RequestData.RequestData.ContentData ( )

virtual

The raw content data of the request

Implements Sphyrnidae.Common.RequestData.IRequestData.

GetEndpoint()

Endpoint Sphyrnidae.Common.RequestData.RequestData.GetEndpoint ( )

protected

GetEndpointObject< T >()

virtual T Sphyrnidae.Common.RequestData.RequestData.GetEndpointObject< T > ( )

virtual

Retrieves some object about the actual endpoint

Template Parameters

T	The type of object being retrieved

Returns

The object (if found on the endpoint), default (null) otherwise

Implements Sphyrnidae.Common.RequestData.IRequestData.

GetHeader()

virtual string Sphyrnidae.Common.RequestData.RequestData.GetHeader ( string  name )

virtual

Retrieves an HTTP Header from the request

Parameters

name	Name of the HTTP header

Returns

The first value of the header (or null if no header)

Implements Sphyrnidae.Common.RequestData.IRequestData.

GetHeaders()

virtual StringValues Sphyrnidae.Common.RequestData.RequestData.GetHeaders ( string  name )

virtual

The collection of HTTP Headers with the given name

Parameters

name	Name of the HTTP header

Returns

The collection of values

Implements Sphyrnidae.Common.RequestData.IRequestData.

Property Documentation

Browser

virtual string Sphyrnidae.Common.RequestData.RequestData.Browser

get

Data

IHttpData Sphyrnidae.Common.RequestData.RequestData.Data

getprotected

DisplayUrl

virtual string Sphyrnidae.Common.RequestData.RequestData.DisplayUrl

get

FormData

virtual NameValueCollection??????? Sphyrnidae.Common.RequestData.RequestData.FormData

get

Headers

virtual NameValueCollection Sphyrnidae.Common.RequestData.RequestData.Headers

get

HttpVerb

virtual string Sphyrnidae.Common.RequestData.RequestData.HttpVerb

get

Id

virtual Guid Sphyrnidae.Common.RequestData.RequestData.Id

get

IpAddress

virtual string Sphyrnidae.Common.RequestData.RequestData.IpAddress

getset

LoggingOrder

virtual char Sphyrnidae.Common.RequestData.RequestData.LoggingOrder = (char)33

getset

QueryString

virtual NameValueCollection???? Sphyrnidae.Common.RequestData.RequestData.QueryString

get

RemoteIpAddress

virtual string Sphyrnidae.Common.RequestData.RequestData.RemoteIpAddress

get

Route

virtual string Sphyrnidae.Common.RequestData.RequestData.Route

get

---

The documentation for this class was generated from the following file:

• C:/Users/dougb/Desktop/Sphyrnidae/New/Common/Common/RequestData/RequestData.cs