class MediaWiktory::Wikipedia::Actions::Paraminfo

Obtain information about API modules.

Usage:

“`ruby api.paraminfo.modules(value).perform # returns string with raw output # or api.paraminfo.modules(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

_formatmodules(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 86
def _formatmodules(value)
  defined?(super) && super || ["json", "jsonfm", "none", "php", "phpfm", "rawfm", "xml", "xmlfm"].include?(value.to_s) && merge(formatmodules: value.to_s, replace: false)
end
_helpformat(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 44
def _helpformat(value)
  defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(helpformat: value.to_s)
end
_modules(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 31
def _modules(value)
  merge(modules: value.to_s, replace: false)
end
_querymodules(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 57
def _querymodules(value)
  defined?(super) && super || ["abusefilters", "abuselog", "allcategories", "alldeletedrevisions", "allfileusages", "allimages", "alllinks", "allmessages", "allpages", "allredirects", "allrevisions", "alltransclusions", "allusers", "authmanagerinfo", "babel", "backlinks", "betafeatures", "blocks", "categories", "categoryinfo", "categorymembers", "centralnoticelogs", "checkuser", "checkuserlog", "contenttranslation", "contenttranslationcorpora", "contenttranslationlangtrend", "contenttranslationstats", "contenttranslationsuggestions", "contributors", "coordinates", "cxpublishedtranslations", "cxtranslatorstats", "deletedrevisions", "deletedrevs", "duplicatefiles", "embeddedin", "extlinks", "extracts", "exturlusage", "featureusage", "filearchive", "filerepoinfo", "fileusage", "flagged", "gadgetcategories", "gadgets", "geosearch", "gettingstartedgetpages", "globalallusers", "globalblocks", "globalgroups", "globalusage", "globaluserinfo", "imageinfo", "images", "imageusage", "info", "iwbacklinks", "iwlinks", "langbacklinks", "langlinks", "links", "linkshere", "logevents", "mapdata", "mmsites", "mostviewed", "mystashedfiles", "notifications", "oath", "oldreviewedpages", "ores", "pageassessments", "pageimages", "pagepropnames", "pageprops", "pageswithprop", "pageterms", "pageviews", "prefixsearch", "projectpages", "projects", "protectedtitles", "querypage", "random", "recentchanges", "redirects", "references", "revisions", "search", "siteinfo", "siteviews", "stashimageinfo", "tags", "templates", "tokens", "transcludedin", "transcodestatus", "unreadnotificationpages", "usercontribs", "userinfo", "users", "videoinfo", "watchlist", "watchlistraw", "wbentityusage", "wblistentityusage", "wikibase", "wikisets"].include?(value.to_s) && merge(querymodules: value.to_s, replace: false)
end
formatmodules(*values) click to toggle source

List of format module names (value of format parameter). Use modules instead.

@param values [Array<String>] Allowed values: “json”, “jsonfm”, “none”, “php”, “phpfm”, “rawfm”, “xml”, “xmlfm”. @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 81
def formatmodules(*values)
  values.inject(self) { |res, val| res._formatmodules(val) or fail ArgumentError, "Unknown value for formatmodules: #{val}" }
end
helpformat(value) click to toggle source

Format of help strings.

@param value [String] One of “html”, “wikitext”, “raw”, “none”. @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 39
def helpformat(value)
  _helpformat(value) or fail ArgumentError, "Unknown value for helpformat: #{value}"
end
mainmodule(value) click to toggle source

Get information about the main (top-level) module as well. Use modules=main instead.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 65
def mainmodule(value)
  merge(mainmodule: value.to_s)
end
modules(*values) click to toggle source

List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 26
def modules(*values)
  values.inject(self) { |res, val| res._modules(val) }
end
pagesetmodule(value) click to toggle source

Get information about the pageset module (providing titles= and friends) as well.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 73
def pagesetmodule(value)
  merge(pagesetmodule: value.to_s)
end
querymodules(*values) click to toggle source

List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.

@param values [Array<String>] Allowed values: “abusefilters”, “abuselog”, “allcategories”, “alldeletedrevisions”, “allfileusages”, “allimages”, “alllinks”, “allmessages”, “allpages”, “allredirects”, “allrevisions”, “alltransclusions”, “allusers”, “authmanagerinfo”, “babel”, “backlinks”, “betafeatures”, “blocks”, “categories”, “categoryinfo”, “categorymembers”, “centralnoticelogs”, “checkuser”, “checkuserlog”, “contenttranslation”, “contenttranslationcorpora”, “contenttranslationlangtrend”, “contenttranslationstats”, “contenttranslationsuggestions”, “contributors”, “coordinates”, “cxpublishedtranslations”, “cxtranslatorstats”, “deletedrevisions”, “deletedrevs”, “duplicatefiles”, “embeddedin”, “extlinks”, “extracts”, “exturlusage”, “featureusage”, “filearchive”, “filerepoinfo”, “fileusage”, “flagged”, “gadgetcategories”, “gadgets”, “geosearch”, “gettingstartedgetpages”, “globalallusers”, “globalblocks”, “globalgroups”, “globalusage”, “globaluserinfo”, “imageinfo”, “images”, “imageusage”, “info”, “iwbacklinks”, “iwlinks”, “langbacklinks”, “langlinks”, “links”, “linkshere”, “logevents”, “mapdata”, “mmsites”, “mostviewed”, “mystashedfiles”, “notifications”, “oath”, “oldreviewedpages”, “ores”, “pageassessments”, “pageimages”, “pagepropnames”, “pageprops”, “pageswithprop”, “pageterms”, “pageviews”, “prefixsearch”, “projectpages”, “projects”, “protectedtitles”, “querypage”, “random”, “recentchanges”, “redirects”, “references”, “revisions”, “search”, “siteinfo”, “siteviews”, “stashimageinfo”, “tags”, “templates”, “tokens”, “transcludedin”, “transcodestatus”, “unreadnotificationpages”, “usercontribs”, “userinfo”, “users”, “videoinfo”, “watchlist”, “watchlistraw”, “wbentityusage”, “wblistentityusage”, “wikibase”, “wikisets”. @return [self]

# File lib/mediawiktory/wikipedia/actions/paraminfo.rb, line 52
def querymodules(*values)
  values.inject(self) { |res, val| res._querymodules(val) or fail ArgumentError, "Unknown value for querymodules: #{val}" }
end