From version 10.2
To version < 10.3
edited by Eduard Moraru
on 2015/03/16 12:51
Change comment: Deleted object

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Extension.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.XWikiGuest
1 +xwiki:XWiki.enygma
Tags
... ... @@ -1,0 +1,1 @@
1 +plugin|watchlist
Content
EXOExtensionCode.ExtensionClass[0]
Bundled With
... ... @@ -1,0 +1,1 @@
1 +XWiki Enterprise XWiki Enterprise Manager XWiki Watch
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,0 +1,144 @@
1 +{{warning}}Starting with XWiki 7.0RC1, this plugin is deprecated and was moved to legacy. Please use the new [[Extension.Watchlist API]] component-based implementation instead.{{/warning}}
2 +
3 +{{info}}
4 +This plugin uses the [[Mail Sender Plugin>>Extension.Mail Sender Plugin]].
5 +{{/info}}
6 +
7 +== Installation ==
8 +
9 +To use, add the ##com.xpn.xwiki.plugin.watchlist.WatchListPlugin## plugin definition to the ##xwiki.plugins## property in your ##xwiki.cfg## file (this definition is already there if you use XWiki Enterprise 1.2 Milestone 2 or above).
10 +
11 +The API is the following:
12 +
13 +{{code language="none"}}
14 +public boolean isDocInWatchedSpaces() throws XWikiException;
15 +
16 + /**
17 + * Is current document watched by the current user
18 + *
19 + * @return True if the document is in the current user's WatchList
20 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
21 + */
22 + public boolean isWatchedDocument() throws XWikiException;
23 +
24 + /**
25 + * Add the specified document to the current user's WatchList
26 + *
27 + * @param wDoc Document to add
28 + * @return True if the document wasn't already in the WatchList
29 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
30 + */
31 + public boolean addDocument(String wDoc) throws XWikiException;
32 +
33 + /**
34 + * Allows Adminstrators to add the specified document in the specified user's WatchList
35 + *
36 + * @param localUser XWiki User
37 + * @param wDoc Document to add
38 + * @return True if the document wasn't already in the WatchList
39 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
40 + */
41 + public boolean addDocumentForUser(String localUser, String wDoc) throws XWikiException;
42 +
43 + /**
44 + * Removed the specified document from the current user's WatchList
45 + *
46 + * @param wDoc Document to remove
47 + * @return True if the document was in the WatchList and has been removed
48 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
49 + */
50 + public boolean removeDocument(String wDoc) throws XWikiException;
51 +
52 + /**
53 + * Allows Adminstrators to remove the specified document from the specified user's WatchList
54 + *
55 + * @param localUser XWiki User
56 + * @param wDoc Document to remove
57 + * @return True if the document was in the WatchList and has been removed
58 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
59 + */
60 + public boolean removeDocumentForUser(String localUser, String wDoc) throws XWikiException;
61 +
62 + /**
63 + * Is the current space watched by the current user
64 + *
65 + * @return True if the document is in the current user's watchlist
66 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
67 + */
68 + public boolean isWatchedSpace() throws XWikiException;
69 +
70 + /**
71 + * Add the current space to the current user's WatchList
72 + *
73 + * @param wSpace Space to add
74 + * @return True if the space wasn't already in the user's WatchList and has been added
75 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
76 + */
77 + public boolean addSpace(String wSpace) throws XWikiException;
78 +
79 + /**
80 + * Allows Administrators to add the specified space to the specified user's WatchList
81 + *
82 + * @param localUser XWiki User
83 + * @param wSpace Space to add
84 + * @return True if the space wasn't already in the user's WatchList and has been added
85 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
86 + */
87 + public boolean addSpaceForUser(String localUser, String wSpace) throws XWikiException;
88 +
89 + /**
90 + * Remove the specified space from the current user's WatchList
91 + *
92 + * @param wSpace Space to remove
93 + * @return True if the space was in the user's WatchList and has been removed
94 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
95 + */
96 + public boolean removeSpace(String wSpace) throws XWikiException;
97 +
98 + /**
99 + * Allows Administrators to remove the specified space from the specified user's WatchList
100 + *
101 + * @param localUser XWiki User
102 + * @param wSpace Space to remove
103 + * @return True if the space was in the user's WatchList and has been removed
104 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
105 + */
106 + public boolean removeSpaceForUser(String localUser, String wSpace) throws XWikiException;
107 +
108 + /**
109 + * Get the documents watched by the current user
110 + *
111 + * @return The list of the documents in the user's WatchList
112 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
113 + */
114 + public List getWatchedDocuments() throws XWikiException;
115 +
116 + /**
117 + * Get the spaces watched by the current user
118 + *
119 + * @return The list of the spaces in the user's WatchList
120 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
121 + */
122 + public List getWatchedSpaces() throws XWikiException;
123 +
124 + /**
125 + * Get the elements (documents + spaces) watched by the current user
126 + *
127 + * @return The list of the elements in the user's WatchList
128 + * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
129 + */
130 + public List getWatchedElements() throws XWikiException;
131 +
132 + /**
133 + * Get the list of the elements watched by localUser ordered by last modification date, descending
134 + *
135 + * @param localUser XWiki User
136 + * @return the list of the elements watched by localUser ordered by last modification date, descending
137 + * @throws XWikiException If the search request fails
138 + */
139 + public List getWatchListWhatsNew(String localUser) throws XWikiException;
140 +{{/code}}
141 +
142 +== Example ==
143 +
144 +A new "Watch" menu has been added to the top level menu of XWiki Enterprise in versions 1.2 milestone and above.
Source
... ... @@ -1,0 +1,1 @@
1 +https://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-legacy/xwiki-platform-legacy-watchlist-api
Type
... ... @@ -1,0 +1,1 @@
1 +plugin
Only Custom Installation instructions
... ... @@ -1,0 +1,1 @@
1 +No
bundledWith
... ... @@ -1,0 +1,1 @@
1 +XWiki Enterprise|XWiki Enterprise Manager|XWiki Watch
Summary
... ... @@ -1,0 +1,1 @@
1 +Lets the user add pages or spaces that he/she wants to monitor and for which he/she wants to receive email notifications
License Name
... ... @@ -1,0 +1,1 @@
1 +GNU Lesser General Public License 2.1
Name
... ... @@ -1,0 +1,1 @@
1 +Watchlist Plugin
Authors
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.XWikiTeam
supported
... ... @@ -1,0 +1,1 @@
1 +1
ExtensionCode.ExtensionVersionClass[0]
Download URL
... ... @@ -1,0 +1,1 @@
1 +url:http://maven.xwiki.org/releases/com/xpn/xwiki/platform/plugins/xwiki-plugin-watchlist/

