• About the JavaScript API
  • AP
  • Confluence
  • Context
  • Cookie
  • Custom content
  • Dialog
  • Events
  • Flag
  • History
  • Inline dialog
  • Navigator
  • Request
  • User

Cookie

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

Methods

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

1
AP.cookie.save('my_cookie', 'my value', 1);

read (name, callback)

Get the value of a cookie.

Parameters

NameTypeDescription
nameString

name of cookie to read

callbackfunction

callback to pass cookie data

Example

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

erase (name)

Remove the given cookie.

Parameters

NameTypeDescription
nameString

the name of the cookie to remove

Example

1
2
3
AP.cookie.save('my_cookie', 'my value', 1);
AP.cookie.read('my_cookie', function(value) { alert(value); });
AP.cookie.erase('my_cookie');

  • System status
  • Privacy
  • Developer Terms
  • Trademark
  • Cookie Preferences
  • © 2019 Atlassian