resources/mediawiki.api/mediawiki.api.watch.js

   1 /**
   2  * @class mw.Api.plugin.watch
   3  * @since 1.19
   4  */
   5 ( function ( mw, $ ) {
   6
   7         /**
   8          * @private
   9          * @context mw.Api
  10          *
  11          * @param {String|mw.Title} page Full page name or instance of mw.Title
  12          * @param {Function} [ok] Success callback (deprecated)
  13          * @param {Function} [err] Error callback (deprecated)
  14          * @return {jQuery.Promise}
  15          * @return {Function} return.done
  16          * @return {Object} return.done.watch
  17          * @return {string} return.done.watch.title Full pagename
  18          * @return {boolean} return.done.watch.watched
  19          * @return {string} return.done.watch.message Parsed HTML of the confirmational interface message
  20          */
  21         function doWatchInternal( page, ok, err, addParams ) {
  22                 var params, d = $.Deferred();
  23                 // Backwards compatibility (< MW 1.20)
  24                 d.done( ok );
  25                 d.fail( err );
  26
  27                 params = {
  28                         action: 'watch',
  29                         title: String( page ),
  30                         token: mw.user.tokens.get( 'watchToken' ),
  31                         uselang: mw.config.get( 'wgUserLanguage' )
  32                 };
  33
  34                 if ( addParams ) {
  35                         $.extend( params, addParams );
  36                 }
  37
  38                 this.post( params )
  39                         .done( function ( data ) {
  40                                 d.resolve( data.watch );
  41                         } )
  42                         .fail( d.reject );
  43
  44                 return d.promise();
  45         }
  46
  47         $.extend( mw.Api.prototype, {
  48                 /**
  49                  * Convenience method for `action=watch`.
  50                  *
  51                  * @inheritdoc #doWatchInternal
  52                  */
  53                 watch: function ( page, ok, err ) {
  54                         return doWatchInternal.call( this, page, ok, err );
  55                 },
  56                 /**
  57                  * Convenience method for `action=watch&unwatch=1`.
  58                  *
  59                  * @inheritdoc #doWatchInternal
  60                  */
  61                 unwatch: function ( page, ok, err ) {
  62                         return doWatchInternal.call( this, page, ok, err, { unwatch: 1 } );
  63                 }
  64
  65         } );
  66
  67         /**
  68          * @class mw.Api
  69          * @mixins mw.Api.plugin.watch
  70          */
  71
  72 }( mediaWiki, jQuery ) );