GetFile Method
Sends a GET request to the server and saves the output to a file.
Syntax
restclient.getFile(url, filename, [callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.
If the request is successful, the received content will be saved to Filename. Otherwise, an exception will be thrown, and the error details published in StatusCode and ReasonPhrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.