API:Watch
| Language: | English • Deutsch • 日本語 • polski |
|---|
 |
This page is part of the MediaWiki action API documentation. |
MediaWiki action API
- Introduction and quick start
- FAQ
- Tutorial
- Formats
- Error reporting
- Restricting usage
- Cross-site requests
- Authentication
- Queries
- Searching (by title, content, coordinates...)
- Parsing wikitext and expanding templates
- Purging pages' caches
- Parameter information
- Changing wiki content
- Create and edit pages
- Move pages
- Merge pages
- Rollback
- Delete pages
- Restore deleted revisions
- (Un)protect pages
- (Un)block users
- (Un)watch pages
- Mark revisions of watched pages as visited
- Send email
- Patrol changes
- Import pages
- Change user group membership
- Upload files
- User options
- Tokens
- Page language
- Watchlist feed
- Wikidata
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
- Asserting
| watch | ||
|---|---|---|
| Add or remove pages from the current user's watchlist. This module cannot be used as a Generator. |
||
| Prefix | ||
| Required rights | ||
| Post only? | Yes | |
| Generated help | Current | |
| Version added |
|
|
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.
Contents
Parameters[edit]
title: Single page to (un)watch. Usetitlesinstead. (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=tokensuselang: Language to show the message in. 1.21+ (removed in 1.25)
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
| Result |
|---|
<?xml version="1.0"?>
<api>
<query>
<pages>
<page pageid="1" ns="0" title="Main Page" touched="2012-02-07T17:27:37Z" lastrevid="2"
counter="21" length="440" starttimestamp="2012-02-09T18:03:17Z"
watchtoken="f2583b3edcdc2142f7256be161764d91+\" />
</pages>
</query>
</api>
|
Examples[edit]
Requests Must be "POST"ed, but for example's sake, "GET"s are used here:
Watching Main Page
| Result |
|---|
<?xml version="1.0" encoding="utf-8"?>
<api>
<watch title="Main Page" watched="" />
</api>
|
Unwatching Dog
| Result |
|---|
<?xml version="1.0" encoding="utf-8"?>
<api>
<watch title="Dog" unwatched="" />
</api>
|
Possible errors[edit]
Only the usual stuff.
|
The following documentation is the output of Special:ApiHelp/watch, generated from watch's source code. |
action=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.
- 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 and zh.
- Type: boolean (details)
- token
-
A "watch" token retrieved from action=query&meta=tokens
- This parameter is required.
- Watch the page Main Page.
- api.php?action=watch&titles=Main_Page&token=123ABC [open in sandbox]
- Unwatch the page Main Page.
- api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC [open in sandbox]
- Watch the first few pages in the main namespace.
- api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC [open in sandbox]
