Files
win8phoneApp/Doc/man/man3/CampusAppWP8_Utility_HttpRequest.3
2013-08-15 15:28:20 +02:00

231 lines
5.8 KiB
Groff

.TH "CampusAppWP8.Utility.HttpRequest" 3 "Thu Aug 15 2013" "CampusAppWp8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWP8.Utility.HttpRequest \-
.PP
Class realize the access of restful \fBHttpRequest\fP
.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBHttpRequest\fP ()"
.br
.RI "\fIInitializes a new instance of the \fBHttpRequest\fP class\&. \fP"
.ti -1c
.RI "\fBHttpRequest\fP (Uri apiBaseAddress)"
.br
.RI "\fIInitializes a new instance of the \fBHttpRequest\fP class\&. \fP"
.ti -1c
.RI "void \fBHttpGet\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-get-method resource \fP"
.ti -1c
.RI "Uri \fBCreateGetUrl\fP (List< \fBUrlParamModel\fP > parameters)"
.br
.RI "\fIMethod create the Url for the http-get-method \fP"
.ti -1c
.RI "void \fBHttpDelete\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-delete-method \fP"
.ti -1c
.RI "void \fBHttpHead\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-head-method \fP"
.ti -1c
.RI "void \fBHttpOptions\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-options-method \fP"
.ti -1c
.RI "void \fBHttpConnect\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-connect-method \fP"
.ti -1c
.RI "void \fBHttpTrace\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-trace-method \fP"
.ti -1c
.RI "void \fBHttpPost\fP (Uri url, Action< object, UploadStringCompletedEventArgs > action, string postData)"
.br
.RI "\fIMethod realize the http-post-method \fP"
.ti -1c
.RI "void \fBHttpPut\fP (Uri url, Action< object, UploadStringCompletedEventArgs > action, string putData)"
.br
.RI "\fIMethod realize the http-put-method \fP"
.ti -1c
.RI "void \fBHttpPatch\fP (Uri url, Action< object, UploadStringCompletedEventArgs > action, string patchData)"
.br
.RI "\fIMethod realize the http-patch-method \fP"
.in -1c
.SH "Detailed Description"
.PP
Class realize the access of restful \fBHttpRequest\fP
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWP8\&.Utility\&.HttpRequest\&.HttpRequest ()"
.PP
Initializes a new instance of the \fBHttpRequest\fP class\&.
.SS "CampusAppWP8\&.Utility\&.HttpRequest\&.HttpRequest (UriapiBaseAddress)"
.PP
Initializes a new instance of the \fBHttpRequest\fP class\&.
.PP
\fBParameters:\fP
.RS 4
\fIapiBaseAddress\fP the url of the \fBHttpRequest\fP base address
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "Uri CampusAppWP8\&.Utility\&.HttpRequest\&.CreateGetUrl (List< \fBUrlParamModel\fP >parameters)"
.PP
Method create the Url for the http-get-method
.PP
\fBParameters:\fP
.RS 4
\fIparameters\fP list of parameters
.RE
.PP
\fBReturns:\fP
.RS 4
absolute API-Url include GetParameter
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpConnect (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-connect-method is not supported by WebClient
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpDelete (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-delete-method is not supported by WebClient
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpGet (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-get-method resource
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpHead (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-head-method is not supported by WebClient
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpOptions (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-options-method is not supported by WebClient
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpPatch (Uriurl, Action< object, UploadStringCompletedEventArgs >action, stringpatchData)"
.PP
Method realize the http-patch-method
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.br
\fIpatchData\fP Data which are sending via patch to the \fBHttpRequest\fP
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpPost (Uriurl, Action< object, UploadStringCompletedEventArgs >action, stringpostData)"
.PP
Method realize the http-post-method
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.br
\fIpostData\fP Data which are sending via post to the \fBHttpRequest\fP
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpPut (Uriurl, Action< object, UploadStringCompletedEventArgs >action, stringputData)"
.PP
Method realize the http-put-method
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.br
\fIputData\fP Data which are sending via put to the \fBHttpRequest\fP
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.HttpRequest\&.HttpTrace (Uriurl, Action< object, DownloadStringCompletedEventArgs >action)"
.PP
Method realize the http-trace-method is not supported by WebClient
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url of the resource
.br
\fIaction\fP callback method
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppWp8 from the source code\&.