terribleplan/Typertext
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Document JsonRequest

Browse source
This commit is contained in:
Kegan Myers 2014-02-28 11:31:49 -06:00
parent 2f075c7e26
commit 7d48dd705e
1 changed files with 40 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
lib/Typertext/Json/JsonRequest.ts
View file

@ -1,3 +1,7 @@
/**
* @namespace Typertext
* @module Json
*/
module Typertext.Json { module Typertext.Json {
import HttpRequest = Typertext.Http.HttpRequest; import HttpRequest = Typertext.Http.HttpRequest;
import HttpResponse = Typertext.Http.HttpResponse; import HttpResponse = Typertext.Http.HttpResponse;
@ -10,20 +14,55 @@ module Typertext.Json {
private jsonType:string; private jsonType:string;
private request:HttpRequest; private request:HttpRequest;
/**
* A class to simplify passing both the status and data of a completed proxy request
*
* @interface GenericRequest
* @uses Typertext.Http.HttpRequest;
* @uses Typertext.Http.HttpResponse;
* @uses Typertext.Http.HttpResponseStatus;
* @uses Typertext.Http.HttpUrl;
* @uses Typertext.Http.HttpPostData;
* @uses Typertext.Http.HttpMethod;
*
* @author Kegan Myers <kegan@keganmyers.com>
* @version 0.3.0
*/
constructor(jsonContentType:string = "application/json") { constructor(jsonContentType:string = "application/json") {
this.request = new HttpRequest(); this.request = new HttpRequest();
this.jsonType = jsonContentType; this.jsonType = jsonContentType;
} }
/**
* A convenience method for simply calling a GET
*
* @param {HttpUrl} request
* @param {JsonResponseHandler} callback
*/
public Get(request:HttpUrl, callback:JsonResponseHandler):void { public Get(request:HttpUrl, callback:JsonResponseHandler):void {
this.RawRequest(HttpMethod.GET, request, {}, callback); this.RawRequest(HttpMethod.GET, request, {}, callback);
} }
/**
* A convenience method for simply calling a POST
*
* @param {HttpUrl} request
* @param {HttpPostData} postData
* @param {JsonResponseHandler} callback
*/
public Post(request:HttpUrl, postData:HttpPostData, callback:JsonResponseHandler):void { public Post(request:HttpUrl, postData:HttpPostData, callback:JsonResponseHandler):void {
this.RawRequest(HttpMethod.GET, request, postData, callback); this.RawRequest(HttpMethod.GET, request, postData, callback);
} }
public RawRequest(method:Typertext.Http.HttpMethod, request:HttpUrl, postData:Typertext.Http.HttpPostData = {}, callback:JsonResponseHandler = (c)=> { /**
* A layer to automatically decode a response into a JSON object
*
* @param {HttpMethod} method
* @param {HttpUrl} request
* @param {HttpPostData} postData
* @param {JsonResponseHandler} callback
*/
public RawRequest(method:HttpMethod, request:HttpUrl, postData:Typertext.Http.HttpPostData = {}, callback:JsonResponseHandler = (c)=> {
}) { }) {
this.request.RawRequest(method, request, postData, (response:HttpResponse)=> { this.request.RawRequest(method, request, postData, (response:HttpResponse)=> {
//Make sure that we got the Json content type we are expecting //Make sure that we got the Json content type we are expecting