Documentation Center

get_state

Get User State (personalization/filter).

Description

This function retrieves a user's active personalization filter. This filter contains an XML representation of the configuration under which the user is operating, which will drive all content filtering within the application.

Parameters

action
get_state

Example URL

http://<host>:<port>/<context>/web/user.xql?action=get_state

Successful Result

User State, or empty <state/> if filter information does not exist. For example, in a publication that has an active filter, a <group/> element will be present.

Failed Result

Accessing this API feature requires the "Use application" permission, and the function will throw a permission exception if the permission is not available.