CookieName Property

The name of the cookie.

Syntax

 oauth.getCookieName(index, [callback])
 oauth.setCookieName(index,  cookieName, [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 getCookieName([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setCookieName([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

The name of the cookie.

This property, along with CookieValue store the cookie that is to be sent to the server. The SetCookie event displays the cookies set by the server and their properties.

The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String