OpenCms JSP standard taglib
Tag usertracking


Multi-purpose tag for tracking resource visits and subscription management.


Tag Information
Tag Classorg.opencms.jsp.CmsJspTagUserTracking
TagExtraInfo ClassNone
Body Contentempty
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
actionfalsetruejava.lang.StringThe action to perform.
The following values are supported:
visit (default)
Mark a resource as visited by a user.
Do not specify the attribute group here.
subscribe
Subscribe a resource for a user or a group.
If neither group nor user are given, the resource is subscribed for the current user.
If group is given, you can simultaneously subscribe the resource for a user by either setting currentuser or user.
unsubscribe
Unsubscribe a resource for a user or a group.
If neither group nor user are given, the resource is unsubscribed for the current user.
If group is given, you can simultaneously unsubscribe the resource for a user by either setting currentuser or user.
checkvisited
Check if a user has visited a resource.
If neither group nor user are given, the check is performed for the current user.
If the resource was visited, the tag evaluates to true, otherwise to false.
checksubscribed
Check if a resource is subscribed by a group or user.
If neither group, user nor currentuser it is checked, if the resource is subscribed any group or user.
currentuserfalsetruejava.lang.StringIf set to true, and no other user is specified via user, the requested action is performed for the current user.
filefalsetruejava.lang.StringSpecifies the resource for which the action should be performed. The resource can also be a folder.

Default: Resource with the current request URI.
groupfalsetruejava.lang.StringSpecify a user group (via its name) for which the action is performed.
includegroupsfalsetruejava.lang.StringIf set to true, subscriptions of a user that exist indirectly via his group memberships are checked additionally to his direct subscriptions. Otherwise, only his direct subscriptions are checked.

Default: false
onlinefalsetruejava.lang.StringIf set to true, visits are only tracked in the online project.

Default: false
subfolderfalsetruejava.lang.StringUsed for the actions checkvisited and checksubscription.
If set to true it is checked if the specified resource, or, if it is a folder, any of the resources in the folder (or its subfolders) is visited or subscribed.
userfalsetruejava.lang.StringSpecify the user (via the login name) for which the action is performed.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.