Class: MediaWiktory::Wikipedia::Actions::Setnotificationtimestamp

Inherits:

Post

• Object
• Base
• Post
• MediaWiktory::Wikipedia::Actions::Setnotificationtimestamp

Defined in:

lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb

Overview

Update the notification timestamp for watched pages.

Usage:

api.setnotificationtimestamp.entirewatchlist(value).perform # returns string with raw output
# or
api.setnotificationtimestamp.entirewatchlist(value).response # returns output parsed and wrapped into Response object

See Base for generic explanation of working with MediaWiki actions and Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary

• #continue(value) ⇒ self

  When more results are available, use this to continue.

• #converttitles ⇒ self

  Convert titles to other variants if necessary.

• #entirewatchlist ⇒ self

  Work on all watched pages.

• #generator(value) ⇒ self

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

• #newerthanrevid(value) ⇒ self

  Revision to set the notification timestamp newer than (one page only).

• #pageids(*values) ⇒ self

  A list of page IDs to work on.

• #redirects ⇒ self

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

• #revids(*values) ⇒ self

  A list of revision IDs to work on.

• #timestamp(value) ⇒ self

  Timestamp to which to set the notification timestamp.

• #titles(*values) ⇒ self

  A list of titles to work on.

• #token(value) ⇒ self

  A "csrf" token retrieved from action=query&meta=tokens.

• #torevid(value) ⇒ self

  Revision to set the notification timestamp to (one page only).

Methods inherited from Post

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 57

def continue(value)
  merge(continue: value.to_s)
end

#converttitles ⇒ self

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.

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 167

def converttitles()
  merge(converttitles: 'true')
end

#entirewatchlist ⇒ self

Work on all watched pages.

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 25

def entirewatchlist()
  merge(entirewatchlist: 'true')
end

#generator(value) ⇒ self

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

Parameters:

• value (Symbol) —

  Selecting an option includes tweaking methods from corresponding module:

  • :allcategories - Modules::Allcategories Enumerate all categories.
  • :alldeletedrevisions - Modules::Alldeletedrevisions List all deleted revisions by a user or in a namespace.
  • :allfileusages - Modules::Allfileusages List all file usages, including non-existing.
  • :allimages - Modules::Allimages Enumerate all images sequentially.
  • :alllinks - Modules::Alllinks Enumerate all links that point to a given namespace.
  • :allpages - Modules::Allpages Enumerate all pages sequentially in a given namespace.
  • :allredirects - Modules::Allredirects List all redirects to a namespace.
  • :allrevisions - Modules::Allrevisions List all revisions.
  • :alltransclusions - Modules::Alltransclusions List all transclusions (pages embedded using {x}), including non-existing.
  • :backlinks - Modules::Backlinks Find all pages that link to the given page.
  • :categories - Modules::Categories List all categories the pages belong to.
  • :categorymembers - Modules::Categorymembers List all pages in a given category.
  • :contenttranslation - Modules::Contenttranslation Query Content Translation database for translations.
  • :contenttranslationsuggestions - Modules::Contenttranslationsuggestions Get suggestion lists for Content Translation.
  • :deletedrevisions - Modules::Deletedrevisions Get deleted revision information.
  • :duplicatefiles - Modules::Duplicatefiles List all files that are duplicates of the given files based on hash values.
  • :embeddedin - Modules::Embeddedin Find all pages that embed (transclude) the given title.
  • :exturlusage - Modules::Exturlusage Enumerate pages that contain a given URL.
  • :fileusage - Modules::Fileusage Find all pages that use the given files.
  • :geosearch - Modules::Geosearch Returns pages having coordinates that are located in a certain area.
  • :gettingstartedgetpages - Modules::Gettingstartedgetpages This API is for getting a list of one or more pages related to a particular GettingStarted task.
  • :images - Modules::Images Returns all files contained on the given pages.
  • :imageusage - Modules::Imageusage Find all pages that use the given image title.
  • :iwbacklinks - Modules::Iwbacklinks Find all pages that link to the given interwiki link.
  • :langbacklinks - Modules::Langbacklinks Find all pages that link to the given language link.
  • :links - Modules::Links Returns all links from the given pages.
  • :linkshere - Modules::Linkshere Find all pages that link to the given pages.
  • :mostviewed - Modules::Mostviewed Lists the most viewed pages (based on last day's pageview count).
  • :oldreviewedpages - Modules::Oldreviewedpages Enumerates pages that have changes pending review.
  • :pageswithprop - Modules::Pageswithprop List all pages using a given page property.
  • :prefixsearch - Modules::Prefixsearch Perform a prefix search for page titles.
  • :projectpages - Modules::Projectpages List all pages associated with one or more projects.
  • :protectedtitles - Modules::Protectedtitles List all titles protected from creation.
  • :querypage - Modules::Querypage Get a list provided by a QueryPage-based special page.
  • :random - Modules::Random Get a set of random pages.
  • :recentchanges - Modules::Recentchanges Enumerate recent changes.
  • :redirects - Modules::Redirects Returns all redirects to the given pages.
  • :revisions - Modules::Revisions Get revision information.
  • :search - Modules::Search Perform a full text search.
  • :templates - Modules::Templates Returns all pages transcluded on the given pages.
  • :transcludedin - Modules::Transcludedin Find all pages that transclude the given pages.
  • :watchlist - Modules::Watchlist Get recent changes to pages in the current user's watchlist.
  • :watchlistraw - Modules::Watchlistraw Get all pages on the current user's watchlist.
  • :wblistentityusage - Modules::Wblistentityusage Returns all pages that use the given entity IDs.

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 148

def generator(value)
  _generator(value) or fail ArgumentError, "Unknown value for generator: #{value}"
end

#newerthanrevid(value) ⇒ self

Revision to set the notification timestamp newer than (one page only).

Parameters:

• value (Integer)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 49

def newerthanrevid(value)
  merge(newerthanrevid: value.to_s)
end

#pageids(*values) ⇒ self

A list of page IDs to work on.

Parameters:

• values (Array<Integer>)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 78

def pageids(*values)
  values.inject(self) { |res, val| res._pageids(val) }
end

#redirects ⇒ self

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

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 160

def redirects()
  merge(redirects: 'true')
end

#revids(*values) ⇒ self

A list of revision IDs to work on.

Parameters:

• values (Array<Integer>)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 91

def revids(*values)
  values.inject(self) { |res, val| res._revids(val) }
end

#timestamp(value) ⇒ self

Timestamp to which to set the notification timestamp.

Parameters:

• value (Time)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 33

def timestamp(value)
  merge(timestamp: value.iso8601)
end

#titles(*values) ⇒ self

A list of titles to work on.

Parameters:

• values (Array<String>)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 65

def titles(*values)
  values.inject(self) { |res, val| res._titles(val) }
end

#token(value) ⇒ self

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

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 175

def token(value)
  merge(token: value.to_s)
end

#torevid(value) ⇒ self

Revision to set the notification timestamp to (one page only).

Parameters:

• value (Integer)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/actions/setnotificationtimestamp.rb', line 41

def torevid(value)
  merge(torevid: value.to_s)
end