class MediaWiktory::Wikipedia::Actions::Query
Fetch data from and about MediaWiki.
Usage:
“`ruby api.query.prop(value).perform # returns string with raw output # or api.query.prop(value).response # returns output parsed and wrapped into Response
object “`
See {Base} for generic explanation of working with MediaWiki actions and {MediaWiktory::Wikipedia::Response} for working with action responses.
All action's parameters are documented as its public methods, see below.
Public Instance Methods
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 306 def _generator(value) defined?(super) && super || [: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, :mostviewed, :oldreviewedpages, :pageswithprop, :prefixsearch, :projectpages, :protectedtitles, :querypage, :random, :recentchanges, :redirects, :revisions, :search, :templates, :transcludedin, :watchlist, :watchlistraw, :wblistentityusage].include?(value.to_sym) && merge(generator: value.to_s).submodule({allcategories: Modules::GAllcategories, alldeletedrevisions: Modules::GAlldeletedrevisions, allfileusages: Modules::GAllfileusages, allimages: Modules::GAllimages, alllinks: Modules::GAlllinks, allpages: Modules::GAllpages, allredirects: Modules::GAllredirects, allrevisions: Modules::GAllrevisions, alltransclusions: Modules::GAlltransclusions, backlinks: Modules::GBacklinks, categories: Modules::GCategories, categorymembers: Modules::GCategorymembers, contenttranslation: Modules::GContenttranslation, contenttranslationsuggestions: Modules::GContenttranslationsuggestions, deletedrevisions: Modules::GDeletedrevisions, duplicatefiles: Modules::GDuplicatefiles, embeddedin: Modules::GEmbeddedin, exturlusage: Modules::GExturlusage, fileusage: Modules::GFileusage, geosearch: Modules::GGeosearch, gettingstartedgetpages: Modules::GGettingstartedgetpages, images: Modules::GImages, imageusage: Modules::GImageusage, iwbacklinks: Modules::GIwbacklinks, langbacklinks: Modules::GLangbacklinks, links: Modules::GLinks, linkshere: Modules::GLinkshere, mostviewed: Modules::GMostviewed, oldreviewedpages: Modules::GOldreviewedpages, pageswithprop: Modules::GPageswithprop, prefixsearch: Modules::GPrefixsearch, projectpages: Modules::GProjectpages, protectedtitles: Modules::GProtectedtitles, querypage: Modules::GQuerypage, random: Modules::GRandom, recentchanges: Modules::GRecentchanges, redirects: Modules::GRedirects, revisions: Modules::GRevisions, search: Modules::GSearch, templates: Modules::GTemplates, transcludedin: Modules::GTranscludedin, watchlist: Modules::GWatchlist, watchlistraw: Modules::GWatchlistraw, wblistentityusage: Modules::GWblistentityusage}[value.to_sym]) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 139 def _list(value) defined?(super) && super || [:abusefilters, :abuselog, :allcategories, :alldeletedrevisions, :allfileusages, :allimages, :alllinks, :allpages, :allredirects, :allrevisions, :alltransclusions, :allusers, :backlinks, :betafeatures, :blocks, :categorymembers, :centralnoticelogs, :checkuser, :checkuserlog, :contenttranslation, :contenttranslationcorpora, :contenttranslationlangtrend, :contenttranslationstats, :contenttranslationsuggestions, :cxpublishedtranslations, :cxtranslatorstats, :deletedrevs, :embeddedin, :exturlusage, :filearchive, :gadgetcategories, :gadgets, :geosearch, :gettingstartedgetpages, :globalallusers, :globalblocks, :globalgroups, :imageusage, :iwbacklinks, :langbacklinks, :logevents, :mmsites, :mostviewed, :mystashedfiles, :oldreviewedpages, :pagepropnames, :pageswithprop, :prefixsearch, :projectpages, :projects, :protectedtitles, :querypage, :random, :recentchanges, :search, :tags, :usercontribs, :users, :watchlist, :watchlistraw, :wblistentityusage, :wikisets].include?(value.to_sym) && merge(list: value.to_s, replace: false).submodule({abusefilters: Modules::Abusefilters, abuselog: Modules::Abuselog, allcategories: Modules::Allcategories, alldeletedrevisions: Modules::Alldeletedrevisions, allfileusages: Modules::Allfileusages, allimages: Modules::Allimages, alllinks: Modules::Alllinks, allpages: Modules::Allpages, allredirects: Modules::Allredirects, allrevisions: Modules::Allrevisions, alltransclusions: Modules::Alltransclusions, allusers: Modules::Allusers, backlinks: Modules::Backlinks, betafeatures: Modules::Betafeatures, blocks: Modules::Blocks, categorymembers: Modules::Categorymembers, centralnoticelogs: Modules::Centralnoticelogs, checkuser: Modules::Checkuser, checkuserlog: Modules::Checkuserlog, contenttranslation: Modules::Contenttranslation, contenttranslationcorpora: Modules::Contenttranslationcorpora, contenttranslationlangtrend: Modules::Contenttranslationlangtrend, contenttranslationstats: Modules::Contenttranslationstats, contenttranslationsuggestions: Modules::Contenttranslationsuggestions, cxpublishedtranslations: Modules::Cxpublishedtranslations, cxtranslatorstats: Modules::Cxtranslatorstats, deletedrevs: Modules::Deletedrevs, embeddedin: Modules::Embeddedin, exturlusage: Modules::Exturlusage, filearchive: Modules::Filearchive, gadgetcategories: Modules::Gadgetcategories, gadgets: Modules::Gadgets, geosearch: Modules::Geosearch, gettingstartedgetpages: Modules::Gettingstartedgetpages, globalallusers: Modules::Globalallusers, globalblocks: Modules::Globalblocks, globalgroups: Modules::Globalgroups, imageusage: Modules::Imageusage, iwbacklinks: Modules::Iwbacklinks, langbacklinks: Modules::Langbacklinks, logevents: Modules::Logevents, mmsites: Modules::Mmsites, mostviewed: Modules::Mostviewed, mystashedfiles: Modules::Mystashedfiles, oldreviewedpages: Modules::Oldreviewedpages, pagepropnames: Modules::Pagepropnames, pageswithprop: Modules::Pageswithprop, prefixsearch: Modules::Prefixsearch, projectpages: Modules::Projectpages, projects: Modules::Projects, protectedtitles: Modules::Protectedtitles, querypage: Modules::Querypage, random: Modules::Random, recentchanges: Modules::Recentchanges, search: Modules::Search, tags: Modules::Tags, usercontribs: Modules::Usercontribs, users: Modules::Users, watchlist: Modules::Watchlist, watchlistraw: Modules::Watchlistraw, wblistentityusage: Modules::Wblistentityusage, wikisets: Modules::Wikisets}[value.to_sym]) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 167 def _meta(value) defined?(super) && super || [:allmessages, :authmanagerinfo, :babel, :featureusage, :filerepoinfo, :globaluserinfo, :notifications, :oath, :ores, :siteinfo, :siteviews, :tokens, :unreadnotificationpages, :userinfo, :wikibase].include?(value.to_sym) && merge(meta: value.to_s, replace: false).submodule({allmessages: Modules::Allmessages, authmanagerinfo: Modules::Authmanagerinfo, babel: Modules::Babel, featureusage: Modules::Featureusage, filerepoinfo: Modules::Filerepoinfo, globaluserinfo: Modules::Globaluserinfo, notifications: Modules::Notifications, oath: Modules::Oath, ores: Modules::Ores, siteinfo: Modules::Siteinfo, siteviews: Modules::Siteviews, tokens: Modules::Tokens, unreadnotificationpages: Modules::Unreadnotificationpages, userinfo: Modules::Userinfo, wikibase: Modules::Wikibase}[value.to_sym]) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 236 def _pageids(value) merge(pageids: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 64 def _prop(value) defined?(super) && super || [:categories, :categoryinfo, :contributors, :coordinates, :deletedrevisions, :duplicatefiles, :extlinks, :extracts, :fileusage, :flagged, :globalusage, :imageinfo, :images, :info, :iwlinks, :langlinks, :links, :linkshere, :mapdata, :pageassessments, :pageimages, :pageprops, :pageterms, :pageviews, :redirects, :references, :revisions, :stashimageinfo, :templates, :transcludedin, :transcodestatus, :videoinfo, :wbentityusage].include?(value.to_sym) && merge(prop: value.to_s, replace: false).submodule({categories: Modules::Categories, categoryinfo: Modules::Categoryinfo, contributors: Modules::Contributors, coordinates: Modules::Coordinates, deletedrevisions: Modules::Deletedrevisions, duplicatefiles: Modules::Duplicatefiles, extlinks: Modules::Extlinks, extracts: Modules::Extracts, fileusage: Modules::Fileusage, flagged: Modules::Flagged, globalusage: Modules::Globalusage, imageinfo: Modules::Imageinfo, images: Modules::Images, info: Modules::Info, iwlinks: Modules::Iwlinks, langlinks: Modules::Langlinks, links: Modules::Links, linkshere: Modules::Linkshere, mapdata: Modules::Mapdata, pageassessments: Modules::Pageassessments, pageimages: Modules::Pageimages, pageprops: Modules::Pageprops, pageterms: Modules::Pageterms, pageviews: Modules::Pageviews, redirects: Modules::Redirects, references: Modules::References, revisions: Modules::Revisions, stashimageinfo: Modules::Stashimageinfo, templates: Modules::Templates, transcludedin: Modules::Transcludedin, transcodestatus: Modules::Transcodestatus, videoinfo: Modules::Videoinfo, wbentityusage: Modules::Wbentityusage}[value.to_sym]) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 249 def _revids(value) merge(revids: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/actions/query.rb, line 223 def _titles(value) merge(titles: value.to_s, replace: false) end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 203 def continue(value) merge(continue: value.to_s) end
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.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 320 def converttitles() merge(converttitles: 'true') end
Export the current revisions of all given or generated pages.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 181 def export() merge(export: 'true') end
Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 188 def exportnowrap() merge(exportnowrap: 'true') end
Get
the list of pages to work on by executing the specified query module.
@param value [Symbol] Selecting an option includes tweaking methods from corresponding module:
* `:allcategories` - {MediaWiktory::Wikipedia::Modules::GAllcategories} Enumerate all categories. _Generator module: for fetching pages corresponding to request._ * `:alldeletedrevisions` - {MediaWiktory::Wikipedia::Modules::GAlldeletedrevisions} List all deleted revisions by a user or in a namespace. _Generator module: for fetching pages corresponding to request._ * `:allfileusages` - {MediaWiktory::Wikipedia::Modules::GAllfileusages} List all file usages, including non-existing. _Generator module: for fetching pages corresponding to request._ * `:allimages` - {MediaWiktory::Wikipedia::Modules::GAllimages} Enumerate all images sequentially. _Generator module: for fetching pages corresponding to request._ * `:alllinks` - {MediaWiktory::Wikipedia::Modules::GAlllinks} Enumerate all links that point to a given namespace. _Generator module: for fetching pages corresponding to request._ * `:allpages` - {MediaWiktory::Wikipedia::Modules::GAllpages} Enumerate all pages sequentially in a given namespace. _Generator module: for fetching pages corresponding to request._ * `:allredirects` - {MediaWiktory::Wikipedia::Modules::GAllredirects} List all redirects to a namespace. _Generator module: for fetching pages corresponding to request._ * `:allrevisions` - {MediaWiktory::Wikipedia::Modules::GAllrevisions} List all revisions. _Generator module: for fetching pages corresponding to request._ * `:alltransclusions` - {MediaWiktory::Wikipedia::Modules::GAlltransclusions} List all transclusions (pages embedded using {{x}}), including non-existing. _Generator module: for fetching pages corresponding to request._ * `:backlinks` - {MediaWiktory::Wikipedia::Modules::GBacklinks} Find all pages that link to the given page. _Generator module: for fetching pages corresponding to request._ * `:categories` - {MediaWiktory::Wikipedia::Modules::GCategories} List all categories the pages belong to. _Generator module: for fetching pages corresponding to request._ * `:categorymembers` - {MediaWiktory::Wikipedia::Modules::GCategorymembers} List all pages in a given category. _Generator module: for fetching pages corresponding to request._ * `:contenttranslation` - {MediaWiktory::Wikipedia::Modules::GContenttranslation} Query Content Translation database for translations. _Generator module: for fetching pages corresponding to request._ * `:contenttranslationsuggestions` - {MediaWiktory::Wikipedia::Modules::GContenttranslationsuggestions} Get suggestion lists for Content Translation. _Generator module: for fetching pages corresponding to request._ * `:deletedrevisions` - {MediaWiktory::Wikipedia::Modules::GDeletedrevisions} Get deleted revision information. _Generator module: for fetching pages corresponding to request._ * `:duplicatefiles` - {MediaWiktory::Wikipedia::Modules::GDuplicatefiles} List all files that are duplicates of the given files based on hash values. _Generator module: for fetching pages corresponding to request._ * `:embeddedin` - {MediaWiktory::Wikipedia::Modules::GEmbeddedin} Find all pages that embed (transclude) the given title. _Generator module: for fetching pages corresponding to request._ * `:exturlusage` - {MediaWiktory::Wikipedia::Modules::GExturlusage} Enumerate pages that contain a given URL. _Generator module: for fetching pages corresponding to request._ * `:fileusage` - {MediaWiktory::Wikipedia::Modules::GFileusage} Find all pages that use the given files. _Generator module: for fetching pages corresponding to request._ * `:geosearch` - {MediaWiktory::Wikipedia::Modules::GGeosearch} Returns pages having coordinates that are located in a certain area. _Generator module: for fetching pages corresponding to request._ * `:gettingstartedgetpages` - {MediaWiktory::Wikipedia::Modules::GGettingstartedgetpages} This API is for getting a list of one or more pages related to a particular GettingStarted task. _Generator module: for fetching pages corresponding to request._ * `:images` - {MediaWiktory::Wikipedia::Modules::GImages} Returns all files contained on the given pages. _Generator module: for fetching pages corresponding to request._ * `:imageusage` - {MediaWiktory::Wikipedia::Modules::GImageusage} Find all pages that use the given image title. _Generator module: for fetching pages corresponding to request._ * `:iwbacklinks` - {MediaWiktory::Wikipedia::Modules::GIwbacklinks} Find all pages that link to the given interwiki link. _Generator module: for fetching pages corresponding to request._ * `:langbacklinks` - {MediaWiktory::Wikipedia::Modules::GLangbacklinks} Find all pages that link to the given language link. _Generator module: for fetching pages corresponding to request._ * `:links` - {MediaWiktory::Wikipedia::Modules::GLinks} Returns all links from the given pages. _Generator module: for fetching pages corresponding to request._ * `:linkshere` - {MediaWiktory::Wikipedia::Modules::GLinkshere} Find all pages that link to the given pages. _Generator module: for fetching pages corresponding to request._ * `:mostviewed` - {MediaWiktory::Wikipedia::Modules::GMostviewed} Lists the most viewed pages (based on last day's pageview count). _Generator module: for fetching pages corresponding to request._ * `:oldreviewedpages` - {MediaWiktory::Wikipedia::Modules::GOldreviewedpages} Enumerates pages that have changes pending review. _Generator module: for fetching pages corresponding to request._ * `:pageswithprop` - {MediaWiktory::Wikipedia::Modules::GPageswithprop} List all pages using a given page property. _Generator module: for fetching pages corresponding to request._ * `:prefixsearch` - {MediaWiktory::Wikipedia::Modules::GPrefixsearch} Perform a prefix search for page titles. _Generator module: for fetching pages corresponding to request._ * `:projectpages` - {MediaWiktory::Wikipedia::Modules::GProjectpages} List all pages associated with one or more projects. _Generator module: for fetching pages corresponding to request._ * `:protectedtitles` - {MediaWiktory::Wikipedia::Modules::GProtectedtitles} List all titles protected from creation. _Generator module: for fetching pages corresponding to request._ * `:querypage` - {MediaWiktory::Wikipedia::Modules::GQuerypage} Get a list provided by a QueryPage-based special page. _Generator module: for fetching pages corresponding to request._ * `:random` - {MediaWiktory::Wikipedia::Modules::GRandom} Get a set of random pages. _Generator module: for fetching pages corresponding to request._ * `:recentchanges` - {MediaWiktory::Wikipedia::Modules::GRecentchanges} Enumerate recent changes. _Generator module: for fetching pages corresponding to request._ * `:redirects` - {MediaWiktory::Wikipedia::Modules::GRedirects} Returns all redirects to the given pages. _Generator module: for fetching pages corresponding to request._ * `:revisions` - {MediaWiktory::Wikipedia::Modules::GRevisions} Get revision information. _Generator module: for fetching pages corresponding to request._ * `:search` - {MediaWiktory::Wikipedia::Modules::GSearch} Perform a full text search. _Generator module: for fetching pages corresponding to request._ * `:templates` - {MediaWiktory::Wikipedia::Modules::GTemplates} Returns all pages transcluded on the given pages. _Generator module: for fetching pages corresponding to request._ * `:transcludedin` - {MediaWiktory::Wikipedia::Modules::GTranscludedin} Find all pages that transclude the given pages. _Generator module: for fetching pages corresponding to request._ * `:watchlist` - {MediaWiktory::Wikipedia::Modules::GWatchlist} Get recent changes to pages in the current user's watchlist. _Generator module: for fetching pages corresponding to request._ * `:watchlistraw` - {MediaWiktory::Wikipedia::Modules::GWatchlistraw} Get all pages on the current user's watchlist. _Generator module: for fetching pages corresponding to request._ * `:wblistentityusage` - {MediaWiktory::Wikipedia::Modules::GWblistentityusage} Returns all pages that use the given entity IDs. _Generator module: for fetching pages corresponding to request._
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 301 def generator(value) _generator(value) or fail ArgumentError, "Unknown value for generator: #{value}" end
Include an additional pageids section listing all returned page IDs.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 174 def indexpageids() merge(indexpageids: 'true') end
Whether to get the full URL if the title is an interwiki link.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 195 def iwurl() merge(iwurl: 'true') end
Which lists to get.
@param values [Array<Symbol>] All selected options include tweaking methods from corresponding modules:
* `:abusefilters` - {MediaWiktory::Wikipedia::Modules::Abusefilters} Show details of the abuse filters. * `:abuselog` - {MediaWiktory::Wikipedia::Modules::Abuselog} Show events that were caught by one of the abuse filters. * `:allcategories` - {MediaWiktory::Wikipedia::Modules::Allcategories} Enumerate all categories. * `:alldeletedrevisions` - {MediaWiktory::Wikipedia::Modules::Alldeletedrevisions} List all deleted revisions by a user or in a namespace. * `:allfileusages` - {MediaWiktory::Wikipedia::Modules::Allfileusages} List all file usages, including non-existing. * `:allimages` - {MediaWiktory::Wikipedia::Modules::Allimages} Enumerate all images sequentially. * `:alllinks` - {MediaWiktory::Wikipedia::Modules::Alllinks} Enumerate all links that point to a given namespace. * `:allpages` - {MediaWiktory::Wikipedia::Modules::Allpages} Enumerate all pages sequentially in a given namespace. * `:allredirects` - {MediaWiktory::Wikipedia::Modules::Allredirects} List all redirects to a namespace. * `:allrevisions` - {MediaWiktory::Wikipedia::Modules::Allrevisions} List all revisions. * `:alltransclusions` - {MediaWiktory::Wikipedia::Modules::Alltransclusions} List all transclusions (pages embedded using {{x}}), including non-existing. * `:allusers` - {MediaWiktory::Wikipedia::Modules::Allusers} Enumerate all registered users. * `:backlinks` - {MediaWiktory::Wikipedia::Modules::Backlinks} Find all pages that link to the given page. * `:betafeatures` - {MediaWiktory::Wikipedia::Modules::Betafeatures} List all BetaFeatures * `:blocks` - {MediaWiktory::Wikipedia::Modules::Blocks} List all blocked users and IP addresses. * `:categorymembers` - {MediaWiktory::Wikipedia::Modules::Categorymembers} List all pages in a given category. * `:centralnoticelogs` - {MediaWiktory::Wikipedia::Modules::Centralnoticelogs} Get a log of campaign configuration changes. * `:checkuser` - {MediaWiktory::Wikipedia::Modules::Checkuser} Check which IP addresses are used by a given username or which usernames are used by a given IP address. * `:checkuserlog` - {MediaWiktory::Wikipedia::Modules::Checkuserlog} Get entries from the CheckUser log. * `:contenttranslation` - {MediaWiktory::Wikipedia::Modules::Contenttranslation} Query Content Translation database for translations. * `:contenttranslationcorpora` - {MediaWiktory::Wikipedia::Modules::Contenttranslationcorpora} Get the section-aligned parallel text for a given translation. See also list=cxpublishedtranslations. Dumps are provided in different formats for high volume access. * `:contenttranslationlangtrend` - {MediaWiktory::Wikipedia::Modules::Contenttranslationlangtrend} Query Content Translation database for numbers of translations by period of time. * `:contenttranslationstats` - {MediaWiktory::Wikipedia::Modules::Contenttranslationstats} Get Content Translation statistics. * `:contenttranslationsuggestions` - {MediaWiktory::Wikipedia::Modules::Contenttranslationsuggestions} Get suggestion lists for Content Translation. * `:cxpublishedtranslations` - {MediaWiktory::Wikipedia::Modules::Cxpublishedtranslations} Fetch all published translations information. * `:cxtranslatorstats` - {MediaWiktory::Wikipedia::Modules::Cxtranslatorstats} Fetch the translation statistics for the given user. * `:deletedrevs` - {MediaWiktory::Wikipedia::Modules::Deletedrevs} List deleted revisions. * `:embeddedin` - {MediaWiktory::Wikipedia::Modules::Embeddedin} Find all pages that embed (transclude) the given title. * `:exturlusage` - {MediaWiktory::Wikipedia::Modules::Exturlusage} Enumerate pages that contain a given URL. * `:filearchive` - {MediaWiktory::Wikipedia::Modules::Filearchive} Enumerate all deleted files sequentially. * `:gadgetcategories` - {MediaWiktory::Wikipedia::Modules::Gadgetcategories} Returns a list of gadget categories. * `:gadgets` - {MediaWiktory::Wikipedia::Modules::Gadgets} Returns a list of gadgets used on this wiki. * `:geosearch` - {MediaWiktory::Wikipedia::Modules::Geosearch} Returns pages having coordinates that are located in a certain area. * `:gettingstartedgetpages` - {MediaWiktory::Wikipedia::Modules::Gettingstartedgetpages} This API is for getting a list of one or more pages related to a particular GettingStarted task. * `:globalallusers` - {MediaWiktory::Wikipedia::Modules::Globalallusers} Enumerate all global users. * `:globalblocks` - {MediaWiktory::Wikipedia::Modules::Globalblocks} List all globally blocked IP addresses. * `:globalgroups` - {MediaWiktory::Wikipedia::Modules::Globalgroups} Enumerate all global groups. * `:imageusage` - {MediaWiktory::Wikipedia::Modules::Imageusage} Find all pages that use the given image title. * `:iwbacklinks` - {MediaWiktory::Wikipedia::Modules::Iwbacklinks} Find all pages that link to the given interwiki link. * `:langbacklinks` - {MediaWiktory::Wikipedia::Modules::Langbacklinks} Find all pages that link to the given language link. * `:logevents` - {MediaWiktory::Wikipedia::Modules::Logevents} Get events from logs. * `:mmsites` - {MediaWiktory::Wikipedia::Modules::Mmsites} Serve autocomplete requests for the site field in MassMessage. * `:mostviewed` - {MediaWiktory::Wikipedia::Modules::Mostviewed} Lists the most viewed pages (based on last day's pageview count). * `:mystashedfiles` - {MediaWiktory::Wikipedia::Modules::Mystashedfiles} Get a list of files in the current user's upload stash. * `:oldreviewedpages` - {MediaWiktory::Wikipedia::Modules::Oldreviewedpages} Enumerates pages that have changes pending review. * `:pagepropnames` - {MediaWiktory::Wikipedia::Modules::Pagepropnames} List all page property names in use on the wiki. * `:pageswithprop` - {MediaWiktory::Wikipedia::Modules::Pageswithprop} List all pages using a given page property. * `:prefixsearch` - {MediaWiktory::Wikipedia::Modules::Prefixsearch} Perform a prefix search for page titles. * `:projectpages` - {MediaWiktory::Wikipedia::Modules::Projectpages} List all pages associated with one or more projects. * `:projects` - {MediaWiktory::Wikipedia::Modules::Projects} List all the projects. * `:protectedtitles` - {MediaWiktory::Wikipedia::Modules::Protectedtitles} List all titles protected from creation. * `:querypage` - {MediaWiktory::Wikipedia::Modules::Querypage} Get a list provided by a QueryPage-based special page. * `:random` - {MediaWiktory::Wikipedia::Modules::Random} Get a set of random pages. * `:recentchanges` - {MediaWiktory::Wikipedia::Modules::Recentchanges} Enumerate recent changes. * `:search` - {MediaWiktory::Wikipedia::Modules::Search} Perform a full text search. * `:tags` - {MediaWiktory::Wikipedia::Modules::Tags} List change tags. * `:usercontribs` - {MediaWiktory::Wikipedia::Modules::Usercontribs} Get all edits by a user. * `:users` - {MediaWiktory::Wikipedia::Modules::Users} Get information about a list of users. * `:watchlist` - {MediaWiktory::Wikipedia::Modules::Watchlist} Get recent changes to pages in the current user's watchlist. * `:watchlistraw` - {MediaWiktory::Wikipedia::Modules::Watchlistraw} Get all pages on the current user's watchlist. * `:wblistentityusage` - {MediaWiktory::Wikipedia::Modules::Wblistentityusage} Returns all pages that use the given entity IDs. * `:wikisets` - {MediaWiktory::Wikipedia::Modules::Wikisets} Enumerate all wiki sets.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 134 def list(*values) values.inject(self) { |res, val| res._list(val) or fail ArgumentError, "Unknown value for list: #{val}" } end
Which metadata to get.
@param values [Array<Symbol>] All selected options include tweaking methods from corresponding modules:
* `:allmessages` - {MediaWiktory::Wikipedia::Modules::Allmessages} Return messages from this site. * `:authmanagerinfo` - {MediaWiktory::Wikipedia::Modules::Authmanagerinfo} Retrieve information about the current authentication status. * `:babel` - {MediaWiktory::Wikipedia::Modules::Babel} Get information about what languages the user knows * `:featureusage` - {MediaWiktory::Wikipedia::Modules::Featureusage} Get a summary of logged API feature usages for a user agent. * `:filerepoinfo` - {MediaWiktory::Wikipedia::Modules::Filerepoinfo} Return meta information about image repositories configured on the wiki. * `:globaluserinfo` - {MediaWiktory::Wikipedia::Modules::Globaluserinfo} Show information about a global user. * `:notifications` - {MediaWiktory::Wikipedia::Modules::Notifications} Get notifications waiting for the current user. * `:oath` - {MediaWiktory::Wikipedia::Modules::Oath} Check to see if two-factor authentication (OATH) is enabled for a user. * `:ores` - {MediaWiktory::Wikipedia::Modules::Ores} Return ORES configuration and model data for this wiki. * `:siteinfo` - {MediaWiktory::Wikipedia::Modules::Siteinfo} Return general information about the site. * `:siteviews` - {MediaWiktory::Wikipedia::Modules::Siteviews} Shows sitewide pageview data (daily pageview totals for each of the last pvisdays days). The result format is date (Ymd) => count. * `:tokens` - {MediaWiktory::Wikipedia::Modules::Tokens} Gets tokens for data-modifying actions. * `:unreadnotificationpages` - {MediaWiktory::Wikipedia::Modules::Unreadnotificationpages} Get pages for which there are unread notifications for the current user. * `:userinfo` - {MediaWiktory::Wikipedia::Modules::Userinfo} Get information about the current user. * `:wikibase` - {MediaWiktory::Wikipedia::Modules::Wikibase} Get information about the Wikibase client and the associated Wikibase repository.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 162 def meta(*values) values.inject(self) { |res, val| res._meta(val) or fail ArgumentError, "Unknown value for meta: #{val}" } end
A list of page IDs to work on.
@param values [Array<Integer>] @return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 231 def pageids(*values) values.inject(self) { |res, val| res._pageids(val) } end
Which properties to get for the queried pages.
@param values [Array<Symbol>] All selected options include tweaking methods from corresponding modules:
* `:categories` - {MediaWiktory::Wikipedia::Modules::Categories} List all categories the pages belong to. * `:categoryinfo` - {MediaWiktory::Wikipedia::Modules::Categoryinfo} Returns information about the given categories. * `:contributors` - {MediaWiktory::Wikipedia::Modules::Contributors} Get the list of logged-in contributors and the count of anonymous contributors to a page. * `:coordinates` - {MediaWiktory::Wikipedia::Modules::Coordinates} Returns coordinates of the given pages. * `:deletedrevisions` - {MediaWiktory::Wikipedia::Modules::Deletedrevisions} Get deleted revision information. * `:duplicatefiles` - {MediaWiktory::Wikipedia::Modules::Duplicatefiles} List all files that are duplicates of the given files based on hash values. * `:extlinks` - {MediaWiktory::Wikipedia::Modules::Extlinks} Returns all external URLs (not interwikis) from the given pages. * `:extracts` - {MediaWiktory::Wikipedia::Modules::Extracts} Returns plain-text or limited HTML extracts of the given pages. * `:fileusage` - {MediaWiktory::Wikipedia::Modules::Fileusage} Find all pages that use the given files. * `:flagged` - {MediaWiktory::Wikipedia::Modules::Flagged} Get information about the flagging status of the given pages. * `:globalusage` - {MediaWiktory::Wikipedia::Modules::Globalusage} Returns global image usage for a certain image. * `:imageinfo` - {MediaWiktory::Wikipedia::Modules::Imageinfo} Returns file information and upload history. * `:images` - {MediaWiktory::Wikipedia::Modules::Images} Returns all files contained on the given pages. * `:info` - {MediaWiktory::Wikipedia::Modules::Info} Get basic page information. * `:iwlinks` - {MediaWiktory::Wikipedia::Modules::Iwlinks} Returns all interwiki links from the given pages. * `:langlinks` - {MediaWiktory::Wikipedia::Modules::Langlinks} Returns all interlanguage links from the given pages. * `:links` - {MediaWiktory::Wikipedia::Modules::Links} Returns all links from the given pages. * `:linkshere` - {MediaWiktory::Wikipedia::Modules::Linkshere} Find all pages that link to the given pages. * `:mapdata` - {MediaWiktory::Wikipedia::Modules::Mapdata} Request all map data from the page Metallica * `:pageassessments` - {MediaWiktory::Wikipedia::Modules::Pageassessments} Return associated projects and assessments for the given pages. * `:pageimages` - {MediaWiktory::Wikipedia::Modules::Pageimages} Returns information about images on the page, such as thumbnail and presence of photos. * `:pageprops` - {MediaWiktory::Wikipedia::Modules::Pageprops} Get various page properties defined in the page content. * `:pageterms` - {MediaWiktory::Wikipedia::Modules::Pageterms} Get terms associated with a page via an associated data item. On a wikibase entity page, the entity terms are used directly. Caveat: On a repo wiki, pageterms only works directly on entity pages, not on pages connected to an item. This may change in the future. * `:pageviews` - {MediaWiktory::Wikipedia::Modules::Pageviews} Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days). The result format is page title (with underscores) => date (Ymd) => count. * `:redirects` - {MediaWiktory::Wikipedia::Modules::Redirects} Returns all redirects to the given pages. * `:references` - {MediaWiktory::Wikipedia::Modules::References} Return a data representation of references associated with the given pages. * `:revisions` - {MediaWiktory::Wikipedia::Modules::Revisions} Get revision information. * `:stashimageinfo` - {MediaWiktory::Wikipedia::Modules::Stashimageinfo} Returns file information for stashed files. * `:templates` - {MediaWiktory::Wikipedia::Modules::Templates} Returns all pages transcluded on the given pages. * `:transcludedin` - {MediaWiktory::Wikipedia::Modules::Transcludedin} Find all pages that transclude the given pages. * `:transcodestatus` - {MediaWiktory::Wikipedia::Modules::Transcodestatus} Get transcode status for a given file page. * `:videoinfo` - {MediaWiktory::Wikipedia::Modules::Videoinfo} Extends imageinfo to include video source (derivatives) information * `:wbentityusage` - {MediaWiktory::Wikipedia::Modules::Wbentityusage} Returns all entity IDs used in the given pages.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 59 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
Return raw query-continue data for continuation.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 210 def rawcontinue() merge(rawcontinue: 'true') end
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.
@return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 313 def redirects() merge(redirects: 'true') end
A list of revision IDs to work on.
@param values [Array<Integer>] @return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 244 def revids(*values) values.inject(self) { |res, val| res._revids(val) } end
A list of titles to work on.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/actions/query.rb, line 218 def titles(*values) values.inject(self) { |res, val| res._titles(val) } end