Files
win8phoneApp/Doc/man/man3/CampusAppWP8_Utility_RestApi.3
stubbfel 7068d54406 add doku
2013-06-13 13:32:21 +02:00

213 lines
5.3 KiB
Groff

.TH "CampusAppWP8.Utility.RestApi" 3 "Thu Jun 13 2013" "CampusAppWP8" \" -*- nroff -*-
.ad l
.nh
.SH NAME
CampusAppWP8.Utility.RestApi \-
.PP
Class realize the access of restful RestAPI
.SH SYNOPSIS
.br
.PP
.PP
Inherited by \fBCampusAppWP8\&.Utility\&.Feed< T >\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBRestApi\fP ()"
.br
.RI "\fIInitializes a new instance of the \fBRestApi\fP class\&. \fP"
.ti -1c
.RI "\fBRestApi\fP (Uri apiBaseAddress)"
.br
.RI "\fIInitializes a new instance of the \fBRestApi\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 "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-delete-method \fP"
.ti -1c
.RI "void \fBHttpOptions\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-delete-method \fP"
.ti -1c
.RI "void \fBHttpConnect\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-delete-method \fP"
.ti -1c
.RI "void \fBHttpTrace\fP (Uri url, Action< object, DownloadStringCompletedEventArgs > action)"
.br
.RI "\fIMethod realize the http-delete-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-get-method \fP"
.ti -1c
.RI "void \fBHttpPatch\fP (Uri url, Action< object, UploadStringCompletedEventArgs > action, string patchData)"
.br
.RI "\fIMethod realize the http-get-method \fP"
.in -1c
.SH "Detailed Description"
.PP
Class realize the access of restful RestAPI
.SH "Constructor & Destructor Documentation"
.PP
.SS "CampusAppWP8\&.Utility\&.RestApi\&.RestApi ()"
.PP
Initializes a new instance of the \fBRestApi\fP class\&.
.SS "CampusAppWP8\&.Utility\&.RestApi\&.RestApi (UriapiBaseAddress)"
.PP
Initializes a new instance of the \fBRestApi\fP class\&.
.PP
\fBParameters:\fP
.RS 4
\fIapiBaseAddress\fP the url of the RestAPI base address
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "void CampusAppWP8\&.Utility\&.RestApi\&.HttpConnect (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\&.RestApi\&.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\&.RestApi\&.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\&.RestApi\&.HttpHead (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\&.RestApi\&.HttpOptions (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\&.RestApi\&.HttpPatch (Uriurl, Action< object, UploadStringCompletedEventArgs >action, stringpatchData)"
.PP
Method realize the http-get-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 RestAPI
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.RestApi\&.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 RestAPI
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.RestApi\&.HttpPut (Uriurl, Action< object, UploadStringCompletedEventArgs >action, stringputData)"
.PP
Method realize the http-get-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 RestAPI
.RE
.PP
.SS "void CampusAppWP8\&.Utility\&.RestApi\&.HttpTrace (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
.SH "Author"
.PP
Generated automatically by Doxygen for CampusAppWP8 from the source code\&.