Revision as of 07:15, 24 November 2016

HttpRequest

Object to make requests to sites

Constructors

(string uri "The uri to visit.") - Visit a uri
(string uri "The uri to visit.", WebResponse takeCookiesFrom "If you made a previous request and want to transfer the cookies from that response, give the response object here.") - Visit a uri with cookies

Methods

WebResponse GetResponse() - Actually do the request, and get the response back
WebResponse GetResponse(string body "A body to include in the request - Always UTF-8 encoded") - Actually do the request, and get the response back
Empty SetIgnoreCertificatesErrors() - Ignore any ssl/tls errors due to certificate validation
string ToString() - The string representation of the object.

Properties

string ContentType { get; set; } - Get/Set the ContentType
Dictionary Headers { set; } - Apply headers to the request
string Method { get; set; } - Choose which HTTP method to request with
string ObjectTypeName { get; } - The name of the type of object.
int Timeout { get; set; } - Get/Set the timeout (in millisec)
TypeInformation TypeInformation { get; } - Get information about this class.

More information about an HTTP Message: http://www.jmarshall.com/easy/http/

Examples

string uri = "http://google.com";
string responseString;
HttpRequest hr = new HttpRequest(uri);
WebResponse wr = hr.GetResponse(); 
responseString = wr.Response();
print(responseString);

@@ Line 1: / Line 1: @@
 {{CGscriptClass_Template
-|Name=<nowiki>HttpRequest</nowiki>
+|Name=HttpRequest
-|Description=<nowiki>Object to make requests to sites</nowiki>
+|Description=Object to make requests to sites
 |Constructors=
 {{CGscriptConstructors_Template|Parameters=
-{{CGscriptParameters_Template|Type=string|Name=<nowiki>uri</nowiki>|Description=<nowiki>The uri to visit.</nowiki>}}
+{{CGscriptParameters_Template|Type=string|Name=uri|Description=The uri to visit.}}
-|Description=<nowiki>Visit a uri</nowiki>}}
+|Description=Visit a uri}}
 {{CGscriptConstructors_Template|Parameters=
-{{CGscriptParameters_Template|Type=string|Name=<nowiki>uri</nowiki>|Description=<nowiki>The uri to visit.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=WebResponse|Name=<nowiki>takeCookiesFrom</nowiki>|Description=<nowiki>If you made a previous request and want to transfer the cookies from that response, give the response object here.</nowiki>}}
+{{CGscriptParameters_Template|Type=string|Name=uri|Description=The uri to visit.|Comma=,}}{{CGscriptParameters_Template|Type=WebResponse|Name=takeCookiesFrom|Description=If you made a previous request and want to transfer the cookies from that response, give the response object here.}}
-|Description=<nowiki>Visit a uri with cookies</nowiki>}}
+|Description=Visit a uri with cookies}}
 |Methods=
-{{CGscriptMethods_Template|ReturnType=WebResponse|Name=<nowiki>GetResponse</nowiki>|Description=<nowiki>Actually do the request, and get the response back</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=WebResponse|Name=GetResponse|Description=Actually do the request, and get the response back}}
-{{CGscriptMethods_Template|ReturnType=WebResponse|Name=<nowiki>GetResponse</nowiki>|Parameters=
+{{CGscriptMethods_Template|ReturnType=WebResponse|Name=GetResponse|Parameters=
-{{CGscriptParameters_Template|Type=string|Name=<nowiki>body</nowiki>|Description=<nowiki>A body to include in the request - Always UTF-8 encoded</nowiki>}}
+{{CGscriptParameters_Template|Type=string|Name=body|Description=A body to include in the request - Always UTF-8 encoded}}
-|Description=<nowiki>Actually do the request, and get the response back</nowiki>}}
+|Description=Actually do the request, and get the response back}}
-{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=Empty|Name=SetIgnoreCertificatesErrors|Description=Ignore any ssl/tls errors due to certificate validation}}
+{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 |Properties=
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ContentType</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the ContentType</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=ContentType|HasGetter=1|HasSetter=1|Description=Get/Set the ContentType}}
-{{CGscriptProperties_Template|ReturnType=Dictionary|Name=<nowiki>Headers</nowiki>|HasSetter=1|Description=<nowiki>Apply headers to the request</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=Dictionary|Name=Headers|HasSetter=1|Description=Apply headers to the request}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Method</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Choose which HTTP method to request with</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=Method|HasGetter=1|HasSetter=1|Description=Choose which HTTP method to request with}}
-{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
-{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Timeout</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the timeout (in millisec)</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=Timeout|HasGetter=1|HasSetter=1|Description=Get/Set the timeout (in millisec)}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 }}
-'''More information about an HTTP Message:''' [http://www.jmarshall.com/easy/http/ http://www.jmarshall.com/easy/http/]<br>
+<br/>'''More information about an HTTP Message:''' [http://www.jmarshall.com/easy/http/ http://www.jmarshall.com/easy/http/]
-==== <span style="color:#a52a2a;">Examples</span>  ====
+==== <span style="color:#a52a2a">Examples</span> ====
-<span style="color: rgb(165, 42, 42);"><source lang="javascript">string uri = "http://google.com";
+<span style="color: rgb(165, 42, 42)"><source lang="javascript">string uri = "http://google.com";
 string responseString;
 HttpRequest hr = new HttpRequest(uri);
 WebResponse wr = hr.GetResponse();
 responseString = wr.Response();
 print(responseString);</source></span>