mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
5a4cc4edda
* Release Note for 4.2 - Initial draft. * update dep * documentation * fix * remove script * lint Co-authored-by: Eugenio Romano <eugenio.romano@alfresco.com> Co-authored-by: Eugenio Romano <eromano@users.noreply.github.com>
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
---
|
|
Title: Cookie service
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-11-13
|
|
---
|
|
|
|
# [Cookie service](../../../lib/core/services/cookie.service.ts "Defined in cookie.service.ts")
|
|
|
|
Stores key-value data items as browser cookies.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
* **clear**()<br/>
|
|
Placeholder for testing purposes - do not use.
|
|
* **deleteCookie**(key: `string`, path: `string|null` = `null`)<br/>
|
|
Delete a cookie Key.
|
|
* *key:* `string` - Key to identify the cookie
|
|
* *path:* `string|null` - "Pathname" to store the cookie
|
|
* **getItem**(key: `string`): `string|null`<br/>
|
|
Retrieves a cookie by its key.
|
|
* *key:* `string` - Key to identify the cookie
|
|
* **Returns** `string|null` - The cookie data or null if it is not found
|
|
* **isEnabled**(): `boolean`<br/>
|
|
Checks if cookies are enabled.
|
|
* **Returns** `boolean` - True if enabled, false otherwise
|
|
* **setItem**(key: `string`, data: `string`, expiration: `Date|null` = `null`, path: `string|null` = `null`)<br/>
|
|
Sets a cookie.
|
|
* *key:* `string` - Key to identify the cookie
|
|
* *data:* `string` - Data value to set for the cookie
|
|
* *expiration:* `Date|null` - Expiration date of the data
|
|
* *path:* `string|null` - "Pathname" to store the cookie
|
|
|
|
## Details
|
|
|
|
This service uses browser [cookies](https://en.wikipedia.org/wiki/HTTP_cookie)
|
|
to store data in the form of key-value pairs. An optional `expiration` date can be
|
|
supplied for the cookie and a `path` can be used to reduce the chances of name
|
|
clashes with cookies from other sources.
|
|
|
|
Cookies have a storage size limit that varies between browsers but is often around
|
|
4KB. Consider using [web storage](storage.service.md) if you need to store data
|
|
beyond this size.
|
|
|
|
## See also
|
|
|
|
* [Content service](content.service.md)
|
|
* [Storage service](storage.service.md)
|