API:Watch

From MediaWiki.org
Jump to: navigation, search
Language: English  • Deutsch • 日本語 • polski
Tools clipart.png This page is part of the MediaWiki action API documentation.
MediaWiki APIsAPI:Main page

MediaWiki action API

v · d · e
MediaWiki version: 1.14

Pages can be watched (added to your watchlist) and unwatched (removed from your watchlist) with action=watch. Of course, you can only add and remove pages to/from your own watchlist.

Parameters[edit]

  • title: Single page to (un)watch. Use titles instead. (deprecated in 1.23)
  • unwatch: If set, unwatch the page. If not set, watch the page.
  • continue: When more results are available, use this to continue. 1.23+
  • titles: A list of titles to work on. Separate values with |. No more than 50 (500 for bots) allowed. 1.23+
  • pageids: A list of page IDs to work on. Separate values with |. No more than 50 (500 for bots) allowed. Type: list of integers 1.23+
  • revids: A list of revision IDs to work on. Separate values with |. No more than 50 (500 for bots) allowed. Type: list of integers 1.23+
  • generator: Get the list of pages to work on by executing the specified query module. Note: Generator parameter names must be prefixed with a "g". Possible values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, contenttranslation, contenttranslationsuggestions, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, geosearch, gettingstartedgetpages, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, listpages, oldreviewedpages, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw. 1.23+
  • redirects: Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator. 1.23+
  • converttitles: Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh. 1.23+
  • token: A "watch" token retrieved from action=query&meta=tokens

Token[edit]

To (un)watch a page, a token is required. This token is the same for all pages (and is not different for watch vs unwatch), but changes at every login. Watch/unwatch tokens can be obtained via action=tokens with type=watch (MW 1.20+), or by using the following method:

Obtaining a watch token

Examples[edit]

Requests Must be "POST"ed, but for example's sake, "GET"s are used here:

Watching Main Page

Unwatching Dog

Possible errors[edit]

Only the usual stuff.

action=watch

(main | watch)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: MediaWiki
  • License: GPL-2.0+

Add or remove pages from the current user's watchlist.

Parameters:
title
Deprecated.

The page to (un)watch. Use titles instead.

unwatch

If set the page will be unwatched rather than watched.

Type: boolean (details)
continue

When more results are available, use this to continue.

titles

A list of titles to work on.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, messagecollection, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage
redirects

Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh.

Type: boolean (details)
token

A "watch" token retrieved from action=query&meta=tokens

This parameter is required.