• About the Connect JavaScript API
  • Context
  • Cookie
  • Dialog
  • Events
  • Flag
  • History
  • Host
  • Iframe
  • Inline dialog
  • Jira
  • Navigator
  • Request
  • Scroll position
  • User

Cookie

Enables apps to store, retrieve, and delete cookies. These cookies cannot be seen by other apps.

Methods

saveLocalStorage (addonKey, name, value, expireDays)

Parameters

NameTypeDescription
addonKeystring
namestring
valuestring
expireDaysnumber

readLocalStorage (addonKey, name)

Parameters

NameTypeDescription
addonKeystring
namestring

Returns

[undefined string]

save (name, value, expires)

Save a cookie.

Parameters

NameTypeDescription
nameString

The name of the cookie.

valueString

The value of the cookie.

expiresNumber

The number of days before the cookie expires.

Example

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

read (name, callback)

Get the value of a cookie.

Parameters

NameTypeDescription
nameString

The name of the cookie.

callbackfunction

The callback to pass the cookie data to.

Example

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

erase (name)

Deletes a cookie.

Parameters

NameTypeDescription
nameString

The name of the cookie.

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