Cookie

Allows apps to store, retrieve, and erase cookies against the host Jira/Confluence. These cannot be seen by other apps.

Methods

erase (name)

Remove the given cookie.

Parameters

Name Type Description
name String the name of the cookie to remove

Example

1
2
3
4
5
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

Name Type Description
name String name of cookie to read
callback function callback to pass cookie data

Example

1
2
3
4
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

Name Type Description
name String name of cookie
value String value of cookie
expires Number number of days before cookie expires

Example

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