resources/src/mediawiki.api/mediawiki.api.edit.js

   1 /**
   2  * @class mw.Api.plugin.edit
   3  */
   4 ( function ( mw, $ ) {
   5
   6         var msg = 'Use of mediawiki.api callback params is deprecated. Use the Promise instead.';
   7         $.extend( mw.Api.prototype, {
   8
   9                 /**
  10                  * Post to API with edit token. If we have no token, get one and try to post.
  11                  * If we have a cached token try using that, and if it fails, blank out the
  12                  * cached token and start over.
  13                  *
  14                  * @param {Object} params API parameters
  15                  * @param {Function} [ok] Success callback (deprecated)
  16                  * @param {Function} [err] Error callback (deprecated)
  17                  * @return {jQuery.Promise} See #post
  18                  */
  19                 postWithEditToken: function ( params, ok, err ) {
  20                         if ( ok || err ) {
  21                                 mw.track( 'mw.deprecate', 'api.cbParam' );
  22                                 mw.log.warn( msg );
  23                         }
  24                         return this.postWithToken( 'edit', params ).done( ok ).fail( err );
  25                 },
  26
  27                 /**
  28                  * Api helper to grab an edit token.
  29                  *
  30                  * @param {Function} [ok] Success callback (deprecated)
  31                  * @param {Function} [err] Error callback (deprecated)
  32                  * @return {jQuery.Promise}
  33                  * @return {Function} return.done
  34                  * @return {string} return.done.token Received token.
  35                  */
  36                 getEditToken: function ( ok, err ) {
  37                         if ( ok || err ) {
  38                                 mw.track( 'mw.deprecate', 'api.cbParam' );
  39                                 mw.log.warn( msg );
  40                         }
  41                         return this.getToken( 'edit' ).done( ok ).fail( err );
  42                 },
  43
  44                 /**
  45                  * Create a new section of the page.
  46                  * @see #postWithEditToken
  47                  * @param {mw.Title|String} title Target page
  48                  * @param {string} header
  49                  * @param {string} message wikitext message
  50                  * @param {Function} [ok] Success handler (deprecated)
  51                  * @param {Function} [err] Error handler (deprecated)
  52                  * @return {jQuery.Promise}
  53                  */
  54                 newSection: function ( title, header, message, ok, err ) {
  55                         if ( ok || err ) {
  56                                 mw.track( 'mw.deprecate', 'api.cbParam' );
  57                                 mw.log.warn( msg );
  58                         }
  59                         return this.postWithEditToken( {
  60                                 action: 'edit',
  61                                 section: 'new',
  62                                 format: 'json',
  63                                 title: String( title ),
  64                                 summary: header,
  65                                 text: message
  66                         } ).done( ok ).fail( err );
  67                 }
  68         } );
  69
  70         /**
  71          * @class mw.Api
  72          * @mixins mw.Api.plugin.edit
  73          */
  74
  75 }( mediaWiki, jQuery ) );