null

cogLets the user add pages or spaces that he/she wants to monitor and for which he/she wants to receive email notifications
TypePlugin
Developed by

XWiki Development Team

Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise, XWiki Enterprise Manager, XWiki Watch

Description

Starting with XWiki 7.0RC1, this plugin is deprecated and was moved to legacy. Please use the new Watchlist API component-based implementation instead.

This plugin uses the Mail Sender Plugin.

Installation

To use, add the com.xpn.xwiki.plugin.watchlist.WatchListPlugin plugin definition to the xwiki.plugins property in your xwiki.cfg file (this definition is already there if you use XWiki Enterprise 1.2 Milestone 2 or above).

The API is the following:

public boolean isDocInWatchedSpaces() throws XWikiException;

    /**
     * Is current document watched by the current user
     *
     * @return True if the document is in the current user's WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean isWatchedDocument() throws XWikiException;

    /**
     * Add the specified document to the current user's WatchList
     *
     * @param wDoc Document to add
     * @return True if the document wasn't already in the WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean addDocument(String wDoc) throws XWikiException;

    /**
     * Allows Adminstrators to add the specified document in the specified user's WatchList
     *
     * @param localUser XWiki User
     * @param wDoc Document to add
     * @return True if the document wasn't already in the WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean addDocumentForUser(String localUser, String wDoc) throws XWikiException;

    /**
     * Removed the specified document from the current user's WatchList
     *
     * @param wDoc Document to remove
     * @return True if the document was in the WatchList and has been removed
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean removeDocument(String wDoc) throws XWikiException;

    /**
     * Allows Adminstrators to remove the specified document from the specified user's WatchList
     *
     * @param localUser XWiki User
     * @param wDoc Document to remove
     * @return True if the document was in the WatchList and has been removed
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean removeDocumentForUser(String localUser, String wDoc) throws XWikiException;

    /**
     * Is the current space watched by the current user
     *
     * @return True if the document is in the current user's watchlist
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean isWatchedSpace() throws XWikiException;

    /**
     * Add the current space to the current user's WatchList
     *
     * @param wSpace Space to add
     * @return True if the space wasn't already in the user's WatchList and has been added
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean addSpace(String wSpace) throws XWikiException;

    /**
     * Allows Administrators to add the specified space to the specified user's WatchList
     *
     * @param localUser XWiki User
     * @param wSpace Space to add
     * @return True if the space wasn't already in the user's WatchList and has been added
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean addSpaceForUser(String localUser, String wSpace) throws XWikiException;

    /**
     * Remove the specified space from the current user's WatchList
     *
     * @param wSpace Space to remove
     * @return True if the space was in the user's WatchList and has been removed
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean removeSpace(String wSpace) throws XWikiException;

    /**
     * Allows Administrators to remove the specified space from the specified user's WatchList
     *
     * @param localUser XWiki User
     * @param wSpace Space to remove
     * @return True if the space was in the user's WatchList and has been removed
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public boolean removeSpaceForUser(String localUser, String wSpace) throws XWikiException;

    /**
     * Get the documents watched by the current user
     *
     * @return The list of the documents in the user's WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public List getWatchedDocuments() throws XWikiException;

    /**
     * Get the spaces watched by the current user
     *
     * @return The list of the spaces in the user's WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public List getWatchedSpaces() throws XWikiException;

    /**
     * Get the elements (documents + spaces) watched by the current user
     *
     * @return The list of the elements in the user's WatchList
     * @throws XWikiException If the user's WatchList Object cannot be retreived nor created
     */
    public List getWatchedElements() throws XWikiException;

    /**
     * Get the list of the elements watched by localUser ordered by last modification date, descending
     *
     * @param localUser XWiki User
     * @return the list of the elements watched by localUser ordered by last modification date, descending
     * @throws XWikiException If the search request fails
     */
    public List getWatchListWhatsNew(String localUser) throws XWikiException;

Example

A new "Watch" menu has been added to the top level menu of XWiki Enterprise in versions 1.2 milestone and above.

Get Connected