General Actions:
Add To Watchlist Macro
Last modified by Thomas Mortagne on 2012/02/22 15:09
 | Illustrates how to programmatically add documents to user watchlists |
| Type | Macro (Velocity) |
| Developed by | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Normally, you can only add documents to the watchlist of the current user, using:
$xwiki.watchlist.addDocument($doc.fullName)
But sometimes you'd like to add documents to the watchlist of another user. This velocity macro shows how to do it. For example, place this code inside a page calling "Macro.AddToAnyUserWatchlist"
{{velocity}}
#macro(addToAnyUserWatchlist $user $item)
#set($itemdoc=$xwiki.getDocument($item))
#set($userdoc=$xwiki.getDocument($user))
#set($witem = $itemdoc.getWiki()+":"+$itemdoc.getFullName())
#set($obj=$userdoc.getObject("XWiki.WatchListClass"))
#set($wdocs=$obj.getProperty('documents').getValue())
#if($wdocs.indexOf($witem)==-1)
#set($wdocs=$wdocs+","+$witem)
$obj.set('documents',$wdocs)
$userdoc.save()
#end
#end
{{/velocity}}
#macro(addToAnyUserWatchlist $user $item)
#set($itemdoc=$xwiki.getDocument($item))
#set($userdoc=$xwiki.getDocument($user))
#set($witem = $itemdoc.getWiki()+":"+$itemdoc.getFullName())
#set($obj=$userdoc.getObject("XWiki.WatchListClass"))
#set($wdocs=$obj.getProperty('documents').getValue())
#if($wdocs.indexOf($witem)==-1)
#set($wdocs=$wdocs+","+$witem)
$obj.set('documents',$wdocs)
$userdoc.save()
#end
#end
{{/velocity}}
Example of calling this velocity macro from another page:
{{velocity}}
{{include document="Macro.AddToAnyUserWatchlist"/}}
#addToAnyUserWatchlist("XWiki.TestUser", "Sandbox.TestPage3")
{{/velocity}}
{{include document="Macro.AddToAnyUserWatchlist"/}}
#addToAnyUserWatchlist("XWiki.TestUser", "Sandbox.TestPage3")
{{/velocity}}