.. # define a hard line break for HTML
.. |br| raw:: html
*****************************
MediaWiki API cross reference
*****************************
See the table below for a cross reference between MediaWiki's API and Pywikibot's API.
.. list-table::
:header-rows: 1
:align: left
* - action
- APISite method
- page method
- other module method
* - :api:`block`
- :meth:`blockuser()`
- :meth:`User.block()`
-
* - :api:`clientlogin`
- :meth:`login()`
-
-
* - :api:`compare`
- :meth:`compare()`
-
-
* - :api:`delete`
- :meth:`delete()`
- :meth:`BasePage.delete()`
-
* - :api:`Deletedrevisions`
- :meth:`delete()`
- :meth:`BasePage.delete()`
-
* - :api:`echomarkread`
- :meth:`notifications_mark_read()`
-
- :meth:`echo.Notification.mark_as_read`
* - :api:`edit`
- :meth:`editpage()`
- :meth:`BasePage.save()`
:meth:`BasePage.put()`
:meth:`BasePage.touch()`
:meth:`Page.set_redirect_target()`
:meth:`BasePage.change_category()`
- :meth:`proofreadpage.ProofreadPage.save`
:meth:`proofreadpage.IndexPage.save`
:meth:`bot.BaseBot.userPut`
:meth:`bot.CurrentPageBot.put_current`
:meth:`BaseUnlinkBot.unlink()`
* - :api:`emailuser`
-
- :meth:`User.send_email()`
-
* - :api:`expandtemplates`
- :meth:`expand_text()`
- :meth:`BasePage.expand_text()`
- :meth:`textlib.getCategoryLinks`
* - :api:`flow`
- *deprecated, see below*
-
-
* - :api:`login`
- :meth:`login()`
-
-
* - :api:`logout`
- :meth:`logout()`
-
-
* - :api:`mergehistory`
- :meth:`merge_history()`
- :meth:`BasePage.merge_history()`
-
* - :api:`move`
- :meth:`movepage()`
- :meth:`BasePage.move()`
-
* - :api:`parse`
- :meth:`get_parsed_page()`
- :meth:`BasePage.get_parsed_page()`
-
* - :api:`patrol`
- :meth:`patrol()`
-
-
* - :api:`protect`
- :meth:`protect()`
- :meth:`BasePage.protect()`
-
* - :api:`purge`
- :meth:`purgepages()`
- :meth:`BasePage.purge()`
- :meth:`ProofreadPage.purge()`
* - :api:`query`
- *see separate table (not yet)*
-
-
* - :api:`revisiondelete`
- :meth:`deleterevs()`
-
-
* - :api:`rollback`
- :meth:`rollbackpage()`
-
-
* - :api:`shortenurl`
- :meth:`create_short_link()`
- :meth:`BasePage.create_short_link()`
-
* - :api:`sitematrix`
- :meth:`fromDBName()`
-
-
* - :api:`thank`
- :meth:`thank_revision()`
-
-
* - :api:`unblock`
- :meth:`unblockuser()`
- :meth:`User.unblock()`
-
* - :api:`undelete`
- :meth:`undelete()`
- :meth:`BasePage.undelete()`
-
* - :api:`upload`
- :meth:`upload()`
:meth:`site.Uploader.upload()`
- :meth:`FilePage.upload()`
- :meth:`UploadRobot.upload_file()`
* - :api:`watch`
- :meth:`watch()`
- :meth:`BasePage.watch()`
-
Flow support
============
.. deprecated:: 9.4
will be removed with Pywikibot 12 or earlier (:phab:`T371180`).
.. list-table::
:header-rows: 1
:align: left
* - action
- APISite method
- flow module method
* - :api:`flow`
- :meth:`load_board()` |br|
:meth:`load_topiclist()` |br|
:meth:`load_topic()` |br|
:meth:`load_post_current_revision()` |br|
:meth:`create_new_topic()` |br|
:meth:`reply_to_post()` |br|
:meth:`lock_topic()` |br|
:meth:`moderate_topic()` |br|
:meth:`delete_topic()` |br|
:meth:`hide_topic()` |br|
:meth:`suppress_topic()` |br|
:meth:`restore_topic()` |br|
:meth:`moderate_post()` |br|
:meth:`delete_post()` |br|
:meth:`hide_post()` |br|
:meth:`suppress_post()` |br|
:meth:`restore_post()` |br|
- :meth:`flow.Board.topics` |br|
:meth:`flow.Topic.create_topic` |br|
:meth:`flow.Topic.lock` |br|
:meth:`flow.Topic.unlock` |br|
:meth:`flow.Topic.delete_mod` |br|
:meth:`flow.Topic.hide` |br|
:meth:`flow.Topic.suppress` |br|
:meth:`flow.Topic.restore` |br|
:meth:`flow.Post.reply` |br|
:meth:`flow.Post.delete` |br|
:meth:`flow.Post.hide` |br|
:meth:`flow.Post.suppress` |br|
:meth:`flow.Post.restore` |br|
* - :api:`flowthank`
- :meth:`thank_post()`
- :meth:`flow.Post.thank`