pc.Http
Used to send and receive HTTP requests.
Summary
Methods
| del | Perform an HTTP DELETE request to the given url. |
| del | Perform an HTTP DELETE request to the given url. |
| get | Perform an HTTP GET request to the given url. |
| get | Perform an HTTP GET request to the given url. |
| post | Perform an HTTP POST request to the given url. |
| post | Perform an HTTP POST request to the given url. |
| put | Perform an HTTP PUT request to the given url. |
| put | Perform an HTTP PUT request to the given url. |
| request | Make a general purpose HTTP request. |
| request | Make a general purpose HTTP request. |
Details
Constructor
Http()
Create a new Http instance. By default, a PlayCanvas application creates an instance of this
object at pc.http.
Methods
del(url, callback)
Perform an HTTP DELETE request to the given url.
Parameters
| url | object | The URL to make the request to. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
del(url, options, callback)
Perform an HTTP DELETE request to the given url.
Parameters
| url | object | The URL to make the request to. |
| options | object | Additional options. |
| options.headers | object | HTTP headers to add to the request. |
| options.async | boolean | Make the request asynchronously. Defaults to true. |
| options.cache | object | If false, then add a timestamp to the request to prevent caching. |
| options.withCredentials | boolean | Send cookies with this request. Defaults to false. |
| options.responseType | string | Override the response type. |
| options.postdata | Document, object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| options.retry | boolean | If true then if the request fails it will be retried with an exponential backoff. |
| options.maxRetries | number | If options.retry is true this specifies the maximum number of retries. Defaults to 5. |
| options.maxRetryDelay | number | If options.retry is true this specifies the maximum amount of time to wait between retries in milliseconds. Defaults to 5000. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
get(url, callback)
Perform an HTTP GET request to the given url.
pc.http.get("http://example.com/", function (err, response) {
console.log(response);
});Parameters
| url | string | The URL to make the request to. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
get(url, options, callback)
Perform an HTTP GET request to the given url.
Parameters
| url | string | The URL to make the request to. |
| options | object | Additional options. |
| options.headers | object | HTTP headers to add to the request. |
| options.async | boolean | Make the request asynchronously. Defaults to true. |
| options.cache | object | If false, then add a timestamp to the request to prevent caching. |
| options.withCredentials | boolean | Send cookies with this request. Defaults to false. |
| options.responseType | string | Override the response type. |
| options.postdata | Document, object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| options.retry | boolean | If true then if the request fails it will be retried with an exponential backoff. |
| options.maxRetries | number | If options.retry is true this specifies the maximum number of retries. Defaults to 5. |
| options.maxRetryDelay | number | If options.retry is true this specifies the maximum amount of time to wait between retries in milliseconds. Defaults to 5000. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
post(url, data, callback)
Perform an HTTP POST request to the given url.
Parameters
| url | string | The URL to make the request to. |
| data | object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
post(url, data, options, callback)
Perform an HTTP POST request to the given url.
Parameters
| url | string | The URL to make the request to. |
| data | object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| options | object | Additional options. |
| options.headers | object | HTTP headers to add to the request. |
| options.async | boolean | Make the request asynchronously. Defaults to true. |
| options.cache | object | If false, then add a timestamp to the request to prevent caching. |
| options.withCredentials | boolean | Send cookies with this request. Defaults to false. |
| options.responseType | string | Override the response type. |
| options.retry | boolean | If true then if the request fails it will be retried with an exponential backoff. |
| options.maxRetries | number | If options.retry is true this specifies the maximum number of retries. Defaults to 5. |
| options.maxRetryDelay | number | If options.retry is true this specifies the maximum amount of time to wait between retries in milliseconds. Defaults to 5000. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
put(url, data, callback)
Perform an HTTP PUT request to the given url.
Parameters
| url | string | The URL to make the request to. |
| data | Document, object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
put(url, data, options, callback)
Perform an HTTP PUT request to the given url.
Parameters
| url | string | The URL to make the request to. |
| data | Document, object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| options | object | Additional options. |
| options.headers | object | HTTP headers to add to the request. |
| options.async | boolean | Make the request asynchronously. Defaults to true. |
| options.cache | object | If false, then add a timestamp to the request to prevent caching. |
| options.withCredentials | boolean | Send cookies with this request. Defaults to false. |
| options.responseType | string | Override the response type. |
| options.retry | boolean | If true then if the request fails it will be retried with an exponential backoff. |
| options.maxRetries | number | If options.retry is true this specifies the maximum number of retries. Defaults to 5. |
| options.maxRetryDelay | number | If options.retry is true this specifies the maximum amount of time to wait between retries in milliseconds. Defaults to 5000. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
request(method, url, callback)
Make a general purpose HTTP request.
Parameters
| method | string | The HTTP method "GET", "POST", "PUT", "DELETE". |
| url | string | The url to make the request to. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.
request(method, url, options, callback)
Make a general purpose HTTP request.
Parameters
| method | string | The HTTP method "GET", "POST", "PUT", "DELETE". |
| url | string | The url to make the request to. |
| options | object | Additional options. |
| options.headers | object | HTTP headers to add to the request. |
| options.async | boolean | Make the request asynchronously. Defaults to true. |
| options.cache | object | If false, then add a timestamp to the request to prevent caching. |
| options.withCredentials | boolean | Send cookies with this request. Defaults to false. |
| options.retry | boolean | If true then if the request fails it will be retried with an exponential backoff. |
| options.maxRetries | number | If options.retry is true this specifies the maximum number of retries. Defaults to 5. |
| options.maxRetryDelay | number | If options.retry is true this specifies the maximum amount of time to wait between retries in milliseconds. Defaults to 5000. |
| options.responseType | string | Override the response type. |
| options.postdata | Document, object | Data to send in the body of the request. Some content types are handled automatically. If postdata is an XML Document, it is handled. If the Content-Type header is set to 'application/json' then the postdata is JSON stringified. Otherwise, by default, the data is sent as form-urlencoded. |
| callback | pc.callbacks.HttpResponse | The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type: text, Object, ArrayBuffer, XML) and err is the error code. |
Returns
XMLHttpRequestThe request object.