Documentation

cookie

Allows add-ons to store, retrieve and erased cookies against the host JIRA / Confluence. These cannot be seen by other add-ons.

Methods

erase(name)

Remove the given cookie.

Parameters:
NameTypeDescription
nameString

the name of the cookie to remove

Example
AP.require("cookie", function(cookie){ cookie.save('my_cookie', 'my value', 1); cookie.read('my_cookie', function(value) { alert(value); }); cookie.erase('my_cookie'); });

read(name, callback)

Get the value of a cookie.

Parameters:
NameTypeDescription
nameString

name of cookie to read

callbackfunction

callback to pass cookie data

Example
AP.require("cookie", function(cookie){ cookie.save('my_cookie', 'my value', 1); cookie.read('my_cookie', function(value) { alert(value); }); });

save(name, value, expires)

Save a cookie.

Parameters:
NameTypeDescription
nameString

name of cookie

valueString

value of cookie

expiresNumber

number of days before cookie expires

Example
AP.require("cookie", function(cookie){ cookie.save('my_cookie', 'my value', 1); });