PostData Property

The data to post with the URL if the POST method is used.

Syntax

 rest.getPostData([callback])
 rest.setPostData( postData_Buffer, [callback])

Default Value

""

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 the getPostData([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setPostData([callback]) 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

This property contains the data to post with the URL if the POST method is used. If this property contains a non-empty string, then if the HTTP 'POST' method is used (Post method), the contents of this property are appended to the HTTP request after the HTTP headers.

An HTTP 'Content-Length' header is also added to the request. Its value is the length of the string in PostData.

The most common example is posting of HTML form input data. In that case, the ContentType property must be set to "application/x-www-form-urlencoded".

Example (Performing a Post)

HTTPControl.ContentType = "application/x-www-form-urlencoded"
HTTPControl.PostData = "firstname=Tom&lastname=Thompson&country=US"
HTTPControl.Post(myurl)

This property is not available at design time.

Data Type

Buffer