summaryrefslogtreecommitdiff
path: root/resources/mediawiki.api/mediawiki.api.watch.js
blob: 3f2525ad30d2feca97e9d355948810fd61ac3f97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/**
 * Additional mw.Api methods to assist with (un)watching wiki pages.
 * @since 1.19
 */
( function( $, mw ) {

	$.extend( mw.Api.prototype, {
		/**
		 * Convinience method for 'action=watch'.
		 *
		 * @param page {String|mw.Title} Full page name or instance of mw.Title
		 * @param success {Function} callback to which the watch object will be passed
		 * watch object contains 'title' (full page name), 'watched' (boolean) and
		 * 'message' (parsed HTML of the 'addedwatchtext' message).
		 * @param err {Function} callback if error (optional)
		 * @return {jqXHR}
		 */
		watch: function( page, success, err ) {
			var params, ok;
			params = {
				action: 'watch',
				title: String( page ),
				token: mw.user.tokens.get( 'watchToken' ),
				uselang: mw.config.get( 'wgUserLanguage' )
			};
			ok = function( data ) {
				success( data.watch );
			};
			return this.post( params, { ok: ok, err: err } );
		},
		/**
		 * Convinience method for 'action=watch&unwatch='.
		 *
		 * @param page {String|mw.Title} Full page name or instance of mw.Title
		 * @param success {Function} callback to which the watch object will be passed
		 * watch object contains 'title' (full page name), 'unwatched' (boolean) and
		 * 'message' (parsed HTML of the 'removedwatchtext' message).
		 * @param err {Function} callback if error (optional)
		 * @return {jqXHR}
		 */
		unwatch: function( page, success, err ) {
			var params, ok;
			params = {
				action: 'watch',
				unwatch: 1,
				title: String( page ),
				token: mw.user.tokens.get( 'watchToken' ),
				uselang: mw.config.get( 'wgUserLanguage' )
			};
			ok = function( data ) {
				success( data.watch );
			};
			return this.post( params, { ok: ok, err: err } );
		}

	} );

} )( jQuery, mediaWiki );