API:SetNotificationTimestamp
| Language: | English • 日本語 |
|---|
 |
This page is part of the MediaWiki action API documentation. |
MediaWiki action API
- Introduction and quick start
- FAQ
- 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
- More...
- Watchlist feed
- Wikidata
- Extensions
- Using the API in MediaWiki and extensions
- Miscellaneous
- Implementation
- Client code
- Asserting
| setnotificationtimestamp | ||
|---|---|---|
This module cannot be used as a Generator. |
||
| Prefix | none | |
| Required rights | none | |
| Post only? | Yes | |
| Generated help | Current | |
| Version added |
|
|
This module is used to mark revisions of watched pages as visited. This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page on my watchlist is changed" preference is enabled.
This module requires POST requests; GET requests will not work.
Token[edit]
Users of this module must be correctly logged in, as a valid edit token is required. For example:
Obtaining an edit token
| Result |
|---|
<?xml version="1.0"?>
<api>
<query>
<tokens csrftoken="1ccc023d58931de3acc6c39c7af2e420+\" />
</query>
</api>
|
Parameters[edit]
entirewatchlist: Work on all watched pages.token: Edit token retrieved in previous steptimestamp: Timestamp to which to set the notification timestamp.torevid: Revision to set the notification timestamp to (one page only).newerthanrevid: Revision to set the notification timestamp newer than (one page only).titles: A list of titles to work on. Standard rules and limits apply. (See API:Query#Specifying pages.)pageids: A list of page IDs to work on. Standard rules and limits apply. 1.20+revids: A list of revision IDs to work on. Standard rules and limits apply.redirects: Automatically resolve redirects.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.generator: Get the list of pages to work on using a generator. (See API:Query#Generators.)
Examples[edit]
Marking entire watchlist as visited
api.php?
| Result |
|---|
<?xml version="1.0"?>
<api>
<setnotificationtimestamp notificationtimestamp="" />
</api>
|
Marking all edits to "Wikipedia talk:Sandbox" since 1 January 2012 as unviewed
api.php?
| Result |
|---|
<?xml version="1.0"?>
<api>
<setnotificationtimestamp>
<page ns="4" title="Wikipedia:Sandbox" notificationtimestamp="2012-01-01T00:00:00Z" />
</setnotificationtimestamp>
</api>
|
 | The following documentation is the output of Special:ApiHelp/setnotificationtimestamp, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org). |
action=setnotificationtimestamp
(main | setnotificationtimestamp)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Update the notification timestamp for watched pages.
This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "Email me when a page or a file on my watchlist is changed" preference is enabled.
Parameters:
- entirewatchlist
Work on all watched pages.
- Type: boolean (details)
- timestamp
Timestamp to which to set the notification timestamp.
- Type: timestamp (allowed formats)
- torevid
Revision to set the notification timestamp to (one page only).
- Type: integer
- newerthanrevid
Revision to set the notification timestamp newer than (one page only).
- Type: integer
- 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.
- allcategories
- Enumerate all categories.
- alldeletedrevisions
- List all deleted revisions by a user or in a namespace.
- allfileusages
- List all file usages, including non-existing.
- allimages
- Enumerate all images sequentially.
- alllinks
- Enumerate all links that point to a given namespace.
- allpages
- Enumerate all pages sequentially in a given namespace.
- allredirects
- List all redirects to a namespace.
- allrevisions
- List all revisions.
- alltransclusions
- List all transclusions (pages embedded using {{x}}), including non-existing.
- backlinks
- Find all pages that link to the given page.
- categories
- List all categories the pages belong to.
- categorymembers
- List all pages in a given category.
- deletedrevisions
- Get deleted revision information.
- duplicatefiles
- List all files that are duplicates of the given files based on hash values.
- embeddedin
- Find all pages that embed (transclude) the given title.
- exturlusage
- Enumerate pages that contain a given URL.
- fileusage
- Find all pages that use the given files.
- images
- Returns all files contained on the given pages.
- imageusage
- Find all pages that use the given image title.
- iwbacklinks
- Find all pages that link to the given interwiki link.
- langbacklinks
- Find all pages that link to the given language link.
- links
- Returns all links from the given pages.
- linkshere
- Find all pages that link to the given pages.
- messagecollection
- Query MessageCollection about translations.
- mostviewed
- Lists the most viewed pages (based on last day's pageview count).
- pageswithprop
- List all pages using a given page property.
- prefixsearch
- Perform a prefix search for page titles.
- protectedtitles
- List all titles protected from creation.
- querypage
- Get a list provided by a QueryPage-based special page.
- random
- Get a set of random pages.
- readinglistentries
- List the pages of a certain list.
- recentchanges
- Enumerate recent changes.
- redirects
- Returns all redirects to the given pages.
- revisions
- Get revision information.
- search
- Perform a full text search.
- templates
- Returns all pages transcluded on the given pages.
- transcludedin
- Find all pages that transclude the given pages.
- watchlist
- Get recent changes to pages in the current user's watchlist.
- watchlistraw
- Get all pages on the current user's watchlist.
- wblistentityusage
- Returns all pages that use the given entity IDs.
- 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, mostviewed, pageswithprop, prefixsearch, protectedtitles, querypage, random, readinglistentries, 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 en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
Examples:
- Reset the notification status for the entire watchlist.
- api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [open in sandbox]
- Reset the notification status for Main page.
- api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [open in sandbox]
- Set the notification timestamp for Main page so all edits since 1 January 2012 are unviewed.
- api.php?action=setnotificationtimestamp&titles=Main_page×tamp=2012-01-01T00:00:00Z&token=123ABC [open in sandbox]
- Reset the notification status for pages in the User namespace.
- api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [open in sandbox]
