Skip to end of metadata
Go to start of metadata

Refresh page Dec 04, 2019 02:58

Supported Clients
SmartClient WebClient NGClient

Property Summary
String comment Cookie comment.
String domain Cookie domain.
Boolean httpOnly Cookie httpOnly flag.
Number maxAge Cookie maxAge.
String name Cookie name.
String path Cookie path.
Boolean secure Cookie secure flag.
String value Cookie value.
Number version Cookie version.

Property Details

comment

Cookie comment.
Specifies a comment that describes a cookie's purpose.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.comment = 'yummy';

domain

Cookie domain.
Specifies the domain within which this cookie should be presented.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.domain = 'example.com';

httpOnly

Cookie httpOnly flag.
Marks or unmarks this Cookie as HttpOnly

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.httpOnly = true;

maxAge

Cookie maxAge.
Sets the maximum age in seconds for this Cookie.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.maxAge = 3600;

name

Cookie name.

The cookie name allows only a sequence of non-special, non-white space characters, see
the cookie spec https://tools.ietf.org/html/rfc2965

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.name = 'doublechocolate';

path

Cookie path.
Specifies a path for the cookie to which the client should return the cookie.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.path = '/subfolder';

secure

Cookie secure flag.
Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.secure = true;

value

Cookie value.

The cookie value allows only a sequence of non-special, non-white space characters, see
the cookie spec https://tools.ietf.org/html/rfc2965

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.value = 'mint';

version

Cookie version.
Sets the version of the cookie protocol that this Cookie complies with.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var cookie = plugins.rest_ws.createCookie('chocolate', 'chip');
cookie.version = 1;

  • No labels