github/cordova-plugin-advanced-http
4
0
Fork 0
mirror of https://github.com/silkimen/cordova-plugin-advanced-http.git synced 2026-04-24 00:00:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated readme with info on headers

Browse Source
This commit is contained in:
Andrew Stephan
2016-04-28 19:12:36 -04:00
parent 50d40e76eb
commit ba37200d75
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -5
View File
@@ -92,11 +92,14 @@ Whether or not to validate the domain name in the certificate. This defaults to
Execute a POST request. Takes a URL, parameters, and headers.
#### success
The success function receives a response object with 2 properties: status and data. Status is the HTTP response code and data is the response from the server as a string. Here's a quick example:
The success function receives a response object with 3 properties: status, data, and headers. Status is the HTTP response code. Data is the response from the server as a string. Headers is an object with the headers. Here's a quick example:
{
status: 200,
data: "{'id': 12, 'message': 'test'}"
data: "{'id': 12, 'message': 'test'}",
headers: {
"Content-Length": "247"
}
}
Most apis will return JSON meaning you'll want to parse the data like in the example below:
@@ -124,11 +127,14 @@ Most apis will return JSON meaning you'll want to parse the data like in the exa
#### failure
The error function receives a response object with 2 properties: status and error. Status is the HTTP response code. Error is the error response from the server as a string. Here's a quick example:
The error function receives a response object with 3 properties: status, error and headers. Status is the HTTP response code. Error is the error response from the server as a string. Headers is an object with the headers. Here's a quick example:
{
status: 403,
error: "Permission denied"
error: "Permission denied",
headers: {
"Content-Length": "247"
}
}
### get
@@ -188,7 +194,6 @@ For instance, the following features are currently not supported:
- cookies support (a cookie set by a request isn't sent in subsequent requests)
- read content of error responses (only the HTTP status code and message are returned)
- read returned HTTP headers (e.g. in case security tokens are returned as headers)
Take this into account when using this plugin into your application.