Versions Compared

Old Version 14

changes.mady.by.user Cindy Li

Saved on

compared with

New Version Current

changes.mady.by.user Cindy Li

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
classcomponent-api-page

Anchor
top
top

The Cookie Settings Store subcomponent is used by UI Enhancer to store/save user preferences into a browser cookie. The options described on this page can be configured through the options of the UI Enhancer component.

Do not use this component directly. The information on this page should be use when customizing UI Enhancer.

See Also
UI Enhancer
Temporary Settings Store

Div
classsummary-table

Supported Events

none

#MethodsMethods

get(cookieName)
Retrieves the current settings from the cookie.


set(settings, cookieOptions)
Saves the specified settings in the cookie.

#OptionsOptions

cookie
Information for the storage cookie.

Methods

Span
classback-to-top
back to top

get(

cookieName

)

Div
classapi-table

Description

Retrieves the current settings stored in the cookie.

Parameters

cookieName (optional)
The name the cookie is stored under.
Default: "fluid-ui-settings"

Return value

The currently stored settings.

Availability

Infusion 1.4 and later

See also

set(settings, cookieOptions)

set(settings

, cookieOptions

)

Div
classapi-table

Description

Stores the specified settings in the cookie.

Parameters

settings
A settings to be stored. It could be any data type. cookieOptions (optional) Information for the storage cookie. The default is the current value of the cookie option.

Availability

Infusion 1.4 and later

See also

get(cookieName)

Options

Span
classback-to-top
back to top

Div
classapi-table

Description

A JavaScript option containing information for configuring the storage cookie.

Default

Code Block
javascript
javascript
{
    name: "fluid-ui-settings",
    path: "/",
    expires: ""
}

Example

Code Block
javascript
javascript
cookie: {
    expires: "Mon, 31 Dec 2012 23:59:00 UTC"
}